HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
OCIO_NAMESPACE::NamedTransform Class Referenceabstract

NamedTransform. More...

#include <OpenColorIO.h>

Public Member Functions

virtual NamedTransformRcPtr createEditableCopy () const =0
 
virtual const char * getName () const noexcept=0
 
virtual void setName (const char *name) noexcept=0
 
virtual size_t getNumAliases () const noexcept=0
 Aliases can be used instead of the name. They must be unique within the config. More...
 
virtual const char * getAlias (size_t idx) const noexcept=0
 Return empty string if idx is out of range. More...
 
virtual void addAlias (const char *alias) noexcept=0
 
virtual void removeAlias (const char *alias) noexcept=0
 Does nothing if alias is not present. More...
 
virtual void clearAliases () noexcept=0
 
virtual const char * getFamily () const noexcept=0
 
virtual void setFamily (const char *family) noexcept=0
 
virtual const char * getDescription () const noexcept=0
 
virtual void setDescription (const char *description) noexcept=0
 
virtual bool hasCategory (const char *category) const noexcept=0
 
virtual void addCategory (const char *category) noexcept=0
 
virtual void removeCategory (const char *category) noexcept=0
 
virtual int getNumCategories () const noexcept=0
 
virtual const char * getCategory (int index) const noexcept=0
 
virtual void clearCategories () noexcept=0
 
virtual const char * getEncoding () const noexcept=0
 
virtual void setEncoding (const char *encoding) noexcept=0
 
virtual ConstTransformRcPtr getTransform (TransformDirection dir) const =0
 
virtual void setTransform (const ConstTransformRcPtr &transform, TransformDirection dir)=0
 
 NamedTransform (const NamedTransform &)=delete
 
NamedTransformoperator= (const NamedTransform &)=delete
 
virtual ~NamedTransform ()=default
 

Static Public Member Functions

static NamedTransformRcPtr Create ()
 

Protected Member Functions

 NamedTransform ()=default
 

Detailed Description

NamedTransform.

A NamedTransform provides a way for config authors to include a set of color transforms that are independent of the color space being processed. For example a "utility curve" transform where there is no need to convert to or from a reference space.

Definition at line 1893 of file OpenColorIO.h.

Constructor & Destructor Documentation

OCIO_NAMESPACE::NamedTransform::NamedTransform ( const NamedTransform )
delete
virtual OCIO_NAMESPACE::NamedTransform::~NamedTransform ( )
virtualdefault
OCIO_NAMESPACE::NamedTransform::NamedTransform ( )
protecteddefault

Member Function Documentation

virtual void OCIO_NAMESPACE::NamedTransform::addAlias ( const char *  alias)
pure virtualnoexcept

Nothing is done if alias is NULL or empty, if it is already there, or if it is already the named transform name.

virtual void OCIO_NAMESPACE::NamedTransform::addCategory ( const char *  category)
pure virtualnoexcept
virtual void OCIO_NAMESPACE::NamedTransform::clearAliases ( )
pure virtualnoexcept
virtual void OCIO_NAMESPACE::NamedTransform::clearCategories ( )
pure virtualnoexcept
static NamedTransformRcPtr OCIO_NAMESPACE::NamedTransform::Create ( )
static
virtual NamedTransformRcPtr OCIO_NAMESPACE::NamedTransform::createEditableCopy ( ) const
pure virtual
virtual const char* OCIO_NAMESPACE::NamedTransform::getAlias ( size_t  idx) const
pure virtualnoexcept

Return empty string if idx is out of range.

virtual const char* OCIO_NAMESPACE::NamedTransform::getCategory ( int  index) const
pure virtualnoexcept
virtual const char* OCIO_NAMESPACE::NamedTransform::getDescription ( ) const
pure virtualnoexcept
virtual const char* OCIO_NAMESPACE::NamedTransform::getEncoding ( ) const
pure virtualnoexcept

A NamedTransform is not a color space and does not have an encoding in the same sense. However, it may be useful to associate a color space encoding that the transform is intended to be used with, for organizational purposes.

virtual const char* OCIO_NAMESPACE::NamedTransform::getFamily ( ) const
pure virtualnoexcept
virtual const char* OCIO_NAMESPACE::NamedTransform::getName ( ) const
pure virtualnoexcept
virtual size_t OCIO_NAMESPACE::NamedTransform::getNumAliases ( ) const
pure virtualnoexcept

Aliases can be used instead of the name. They must be unique within the config.

virtual int OCIO_NAMESPACE::NamedTransform::getNumCategories ( ) const
pure virtualnoexcept
virtual ConstTransformRcPtr OCIO_NAMESPACE::NamedTransform::getTransform ( TransformDirection  dir) const
pure virtual
virtual bool OCIO_NAMESPACE::NamedTransform::hasCategory ( const char *  category) const
pure virtualnoexcept
NamedTransform& OCIO_NAMESPACE::NamedTransform::operator= ( const NamedTransform )
delete
virtual void OCIO_NAMESPACE::NamedTransform::removeAlias ( const char *  alias)
pure virtualnoexcept

Does nothing if alias is not present.

virtual void OCIO_NAMESPACE::NamedTransform::removeCategory ( const char *  category)
pure virtualnoexcept
virtual void OCIO_NAMESPACE::NamedTransform::setDescription ( const char *  description)
pure virtualnoexcept
virtual void OCIO_NAMESPACE::NamedTransform::setEncoding ( const char *  encoding)
pure virtualnoexcept
virtual void OCIO_NAMESPACE::NamedTransform::setFamily ( const char *  family)
pure virtualnoexcept
virtual void OCIO_NAMESPACE::NamedTransform::setName ( const char *  name)
pure virtualnoexcept
virtual void OCIO_NAMESPACE::NamedTransform::setTransform ( const ConstTransformRcPtr transform,
TransformDirection  dir 
)
pure virtual

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