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

#include <OpenColorTransforms.h>

+ Inheritance diagram for OCIO_NAMESPACE::LogCameraTransform:

Public Member Functions

TransformType getTransformType () const noexceptoverride
 
virtual const FormatMetadatagetFormatMetadata () const noexcept=0
 
virtual FormatMetadatagetFormatMetadata () noexcept=0
 
virtual bool equals (const LogCameraTransform &other) const noexcept=0
 Checks if this exactly equals other. More...
 
virtual double getBase () const noexcept=0
 
virtual void setBase (double base) noexcept=0
 
virtual void getLogSideSlopeValue (double(&values)[3]) const noexcept=0
 Get/Set values for the R, G, B components. More...
 
virtual void setLogSideSlopeValue (const double(&values)[3]) noexcept=0
 
virtual void getLogSideOffsetValue (double(&values)[3]) const noexcept=0
 
virtual void setLogSideOffsetValue (const double(&values)[3]) noexcept=0
 
virtual void getLinSideSlopeValue (double(&values)[3]) const noexcept=0
 
virtual void setLinSideSlopeValue (const double(&values)[3]) noexcept=0
 
virtual void getLinSideOffsetValue (double(&values)[3]) const noexcept=0
 
virtual void setLinSideOffsetValue (const double(&values)[3]) noexcept=0
 
virtual void getLinSideBreakValue (double(&values)[3]) const noexcept=0
 
virtual void setLinSideBreakValue (const double(&values)[3]) noexcept=0
 
virtual bool getLinearSlopeValue (double(&values)[3]) const =0
 Return true if LinearSlope values were set, false if they were not. More...
 
virtual void setLinearSlopeValue (const double(&values)[3])=0
 Set LinearSlope value. More...
 
virtual void unsetLinearSlopeValue ()=0
 Remove LinearSlope values so that default values are used. More...
 
 LogCameraTransform (const LogCameraTransform &)=delete
 
LogCameraTransformoperator= (const LogCameraTransform &)=delete
 
virtual ~LogCameraTransform ()=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 LogCameraTransformRcPtr Create (const double(&linSideBreakValues)[3])
 LinSideBreak must be set for the transform to be valid (there is no default). More...
 

Protected Member Functions

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

Detailed Description

Same as LogAffineTransform but with the addition of a linear segment near black. This formula is used for many camera logs (e.g., LogC) as well as ACEScct.

  • The linSideBreak specifies the point on the linear axis where the log and linear segments meet. It must be set (there is no default).
  • The linearSlope specifies the slope of the linear segment of the forward (linToLog) transform. By default it is set equal to the slope of the log curve at the break point.

Definition at line 1446 of file OpenColorTransforms.h.

Constructor & Destructor Documentation

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

Do not use (needed only for pybind11).

OCIO_NAMESPACE::LogCameraTransform::LogCameraTransform ( )
protecteddefault

Member Function Documentation

static LogCameraTransformRcPtr OCIO_NAMESPACE::LogCameraTransform::Create ( const double(&)  linSideBreakValues[3])
static

LinSideBreak must be set for the transform to be valid (there is no default).

virtual bool OCIO_NAMESPACE::LogCameraTransform::equals ( const LogCameraTransform other) const
pure virtualnoexcept

Checks if this exactly equals other.

virtual double OCIO_NAMESPACE::LogCameraTransform::getBase ( ) const
pure virtualnoexcept
virtual const FormatMetadata& OCIO_NAMESPACE::LogCameraTransform::getFormatMetadata ( ) const
pure virtualnoexcept
virtual FormatMetadata& OCIO_NAMESPACE::LogCameraTransform::getFormatMetadata ( )
pure virtualnoexcept
virtual bool OCIO_NAMESPACE::LogCameraTransform::getLinearSlopeValue ( double(&)  values[3]) const
pure virtual

Return true if LinearSlope values were set, false if they were not.

virtual void OCIO_NAMESPACE::LogCameraTransform::getLinSideBreakValue ( double(&)  values[3]) const
pure virtualnoexcept
virtual void OCIO_NAMESPACE::LogCameraTransform::getLinSideOffsetValue ( double(&)  values[3]) const
pure virtualnoexcept
virtual void OCIO_NAMESPACE::LogCameraTransform::getLinSideSlopeValue ( double(&)  values[3]) const
pure virtualnoexcept
virtual void OCIO_NAMESPACE::LogCameraTransform::getLogSideOffsetValue ( double(&)  values[3]) const
pure virtualnoexcept
virtual void OCIO_NAMESPACE::LogCameraTransform::getLogSideSlopeValue ( double(&)  values[3]) const
pure virtualnoexcept

Get/Set values for the R, G, B components.

TransformType OCIO_NAMESPACE::LogCameraTransform::getTransformType ( ) const
inlineoverridevirtualnoexcept

Implements OCIO_NAMESPACE::Transform.

Definition at line 1452 of file OpenColorTransforms.h.

LogCameraTransform& OCIO_NAMESPACE::LogCameraTransform::operator= ( const LogCameraTransform )
delete
virtual void OCIO_NAMESPACE::LogCameraTransform::setBase ( double  base)
pure virtualnoexcept
virtual void OCIO_NAMESPACE::LogCameraTransform::setLinearSlopeValue ( const double(&)  values[3])
pure virtual

Set LinearSlope value.

Note
You must call setLinSideBreakValue before calling this.
virtual void OCIO_NAMESPACE::LogCameraTransform::setLinSideBreakValue ( const double(&)  values[3])
pure virtualnoexcept
virtual void OCIO_NAMESPACE::LogCameraTransform::setLinSideOffsetValue ( const double(&)  values[3])
pure virtualnoexcept
virtual void OCIO_NAMESPACE::LogCameraTransform::setLinSideSlopeValue ( const double(&)  values[3])
pure virtualnoexcept
virtual void OCIO_NAMESPACE::LogCameraTransform::setLogSideOffsetValue ( const double(&)  values[3])
pure virtualnoexcept
virtual void OCIO_NAMESPACE::LogCameraTransform::setLogSideSlopeValue ( const double(&)  values[3])
pure virtualnoexcept
virtual void OCIO_NAMESPACE::LogCameraTransform::unsetLinearSlopeValue ( )
pure virtual

Remove LinearSlope values so that default values are used.


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