Named Transform¶
-
class
PyOpenColorIO.NamedTransform¶ NamedTransform.
A NamedTransform provides a way for config authors to include a set of color transforms that are independent of the color space being processed. For example a “utility curve” transform where there is no need to convert to or from a reference space.
-
class
NamedTransformAliasIterator¶ -
NamedTransformAliasIterator(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
-
-
NamedTransformAliasIterator(*args, **kwargs)¶ Overloaded function.
__init__(self: PyOpenColorIO.NamedTransform) -> None
__init__(self: PyOpenColorIO.NamedTransform, name: str = ‘’, aliases: List[str] = [], family: str = ‘’, description: str = ‘’, forwardTransform: PyOpenColorIO.Transform = None, inverseTransform: PyOpenColorIO.Transform = None, categories: List[str] = []) -> None
-
addAlias(alias: str) → None¶ Nothing is done if alias is NULL or empty, if it is already there, or if it is already the named transform name.
-
addCategory(category: str) → None¶
-
clearAliases() → None¶
-
clearCategories() → None¶
-
getAliases() → PyOpenColorIO.NamedTransform.NamedTransformAliasIterator¶
-
getCategories() → PyOpenColorIO.NamedTransform.NamedTransformCategoryIterator¶
-
getDescription() → str¶
-
getEncoding() → str¶ A NamedTransform is not a color space and does not have an encoding in the same sense. However, it may be useful to associate a color space encoding that the transform is intended to be used with, for organizational purposes.
-
getFamily() → str¶
-
getName() → str¶
-
getTransform(direction: PyOpenColorIO.TransformDirection) → PyOpenColorIO.Transform¶
-
hasCategory(category: str) → bool¶
-
removeAlias(alias: str) → None¶ Does nothing if alias is not present.
-
removeCategory(category: str) → None¶
-
setDescription(description: str) → None¶
-
setEncoding(encodig: str) → None¶
-
setFamily(family: str) → None¶
-
setName(name: str) → None¶
-
setTransform(transform: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) → None¶
-
class
-
class
OpenColorIO_v2_0::NamedTransform¶ -
provides a way for config authors to include a set of color transforms that are independent of the color space being processed. For example a “utility
curve” transform where there is no need to convert to or from a reference space.
Public Functions
-
NamedTransformRcPtr
createEditableCopy() const = 0¶
-
const char *
getName() const noexcept = 0¶
-
void
setName(const char *name) noexcept = 0¶
-
size_t
getNumAliases() const noexcept = 0¶ Aliases can be used instead of the name. They must be unique within the config.
-
const char *
getAlias(size_t idx) const noexcept = 0¶ Return empty string if idx is out of range.
-
void
addAlias(const char *alias) noexcept = 0¶ Nothing is done if alias is NULL or empty, if it is already there, or if it is already the named transform name.
-
void
removeAlias(const char *alias) noexcept = 0¶ Does nothing if alias is not present.
-
void
clearAliases() noexcept = 0¶
-
const char *
getFamily() const noexcept = 0¶
-
void
setFamily(const char *family) noexcept = 0¶
-
const char *
getDescription() const noexcept = 0¶
-
void
setDescription(const char *description) noexcept = 0¶
-
bool
hasCategory(const char *category) const noexcept = 0¶
-
void
addCategory(const char *category) noexcept = 0¶
-
void
removeCategory(const char *category) noexcept = 0¶
-
int
getNumCategories() const noexcept = 0¶
-
const char *
getCategory(int index) const noexcept = 0¶
-
void
clearCategories() noexcept = 0¶
-
const char *
getEncoding() const noexcept = 0¶ A NamedTransform is not a color space and does not have an encoding in the same sense. However, it may be useful to associate a color space encoding that the transform is intended to be used with, for organizational purposes.
-
void
setEncoding(const char *encoding) noexcept = 0¶
-
ConstTransformRcPtr
getTransform(TransformDirection dir) const = 0¶
-
void
setTransform(const ConstTransformRcPtr &transform, TransformDirection dir) = 0¶
-
NamedTransform(const NamedTransform&) = delete¶
-
NamedTransform &
operator=(const NamedTransform&) = delete¶
-
~NamedTransform() = default¶
Public Static Functions
-
NamedTransformRcPtr
Create()¶
-
NamedTransformRcPtr
-
std::ostream &
OpenColorIO_v2_0::operator<<(std::ostream&, const NamedTransform&)¶
-
typedef std::shared_ptr<const NamedTransform>
OpenColorIO_v2_0::ConstNamedTransformRcPtr¶
-
typedef std::shared_ptr<NamedTransform>
OpenColorIO_v2_0::NamedTransformRcPtr¶