HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
OCIO_NAMESPACE::ExponentTransform Class Referenceabstract

Represents exponent transform: pow( clamp(color), value ). More...

#include <OpenColorTransforms.h>

+ Inheritance diagram for OCIO_NAMESPACE::ExponentTransform:

Public Member Functions

TransformType getTransformType () const noexceptoverride
 
virtual const FormatMetadatagetFormatMetadata () const noexcept=0
 
virtual FormatMetadatagetFormatMetadata () noexcept=0
 
virtual bool equals (const ExponentTransform &other) const noexcept=0
 Checks if this exactly equals other. More...
 
virtual void getValue (double(&vec4)[4]) const noexcept=0
 
virtual void setValue (const double(&vec4)[4]) noexcept=0
 
virtual NegativeStyle getNegativeStyle () const =0
 
virtual void setNegativeStyle (NegativeStyle style)=0
 
 ExponentTransform (const ExponentTransform &)=delete
 
ExponentTransformoperator= (const ExponentTransform &)=delete
 
virtual ~ExponentTransform ()=default
 Do not use (needed only for pybind11). More...
 
- Public Member Functions inherited from OCIO_NAMESPACE::Transform
virtual TransformRcPtr createEditableCopy () const =0
 
virtual TransformDirection getDirection () const noexcept=0
 
virtual void setDirection (TransformDirection dir) noexcept=0
 Note that this only affects the evaluation and not the values stored in the object. More...
 
virtual void validate () const
 Will throw if data is not valid. More...
 
 Transform (const Transform &)=delete
 
Transformoperator= (const Transform &)=delete
 
virtual ~Transform ()=default
 Do not use (needed only for pybind11). More...
 

Static Public Member Functions

static ExponentTransformRcPtr Create ()
 

Protected Member Functions

 ExponentTransform ()=default
 
- Protected Member Functions inherited from OCIO_NAMESPACE::Transform
 Transform ()=default
 

Detailed Description

Represents exponent transform: pow( clamp(color), value ).

Note
For configs with version == 1: Negative style is ignored and if the exponent is 1.0, this will not clamp. Otherwise, the input color will be clamped between [0.0, inf]. For configs with version > 1: Negative value handling may be specified via setNegativeStyle.

Definition at line 810 of file OpenColorTransforms.h.

Constructor & Destructor Documentation

OCIO_NAMESPACE::ExponentTransform::ExponentTransform ( const ExponentTransform )
delete
virtual OCIO_NAMESPACE::ExponentTransform::~ExponentTransform ( )
virtualdefault

Do not use (needed only for pybind11).

OCIO_NAMESPACE::ExponentTransform::ExponentTransform ( )
protecteddefault

Member Function Documentation

static ExponentTransformRcPtr OCIO_NAMESPACE::ExponentTransform::Create ( )
static
virtual bool OCIO_NAMESPACE::ExponentTransform::equals ( const ExponentTransform other) const
pure virtualnoexcept

Checks if this exactly equals other.

virtual const FormatMetadata& OCIO_NAMESPACE::ExponentTransform::getFormatMetadata ( ) const
pure virtualnoexcept
virtual FormatMetadata& OCIO_NAMESPACE::ExponentTransform::getFormatMetadata ( )
pure virtualnoexcept
virtual NegativeStyle OCIO_NAMESPACE::ExponentTransform::getNegativeStyle ( ) const
pure virtual

Specifies how negative values are handled. Legal values:

  • NEGATIVE_CLAMP – Clamp negative values (default).
  • NEGATIVE_MIRROR – Positive curve is rotated 180 degrees around the origin to handle negatives.
  • NEGATIVE_PASS_THRU – Negative values are passed through unchanged.
TransformType OCIO_NAMESPACE::ExponentTransform::getTransformType ( ) const
inlineoverridevirtualnoexcept

Implements OCIO_NAMESPACE::Transform.

Definition at line 815 of file OpenColorTransforms.h.

virtual void OCIO_NAMESPACE::ExponentTransform::getValue ( double(&)  vec4[4]) const
pure virtualnoexcept
ExponentTransform& OCIO_NAMESPACE::ExponentTransform::operator= ( const ExponentTransform )
delete
virtual void OCIO_NAMESPACE::ExponentTransform::setNegativeStyle ( NegativeStyle  style)
pure virtual
virtual void OCIO_NAMESPACE::ExponentTransform::setValue ( const double(&)  vec4[4])
pure virtualnoexcept

The documentation for this class was generated from the following file: