|
Synergy Color Management Component - SDK -
2018.0.80
|
The class contains all the file rules, and the capabilities to manage them. More...
Public Types | |
| enum | OCIOModes { USE_OCIO_RULES = 0, USE_FILE_PATH_RULES } |
| Defines the OCIO modes. More... | |
Public Member Functions | |
| virtual bool | isReadOnly () const =0 |
| Is the rule container read only or not ? More... | |
| virtual const char * | evaluateFilePath (const char *filePath) const =0 |
| Evaluate the file path to find the associated color space. More... | |
Public Member Functions inherited from SYNCOLOR::Rules | |
| virtual SynStatus | restoreDefaults ()=0 |
| Restore the default rules. More... | |
| virtual SynStatus | load ()=0 |
| Load rules from preferences. More... | |
| virtual SynStatus | save () const =0 |
| Save the rules in the preferences. More... | |
| virtual unsigned int | getNumRules () const =0 |
| Get the number of rules. More... | |
| virtual SynStatus | getRule (unsigned int position, RulePtr &rule) const =0 |
| Get a specific rule using its position. More... | |
| virtual SynStatus | getRule (const char *name, RulePtr &rule) const =0 |
| Get a specific rule using its name. More... | |
| virtual SynStatus | moveRule (const char *name, int offset)=0 |
| Move a rule to a new position. More... | |
| virtual SynStatus | removeRule (const char *name)=0 |
| Remove a rule using its name. More... | |
| virtual SynStatus | serialize (RuleWriter &writer) const =0 |
| Serialize the rule container in XML. More... | |
| virtual SynStatus | populate (const char *data, unsigned int length)=0 |
| Populate the rule container. More... | |
Static Public Member Functions | |
| static FileRules & | instance () |
| Get the current container (could be the native one or an OCIO one) More... | |
| static void | setNativeMode () |
| Set the rule container to the native one. More... | |
| static SynStatus | setOCIOMode (const char *ocioFilePath, OCIOModes ruleMode) |
| Set the rule container to the OCIO one. More... | |
Protected Member Functions | |
| virtual | ~FileRules () |
| Default destructor. More... | |
The class contains all the file rules, and the capabilities to manage them.
Defines the OCIO modes.
|
inlineprotectedvirtual |
Default destructor.
|
static |
Get the current container (could be the native one or an OCIO one)
|
static |
Set the rule container to the native one.
|
static |
Set the rule container to the OCIO one.
| ocioFilePath | The file path to the OCIO configuration file |
| ruleMode | The rules to use in OCIO mode |
|
pure virtual |
Is the rule container read only or not ?
|
pure virtual |
Evaluate the file path to find the associated color space.
| filePath | The file path to evaluate |