#include <OpenColorTransforms.h>

Inheritance diagram for OCIO_NAMESPACE::GroupTransform:

Public Member Functions
virtual const FormatMetadata &	getFormatMetadata () const noexcept=0

virtual FormatMetadata &	getFormatMetadata () noexcept=0

virtual ConstTransformRcPtr	getTransform (int index) const =0
	Throws if index is not allowed. More...

virtual TransformRcPtr &	getTransform (int index)=0
	Throws if index is not allowed. More...

virtual int	getNumTransforms () const noexcept=0
	Return number of transforms. More...

virtual void	appendTransform (TransformRcPtr transform) noexcept=0
	Adds a transform to the end of the group. More...

virtual void	prependTransform (TransformRcPtr transform) noexcept=0
	Add a transform at the beginning of the group. More...

virtual void	write (const ConstConfigRcPtr &config, const char *formatName, std::ostream &os) const =0
	Write the transforms comprising the group to the stream. More...

	GroupTransform (const GroupTransform &)=delete

GroupTransform &	operator= (const GroupTransform &)=delete

virtual	~GroupTransform ()=default
	Do not use (needed only for pybind11). More...

Public Member Functions inherited from OCIO_NAMESPACE::Transform
virtual TransformRcPtr	createEditableCopy () const =0

virtual TransformDirection	getDirection () const noexcept=0

virtual void	setDirection (TransformDirection dir) noexcept=0
	Note that this only affects the evaluation and not the values stored in the object. More...

virtual TransformType	getTransformType () const noexcept=0

virtual void	validate () const
	Will throw if data is not valid. More...

	Transform (const Transform &)=delete

Transform &	operator= (const Transform &)=delete

virtual	~Transform ()=default
	Do not use (needed only for pybind11). More...

Static Public Member Functions
static GroupTransformRcPtr	Create ()

static int	GetNumWriteFormats () noexcept
	Get the number of writers. More...

static const char *	GetFormatNameByIndex (int index) noexcept
	Get the writer at index, return empty string if an invalid index is specified. More...

static const char *	GetFormatExtensionByIndex (int index) noexcept

Protected Member Functions
	GroupTransform ()=default

Protected Member Functions inherited from OCIO_NAMESPACE::Transform
	Transform ()=default

Detailed Description

Definition at line 1319 of file OpenColorTransforms.h.

Constructor & Destructor Documentation

OCIO_NAMESPACE::GroupTransform::GroupTransform ( const GroupTransform & )

delete

virtual OCIO_NAMESPACE::GroupTransform::~GroupTransform ( )

virtualdefault

Do not use (needed only for pybind11).

OCIO_NAMESPACE::GroupTransform::GroupTransform ( )

protecteddefault

Member Function Documentation

virtual void OCIO_NAMESPACE::GroupTransform::appendTransform ( TransformRcPtr transform )

pure virtualnoexcept

Adds a transform to the end of the group.

static GroupTransformRcPtr OCIO_NAMESPACE::GroupTransform::Create ( )

static

static const char* OCIO_NAMESPACE::GroupTransform::GetFormatExtensionByIndex ( int index )

staticnoexcept

virtual const FormatMetadata& OCIO_NAMESPACE::GroupTransform::getFormatMetadata ( ) const

pure virtualnoexcept

virtual FormatMetadata& OCIO_NAMESPACE::GroupTransform::getFormatMetadata ( )

pure virtualnoexcept

static const char* OCIO_NAMESPACE::GroupTransform::GetFormatNameByIndex ( int index )

staticnoexcept

Get the writer at index, return empty string if an invalid index is specified.

virtual int OCIO_NAMESPACE::GroupTransform::getNumTransforms ( ) const

pure virtualnoexcept

Return number of transforms.

static int OCIO_NAMESPACE::GroupTransform::GetNumWriteFormats ( )

staticnoexcept

Get the number of writers.

virtual ConstTransformRcPtr OCIO_NAMESPACE::GroupTransform::getTransform ( int index ) const

pure virtual

Throws if index is not allowed.

virtual TransformRcPtr& OCIO_NAMESPACE::GroupTransform::getTransform ( int index )

pure virtual

Throws if index is not allowed.

GroupTransform& OCIO_NAMESPACE::GroupTransform::operator= ( const GroupTransform & )

delete

virtual void OCIO_NAMESPACE::GroupTransform::prependTransform ( TransformRcPtr transform )

pure virtualnoexcept

Add a transform at the beginning of the group.

virtual void OCIO_NAMESPACE::GroupTransform::write	(	const ConstConfigRcPtr &	config,
		const char *	formatName,
		std::ostream &	os
	)		const

pure virtual

Write the transforms comprising the group to the stream.

Writing (as opposed to Baking) is a lossless process. An exception is thrown if the processor cannot be losslessly written to the specified file format. Transforms such as FileTransform or ColorSpaceTransform are resolved into write-able simple transforms using the config and context. Supported formats include CTF, CLF, and CDL. All available formats can be listed with the following:

// What are the allowed writing output formats?
std::ostringstream formats;
formats << "Formats to write to: ";
for (int i = 0; i < GroupTransform::GetNumWriteFormats(); ++i)
{
   if (i != 0) formats << ", ";
   formats << GroupTransform::GetFormatNameByIndex(i);
   formats << " (." << GroupTransform::GetFormatExtensionByIndex(i) << ")";
}

The documentation for this class was generated from the following file:

OpenColorIO/OpenColorTransforms.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation