TuttleOFX  1
Public Member Functions | Protected Member Functions | Private Member Functions | Friends
OFX::RGBAParam Class Reference

Wraps up an RGB param. More...

#include <ofxsParam.h>

Inheritance diagram for OFX::RGBAParam:
Inheritance graph
[legend]
Collaboration diagram for OFX::RGBAParam:
Collaboration graph
[legend]

Public Member Functions

void setDefault (double r, double g, double b, double a)
 set the default value, default is 0
void getDefault (double &r, double &g, double &b, double &a) const
 get default value
OfxRGBAColourD getDefault () const
void getValue (double &r, double &g, double &b, double &a) const
 get value
OfxRGBAColourD getValue () const
void getValueAtTime (double t, double &r, double &g, double &b, double &a) const
 get the value at a time
OfxRGBAColourD getValueAtTime (double t) const
void setValue (double r, double g, double b, double a)
 set value
void setValueAtTime (double t, double r, double g, double b, double a)
 set the value at a time, implicitly adds a keyframe

Protected Member Functions

 RGBAParam (const ParamSet *paramSet, const std::string &name, OfxParamHandle handle)
 hidden constructor

Private Member Functions

 mDeclareProtectedAssignAndCC (RGBAParam)
 RGBAParam (void)

Friends

class ParamSet

Detailed Description

Wraps up an RGB param.

Definition at line 1458 of file ofxsParam.h.

Constructor & Destructor Documentation

OFX::RGBAParam::RGBAParam ( void  ) [inline, private]

Definition at line 1462 of file ofxsParam.h.

OFX::RGBAParam::RGBAParam ( const ParamSet *  paramSet,
const std::string &  name,
OfxParamHandle  handle 
) [protected]

hidden constructor

Definition at line 1992 of file ofxsParams.cpp.

Member Function Documentation

void OFX::RGBAParam::getDefault ( double &  r,
double &  g,
double &  b,
double &  a 
) const

get default value

het the default value

Definition at line 2006 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropDefault, and OFX::PropertySet::propGetDouble().

Here is the call graph for this function:

OfxRGBAColourD OFX::RGBAParam::getDefault ( void  ) const [inline]

Definition at line 1476 of file ofxsParam.h.

References OfxRGBAColourD::a, OfxRGBAColourD::b, OfxRGBAColourD::g, getDefault(), and OfxRGBAColourD::r.

Referenced by getDefault().

Here is the call graph for this function:

void OFX::RGBAParam::getValue ( double &  r,
double &  g,
double &  b,
double &  a 
) const

get value

Definition at line 2015 of file ofxsParams.cpp.

References OFX::Param::_paramHandle, OFX::Private::gParamSuite, OfxParameterSuiteV1::paramGetValue, and OFX::throwSuiteStatusException().

Referenced by tuttle::plugin::interact::ColorRGBAParam::getColor(), tuttle::plugin::colorTransform::ColorTransformPlugin::getProcessParams(), tuttle::plugin::fade::FadePlugin::getProcessParams(), tuttle::plugin::crop::CropPlugin::getProcessParams(), tuttle::plugin::normalize::NormalizePlugin::getProcessParams(), tuttle::plugin::text::TextPlugin::getProcessParams(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::updateGeodesicForms(), tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::updateGeodesicForms(), tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::updateProcessGeodesicForms(), and tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::updateProcessGeodesicForms().

Here is the call graph for this function:

OfxRGBAColourD OFX::RGBAParam::getValue ( void  ) const [inline]

Definition at line 1480 of file ofxsParam.h.

References OfxRGBAColourD::a, OfxRGBAColourD::b, OfxRGBAColourD::g, getValue(), and OfxRGBAColourD::r.

Referenced by getValue().

Here is the call graph for this function:

void OFX::RGBAParam::getValueAtTime ( double  t,
double &  r,
double &  g,
double &  b,
double &  a 
) const

get the value at a time

Definition at line 2023 of file ofxsParams.cpp.

References OFX::Param::_paramHandle, OFX::Private::gParamSuite, OfxParameterSuiteV1::paramGetValueAtTime, and OFX::throwSuiteStatusException().

Here is the call graph for this function:

OfxRGBAColourD OFX::RGBAParam::getValueAtTime ( double  t) const [inline]

Definition at line 1484 of file ofxsParam.h.

References OfxRGBAColourD::a, OfxRGBAColourD::b, OfxRGBAColourD::g, getValueAtTime(), and OfxRGBAColourD::r.

Referenced by getValueAtTime().

Here is the call graph for this function:

OFX::RGBAParam::mDeclareProtectedAssignAndCC ( RGBAParam  ) [private]
void OFX::RGBAParam::setDefault ( double  r,
double  g,
double  b,
double  a 
)

set the default value, default is 0

set the default value

Definition at line 1997 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropDefault, and OFX::PropertySet::propSetDouble().

Here is the call graph for this function:

void OFX::RGBAParam::setValue ( double  r,
double  g,
double  b,
double  a 
)

set value

Definition at line 2031 of file ofxsParams.cpp.

References OFX::Param::_paramHandle, OFX::Private::gParamSuite, OfxParameterSuiteV1::paramSetValue, and OFX::throwSuiteStatusException().

Referenced by tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::changedParam(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::changedParam(), tuttle::plugin::set0123ParamValues(), tuttle::plugin::set012ParamValues(), tuttle::plugin::av::AVOptionPlugin< IOPlugin >::setParameters(), tuttle::plugin::setRGBAParamValues(), and tuttle::plugin::setRGBParamValues().

Here is the call graph for this function:

void OFX::RGBAParam::setValueAtTime ( double  t,
double  r,
double  g,
double  b,
double  a 
)

set the value at a time, implicitly adds a keyframe

Definition at line 2039 of file ofxsParams.cpp.

References OFX::Param::_paramHandle, OFX::Private::gParamSuite, OfxParameterSuiteV1::paramSetValueAtTime, OFX::throwHostMissingSuiteException(), and OFX::throwSuiteStatusException().

Referenced by tuttle::plugin::set0123ParamValuesAtTime(), tuttle::plugin::set012ParamValuesAtTime(), tuttle::plugin::setRGBAParamValuesAtTime(), and tuttle::plugin::setRGBParamValuesAtTime().

Here is the call graph for this function:

Friends And Related Function Documentation

friend class ParamSet [friend]

Reimplemented from OFX::ValueParam.

Definition at line 1468 of file ofxsParam.h.

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