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

#include <OpenColorTransforms.h>

+ Inheritance diagram for OCIO_NAMESPACE::FileTransform:

Public Member Functions

TransformRcPtr createEditableCopy () const override
 
TransformDirection getDirection () const noexceptoverride
 
void setDirection (TransformDirection dir) noexceptoverride
 Note that this only affects the evaluation and not the values stored in the object. More...
 
TransformType getTransformType () const noexceptoverride
 
void validate () const override
 Will throw if data is not valid. More...
 
const char * getSrc () const
 
void setSrc (const char *src)
 
const char * getCCCId () const
 
void setCCCId (const char *id)
 
CDLStyle getCDLStyle () const
 
void setCDLStyle (CDLStyle)
 
Interpolation getInterpolation () const
 
void setInterpolation (Interpolation interp)
 
FileTransformoperator= (const FileTransform &)=delete
 
virtual ~FileTransform ()
 Do not use (needed only for pybind11). More...
 
- Public Member Functions inherited from OCIO_NAMESPACE::Transform
 Transform (const Transform &)=delete
 
Transformoperator= (const Transform &)=delete
 
virtual ~Transform ()=default
 Do not use (needed only for pybind11). More...
 

Static Public Member Functions

static FileTransformRcPtr Create ()
 
static int GetNumFormats ()
 Get the number of LUT readers. More...
 
static const char * GetFormatNameByIndex (int index)
 Get the LUT readers at index, return empty string if an invalid index is specified. More...
 
static const char * GetFormatExtensionByIndex (int index)
 Get the LUT reader extension at index, return empty string if an invalid index is specified. More...
 

Additional Inherited Members

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

Detailed Description

Definition at line 1017 of file OpenColorTransforms.h.

Constructor & Destructor Documentation

virtual OCIO_NAMESPACE::FileTransform::~FileTransform ( )
virtual

Do not use (needed only for pybind11).

Member Function Documentation

static FileTransformRcPtr OCIO_NAMESPACE::FileTransform::Create ( )
static
TransformRcPtr OCIO_NAMESPACE::FileTransform::createEditableCopy ( ) const
overridevirtual
const char* OCIO_NAMESPACE::FileTransform::getCCCId ( ) const

The cccid can be the ID of a CDL or the index of the CDL (as string). If cccid is NULL or empty the first CDL is returned. The cccid is case-sensitive.

CDLStyle OCIO_NAMESPACE::FileTransform::getCDLStyle ( ) const
TransformDirection OCIO_NAMESPACE::FileTransform::getDirection ( ) const
overridevirtualnoexcept
static const char* OCIO_NAMESPACE::FileTransform::GetFormatExtensionByIndex ( int  index)
static

Get the LUT reader extension at index, return empty string if an invalid index is specified.

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

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

Interpolation OCIO_NAMESPACE::FileTransform::getInterpolation ( ) const

The file parsers that care about interpolation (LUTs) will try to make use of the requested interpolation method when loading the file. In these cases, if the requested method could not be used, a warning is logged. If no method is provided, or a method cannot be used, INTERP_DEFAULT is used.

static int OCIO_NAMESPACE::FileTransform::GetNumFormats ( )
static

Get the number of LUT readers.

const char* OCIO_NAMESPACE::FileTransform::getSrc ( ) const
TransformType OCIO_NAMESPACE::FileTransform::getTransformType ( ) const
inlineoverridevirtualnoexcept

Implements OCIO_NAMESPACE::Transform.

Definition at line 1027 of file OpenColorTransforms.h.

FileTransform& OCIO_NAMESPACE::FileTransform::operator= ( const FileTransform )
delete
void OCIO_NAMESPACE::FileTransform::setCCCId ( const char *  id)
void OCIO_NAMESPACE::FileTransform::setCDLStyle ( CDLStyle  )

Can be used with CDL, CC & CCC formats to specify the clamping behavior of the CDLTransform. Default is CDL_NO_CLAMP.

void OCIO_NAMESPACE::FileTransform::setDirection ( TransformDirection  dir)
overridevirtualnoexcept

Note that this only affects the evaluation and not the values stored in the object.

Implements OCIO_NAMESPACE::Transform.

void OCIO_NAMESPACE::FileTransform::setInterpolation ( Interpolation  interp)
void OCIO_NAMESPACE::FileTransform::setSrc ( const char *  src)
void OCIO_NAMESPACE::FileTransform::validate ( ) const
overridevirtual

Will throw if data is not valid.

Reimplemented from OCIO_NAMESPACE::Transform.


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