Rules¶
FileRules¶
-
class
PyOpenColorIO.
FileRules
¶ -
FileRules
() → None¶ Creates FileRules for a Config. File rules will contain the default rule using the default role. The default rule cannot be removed.
-
decreaseRulePriority
(ruleIndex: int) → None¶ Move a rule closer to the end of the list by one position.
-
getColorSpace
(ruleIndex: int) → str¶ Set the rule’s color space (may also be a role).
-
getCustomKeyName
(ruleIndex: int, key: int) → str¶ Get name of key.
-
getCustomKeyValue
(ruleIndex: int, key: int) → str¶ Get value for the key.
-
getExtension
(ruleIndex: int) → str¶ Setting extension will erase regex.
-
getIndexForRule
(ruleName: str) → int¶ Get the index from the rule name.
-
getName
(ruleIndex: int) → str¶ Get name of the rule.
-
getNumCustomKeys
(ruleIndex: int) → int¶ Get number of key/value pairs.
-
getNumEntries
() → int¶ Does include default rule. Result will be at least 1.
-
getPattern
(ruleIndex: int) → str¶ Setting pattern will erase regex.
-
getRegex
(ruleIndex: int) → str¶ Setting a regex will erase pattern & extension.
-
increaseRulePriority
(ruleIndex: int) → None¶ Move a rule closer to the start of the list by one position.
-
insertPathSearchRule
(ruleIndex: int) → None¶ Helper function to insert a rule.
Uses Config:parseColorSpaceFromString to search the path for any of the color spaces named in the config (as per OCIO v1).
-
insertRule
(*args, **kwargs)¶ Overloaded function.
insertRule(self: PyOpenColorIO.FileRules, ruleIndex: int, name: str, colorSpace: str, pattern: str, extension: str) -> None
Insert a rule at a given ruleIndex.
Rule currently at ruleIndex will be pushed to index: ruleIndex + 1. Name must be unique. - “Default” is a reserved name for the default rule. The default rule is automatically added and can’t be removed. (see FileRules::setDefaultRuleColorSpace ). - “ColorSpaceNamePathSearch” is also a reserved name (see FileRules::insertPathSearchRule ).
Will throw if pattern, extension or regex is a null or empty string.
Will throw if ruleIndex is not less than FileRules::getNumEntries .
insertRule(self: PyOpenColorIO.FileRules, ruleIndex: int, name: str, colorSpace: str, regex: str) -> None
-
isDefault
() → bool¶ Check if there is only the default rule using default role and no custom key. This is the default FileRules state when creating a new config.
-
removeRule
(ruleIndex: int) → None¶ Note
Default rule can’t be removed. Will throw if ruleIndex + 1 is not less than FileRules::getNumEntries .
-
setColorSpace
(ruleIndex: int, colorSpace: str) → None¶
-
setCustomKey
(ruleIndex: int, key: str, value: str) → None¶ Adds a key/value or replace value if key exists. Setting a NULL or an empty value will erase the key.
-
setDefaultRuleColorSpace
(colorSpace: str) → None¶ Helper function to set the color space for the default rule.
-
setExtension
(ruleIndex: int, extension: str) → None¶
-
setPattern
(ruleIndex: int, pattern: str) → None¶
-
setRegex
(ruleIndex: int, regex: str) → None¶
-
-
class
OpenColorIO_v2_0
::
FileRules
¶ Public Functions
-
FileRulesRcPtr
createEditableCopy
() const¶ The method clones the content decoupling the two instances.
-
size_t
getNumEntries
() const noexcept¶ Does include default rule. Result will be at least 1.
-
size_t
getIndexForRule
(const char *ruleName) const¶ Get the index from the rule name.
-
const char *
getName
(size_t ruleIndex) const¶ Get name of the rule.
-
const char *
getPattern
(size_t ruleIndex) const¶ Setting pattern will erase regex.
-
void
setPattern
(size_t ruleIndex, const char *pattern)¶
-
const char *
getExtension
(size_t ruleIndex) const¶ Setting extension will erase regex.
-
void
setExtension
(size_t ruleIndex, const char *extension)¶
-
const char *
getRegex
(size_t ruleIndex) const¶ Setting a regex will erase pattern & extension.
-
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).
-
void
setColorSpace
(size_t ruleIndex, const char *colorSpace)¶
-
size_t
getNumCustomKeys
(size_t ruleIndex) const¶ Get number of key/value pairs.
-
const char *
getCustomKeyName
(size_t ruleIndex, size_t key) const¶ Get name of key.
-
const char *
getCustomKeyValue
(size_t ruleIndex, size_t key) const¶ Get value for the key.
-
void
setCustomKey
(size_t ruleIndex, const char *key, const char *value)¶ Adds a key/value or replace value if key exists. Setting a NULL or an empty value will erase the key.
-
void
insertRule
(size_t ruleIndex, const char *name, const char *colorSpace, const char *pattern, const char *extension)¶ Insert a rule at a given ruleIndex.
Rule currently at ruleIndex will be pushed to index: ruleIndex + 1. Name must be unique.
”Default” is a reserved name for the default rule. The default rule is automatically added and can’t be removed. (see FileRules::setDefaultRuleColorSpace ).
”ColorSpaceNamePathSearch” is also a reserved name (see FileRules::insertPathSearchRule ).
Will throw if pattern, extension or regex is a null or empty string.
Will throw if ruleIndex is not less than FileRules::getNumEntries .
-
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.
Uses Config:parseColorSpaceFromString to search the path for any of the color spaces named in the config (as per OCIO v1).
-
void
setDefaultRuleColorSpace
(const char *colorSpace)¶ Helper function to set the color space for the default rule.
-
void
removeRule
(size_t ruleIndex)¶ - Note
Default rule can’t be removed. Will throw if ruleIndex + 1 is not less than FileRules::getNumEntries .
-
void
increaseRulePriority
(size_t ruleIndex)¶ Move a rule closer to the start of the list by one position.
-
void
decreaseRulePriority
(size_t ruleIndex)¶ Move a rule closer to the end of the list by one position.
-
bool
isDefault
() const noexcept¶ Check if there is only the default rule using default role and no custom key. This is the default FileRules state when creating a new config.
-
~FileRules
()¶ Do not use (needed only for pybind11).
Public Static Functions
-
FileRulesRcPtr
Create
()¶ Creates FileRules for a Config. File rules will contain the default rule using the default role. The default rule cannot be removed.
-
FileRulesRcPtr
ViewingRules¶
-
class
PyOpenColorIO.
ViewingRules
¶ -
ViewingRules
() → None¶ Creates ViewingRules for a Config.
-
addColorSpace
(ruleIndex: int, colorSpaceName: str) → None¶ Add colorspace name. Will throw if:
RuleIndex is invalid.
:ref:`ViewingRules::getNumEncodings`()
is not 0.
-
addEncoding
(ruleIndex: int, encodingName: str) → None¶ Add encoding name. Will throw if:
RuleIndex is invalid.
:ref:`ViewingRules::getNumColorSpaces`()
is not 0.
-
getColorSpaces
(ruleIndex: int) → PyOpenColorIO.ViewingRules.ViewingRuleColorSpaceIterator¶
-
getCustomKeyName
(ruleIndex: int, key: int) → str¶ Get name of key. Will throw if ruleIndex or keyIndex is invalid.
-
getCustomKeyValue
(ruleIndex: int, key: int) → str¶ Get value for the key. Will throw if ruleIndex or keyIndex is invalid.
-
getEncodings
(ruleIndex: int) → PyOpenColorIO.ViewingRules.ViewingRuleEncodingIterator¶
-
getIndexForRule
(ruleName: str) → int¶ Get the index from the rule name. Will throw if there is no rule named ruleName.
-
getName
(ruleIndex: int) → str¶ Get name of the rule. Will throw if ruleIndex is invalid.
-
getNumCustomKeys
(ruleIndex: int) → int¶ Get number of key/value pairs. Will throw if ruleIndex is invalid.
-
getNumEntries
() → int¶
-
insertRule
(ruleIndex: int, name: str) → None¶ Insert a rule at a given ruleIndex.
Rule currently at ruleIndex will be pushed to index: ruleIndex + 1. If ruleIndex is
ViewingRules::getNumEntries()
new rule will be added at the end. Will throw if: - RuleIndex is invalid (must be less than or equal to cpp:func:ViewingRules::getNumEntries). - RuleName already exists.
-
removeColorSpace
(ruleIndex: int, colorSpaceIndex: int) → None¶ Remove colorspace. Will throw if ruleIndex or colorSpaceIndex is invalid.
-
removeEncoding
(ruleIndex: int, encodingIndex: int) → None¶ Remove encoding. Will throw if ruleIndex or encodingIndex is invalid.
-
removeRule
(ruleIndex: int) → None¶ Remove a rule. Throws if ruleIndex is not valid.
-
setCustomKey
(ruleIndex: int, key: str, value: str) → None¶ Adds a key/value or replace value if key exists. Setting a NULL or an empty value will erase the key. Will throw if ruleIndex is invalid.
-
-
class
OpenColorIO_v2_0
::
ViewingRules
¶ Public Functions
-
ViewingRulesRcPtr
createEditableCopy
() const¶ The method clones the content decoupling the two instances.
-
size_t
getNumEntries
() const noexcept¶
-
size_t
getIndexForRule
(const char *ruleName) const¶ Get the index from the rule name. Will throw if there is no rule named ruleName.
-
const char *
getName
(size_t ruleIndex) const¶ Get name of the rule. Will throw if ruleIndex is invalid.
-
size_t
getNumColorSpaces
(size_t ruleIndex) const¶ Get number of colorspaces. Will throw if ruleIndex is invalid.
-
const char *
getColorSpace
(size_t ruleIndex, size_t colorSpaceIndex) const¶ Get colorspace name. Will throw if ruleIndex or colorSpaceIndex is invalid.
-
void
addColorSpace
(size_t ruleIndex, const char *colorSpace)¶ Add colorspace name. Will throw if:
RuleIndex is invalid.
:cpp:func:
ViewingRules::getNumEncodings
is not 0.
-
void
removeColorSpace
(size_t ruleIndex, size_t colorSpaceIndex)¶ Remove colorspace. Will throw if ruleIndex or colorSpaceIndex is invalid.
-
size_t
getNumEncodings
(size_t ruleIndex) const¶ Get number of encodings. Will throw if ruleIndex is invalid.
-
const char *
getEncoding
(size_t ruleIndex, size_t encodingIndex) const¶ Get encoding name. Will throw if ruleIndex or encodingIndex is invalid.
-
void
addEncoding
(size_t ruleIndex, const char *encoding)¶ Add encoding name. Will throw if:
RuleIndex is invalid.
:cpp:func:
ViewingRules::getNumColorSpaces
is not 0.
-
void
removeEncoding
(size_t ruleIndex, size_t encodingIndex)¶ Remove encoding. Will throw if ruleIndex or encodingIndex is invalid.
-
size_t
getNumCustomKeys
(size_t ruleIndex) const¶ Get number of key/value pairs. Will throw if ruleIndex is invalid.
-
const char *
getCustomKeyName
(size_t ruleIndex, size_t keyIndex) const¶ Get name of key. Will throw if ruleIndex or keyIndex is invalid.
-
const char *
getCustomKeyValue
(size_t ruleIndex, size_t keyIndex) const¶ Get value for the key. Will throw if ruleIndex or keyIndex is invalid.
-
void
setCustomKey
(size_t ruleIndex, const char *key, const char *value)¶ Adds a key/value or replace value if key exists. Setting a NULL or an empty value will erase the key. Will throw if ruleIndex is invalid.
-
void
insertRule
(size_t ruleIndex, const char *ruleName)¶ Insert a rule at a given ruleIndex.
Rule currently at ruleIndex will be pushed to index: ruleIndex + 1. If ruleIndex is :cpp:func:
ViewingRules::getNumEntries
new rule will be added at the end. Will throw if:RuleIndex is invalid (must be less than or equal to cpp:func:
ViewingRules::getNumEntries
).RuleName already exists.
-
void
removeRule
(size_t ruleIndex)¶ Remove a rule. Throws if ruleIndex is not valid.
-
ViewingRules
(const ViewingRules&) = delete¶
-
ViewingRules &
operator=
(const ViewingRules&) = delete¶
-
~ViewingRules
()¶ Do not use (needed only for pybind11).
Public Static Functions
-
ViewingRulesRcPtr
Create
()¶ Creates ViewingRules for a Config.
-
ViewingRulesRcPtr
-
std::ostream &
OpenColorIO_v2_0
::
operator<<
(std::ostream&, const ViewingRules&)¶
-
typedef std::shared_ptr<const ViewingRules>
OpenColorIO_v2_0
::
ConstViewingRulesRcPtr
¶
-
typedef std::shared_ptr<ViewingRules>
OpenColorIO_v2_0
::
ViewingRulesRcPtr
¶