The File Rules are a set of filepath to color space mappings that are evaluated from first to last. The first rule to match is what determines which color space is returned. There are four types of rules available. Each rule type has a name key that may be used by applications to refer to that rule. Name values must be unique i.e. using a case insensitive comparison. The other keys depend on the rule type:
More...
|
FileRulesRcPtr | createEditableCopy () const |
| The method clones the content decoupling the two instances. More...
|
|
size_t | getNumEntries () const noexcept |
| Does include default rule. Result will be at least 1. More...
|
|
size_t | getIndexForRule (const char *ruleName) const |
| Get the index from the rule name. More...
|
|
const char * | getName (size_t ruleIndex) const |
| Get name of the rule. More...
|
|
const char * | getPattern (size_t ruleIndex) const |
| Setting pattern will erase regex. More...
|
|
void | setPattern (size_t ruleIndex, const char *pattern) |
|
const char * | getExtension (size_t ruleIndex) const |
| Setting extension will erase regex. More...
|
|
void | setExtension (size_t ruleIndex, const char *extension) |
|
const char * | getRegex (size_t ruleIndex) const |
| Setting a regex will erase pattern & extension. More...
|
|
void | setRegex (size_t ruleIndex, const char *regex) |
|
const char * | getColorSpace (size_t ruleIndex) const |
| Set the rule's color space (may also be a role). More...
|
|
void | setColorSpace (size_t ruleIndex, const char *colorSpace) |
|
size_t | getNumCustomKeys (size_t ruleIndex) const |
| Get number of key/value pairs. More...
|
|
const char * | getCustomKeyName (size_t ruleIndex, size_t key) const |
| Get name of key. More...
|
|
const char * | getCustomKeyValue (size_t ruleIndex, size_t key) const |
| Get value for the key. More...
|
|
void | setCustomKey (size_t ruleIndex, const char *key, const char *value) |
|
void | insertRule (size_t ruleIndex, const char *name, const char *colorSpace, const char *pattern, const char *extension) |
| Insert a rule at a given ruleIndex. More...
|
|
void | insertRule (size_t ruleIndex, const char *name, const char *colorSpace, const char *regex) |
|
void | insertPathSearchRule (size_t ruleIndex) |
| Helper function to insert a rule. More...
|
|
void | setDefaultRuleColorSpace (const char *colorSpace) |
| Helper function to set the color space for the default rule. More...
|
|
void | removeRule (size_t ruleIndex) |
|
void | increaseRulePriority (size_t ruleIndex) |
| Move a rule closer to the start of the list by one position. More...
|
|
void | decreaseRulePriority (size_t ruleIndex) |
| Move a rule closer to the end of the list by one position. More...
|
|
bool | isDefault () const noexcept |
|
| FileRules (const FileRules &)=delete |
|
FileRules & | operator= (const FileRules &)=delete |
|
virtual | ~FileRules () |
| Do not use (needed only for pybind11). More...
|
|
The File Rules are a set of filepath to color space mappings that are evaluated from first to last. The first rule to match is what determines which color space is returned. There are four types of rules available. Each rule type has a name key that may be used by applications to refer to that rule. Name values must be unique i.e. using a case insensitive comparison. The other keys depend on the rule type:
- Basic Rule: This is the basic rule type that uses Unix glob style pattern matching and is thus very easy to use. It contains the keys:
- name: Name of the rule
- colorspace: Color space name to be returned.
- pattern: Glob pattern to be used for the main part of the name/path.
- extension: Glob pattern to be used for the file extension. Note that if glob tokens are not used, the extension will be used in a non-case-sensitive way by default.
- Regex Rule: This is similar to the basic rule but allows additional capabilities for power-users. It contains the keys:
- name: Name of the rule
- colorspace: Color space name to be returned.
- regex: Regular expression to be evaluated.
- OCIO v1 style Rule: This rule allows the use of the OCIO v1 style, where the string is searched for color space names from the config. This rule may occur 0 or 1 times in the list. The position in the list prioritizes it with respect to the other rules. StrictParsing is not used. If no color space is found in the path, the rule will not match and the next rule will be considered. see insertPathSearchRule. It has the key:
- name: Must be "ColorSpaceNamePathSearch".
- Default Rule: The file_rules must always end with this rule. If no prior rules match, this rule specifies the color space applications will use. see setDefaultRuleColorSpace. It has the keys:
- name: must be "Default".
- colorspace : Color space name to be returned.
Custom string keys and associated string values may be used to convey app or workflow-specific information, e.g. whether the color space should be left as is or converted into a working space.
Getters and setters are using the rule position, they will throw if the position is not valid. If the rule at the specified position does not implement the requested property getter will return NULL and setter will throw.
When loading a v1 config, a set of FileRules are created with ColorSpaceNamePathSearch followed by the Default rule pointing to the default role. This allows getColorSpaceFromFilepath to emulate OCIO v1 code that used parseColorSpaceFromString with strictparsing set to false.
Definition at line 1605 of file OpenColorIO.h.