Synergy Color Management Component - SDK -  2018.0.80
SYNCOLOR::Template Class Referenceabstract

Color transform creation templates. More...

Public Member Functions

virtual ~Template ()
 Default destructor. More...
 
virtual SYNCOLOR::SynStatus getParameter (SYNCOLOR::TemplateParameterId paramId, SYNCOLOR::TemplateParameterPtr &pParameter) const =0
 Retrieve the template parameter of the specified type. More...
 
virtual SYNCOLOR::SynStatus createTransform (SYNCOLOR::TransformPtr &pTransform, SYNCOLOR::TransformDirection dir) const =0
 Create a transform based on the selected template parameters. More...
 

Detailed Description

Color transform creation templates.

Color transform templates manage the creation of color transforms based on a set of input parameters. Currently there are three types of templates; they create transforms specifically for either

  • viewing
  • input to working space conversion
  • color mixing

The native color transform templates leverage the Autodesk SynColor transform collection to create transforms for the tasks listed above. It is also possible to add color transforms to the native SynColor transfom ecosystem with the help of the catalog manager (see the SYNCOLOR::NativeCatalogManager class).

Color transform templates are also the mechanism through which SynColor exposes support for OpenColorIO configurations. In short these configurations specify color spaces and transforms to go between these color spaces. A single OpenColorIO configuration is a closed set of color transformations.

To obtain a color transform template, the following functions are provided:

Each template provides a list of parameters. Each template parameter provides a list of possible values and these lists are meant to be presented in application UIs.

Once the template parameters are set to desired values, a color transform is obtained with the createTransform() method. It is possible to get the forward or reverse color transform. Transforms created by templates are placed in the color transform cache (see SYNCOLOR::TransformCache).

Constructor & Destructor Documentation

virtual SYNCOLOR::Template::~Template ( )
virtual

Default destructor.

Member Function Documentation

virtual SYNCOLOR::SynStatus SYNCOLOR::Template::getParameter ( SYNCOLOR::TemplateParameterId  paramId,
SYNCOLOR::TemplateParameterPtr pParameter 
) const
pure virtual

Retrieve the template parameter of the specified type.

Parameters
paramIdParameter ID. See SYNCOLOR::TemplateParameterId.
pParameterReturn template parameter instance.
Returns
Returns a SYNCOLOR::SynStatus. Check the error code to determine if an error occurred.
virtual SYNCOLOR::SynStatus SYNCOLOR::Template::createTransform ( SYNCOLOR::TransformPtr pTransform,
SYNCOLOR::TransformDirection  dir 
) const
pure virtual

Create a transform based on the selected template parameters.

If for the current parameter values a transform has already been created, it is retrieved from the cache.

Parameters
pTransformReturned transform instance.
dirTransform direction: forward or reverse. See SYNCOLOR::TransformDirection.
Returns
Returns a SYNCOLOR::SynStatus. Check the error code to determine if an error occurred.