Synergy Color Management Component - SDK -  2018.0.80
SYNCOLOR::DefaultViewingRule Class Referenceabstract
Inheritance diagram for SYNCOLOR::DefaultViewingRule:
SYNCOLOR::Rule

Public Member Functions

RuleType getType () const
 Returns the type of the rule. More...
 
virtual const char * getViewTransform () const =0
 Get the view transform used by the rule. More...
 
virtual SynStatus setViewTransform (const char *viewTransform)=0
 Set the view transform used by the rule. More...
 
virtual const char * getAllowedColorSpaces () const =0
 Get the color spaces allowed by the rule. More...
 
virtual const char * getAllowedDisplays () const =0
 Get the displays allowed by the rule. More...
 
virtual bool getIsActive () const =0
 Get the active state of the rule. More...
 
- Public Member Functions inherited from SYNCOLOR::Rule
virtual ~Rule ()
 Default destructor. More...
 
virtual const char * getName () const =0
 Returns the name of the rule. More...
 

Additional Inherited Members

- Public Types inherited from SYNCOLOR::Rule
enum  RuleType { OPAQUE_RULE = 0, DEFAULT_RULE, STANDARD_RULE }
 All supported types of rule. More...
 
- Protected Member Functions inherited from SYNCOLOR::Rule
 Rule ()
 Default constructor. More...
 

Detailed Description

This class represents a rule where any color space and display will inherit from the same viewing transform

Member Function Documentation

RuleType SYNCOLOR::DefaultViewingRule::getType ( ) const
inlinevirtual

Returns the type of the rule.

Returns
the rule's type

Implements SYNCOLOR::Rule.

References SYNCOLOR::Rule::DEFAULT_RULE.

virtual const char* SYNCOLOR::DefaultViewingRule::getViewTransform ( ) const
pure virtual

Get the view transform used by the rule.

Returns
the view transform name
virtual SynStatus SYNCOLOR::DefaultViewingRule::setViewTransform ( const char *  viewTransform)
pure virtual

Set the view transform used by the rule.

Parameters
viewTransformThe view transform to be used by the rule. There is no validation of the string done.
Returns
returns a SYNCOLOR::SynStatus. Check the error code to determine if an error occurred. See SYNCOLOR::SynStatus above.
virtual const char* SYNCOLOR::DefaultViewingRule::getAllowedColorSpaces ( ) const
pure virtual

Get the color spaces allowed by the rule.

Returns
the allowed color spaces
virtual const char* SYNCOLOR::DefaultViewingRule::getAllowedDisplays ( ) const
pure virtual

Get the displays allowed by the rule.

Returns
the allowed displays
virtual bool SYNCOLOR::DefaultViewingRule::getIsActive ( ) const
pure virtual

Get the active state of the rule.

Returns
the active state