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

Wraps up an doubleeger param. More...

#include <ofxsParam.h>

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

Public Member Functions

void setDefault (double x, double y, double z)
 set the default value, default is 0
void setRange (double minX, double minY, double minZ, double maxX, double maxY, double maxZ)
 set the hard min/max range, default is DOUBLE_MIN, DOUBLE_MAX
void setDisplayRange (double minX, double minY, double minZ, double maxX, double maxY, double maxZ)
 set the display min and max, default is to be the same as the range param
void getDefault (double &x, double &y, double &z) const
 het the default value
void getRange (double &minX, double &minY, double &minZ, double &maxX, double &maxY, double &maxZ) const
 set the hard min/max range, default is DOUBLE_MIN, DOUBLE_MAX
void getDisplayRange (double &minX, double &minY, double &minZ, double &maxX, double &maxY, double &maxZ) const
 set the display min and max, default is to be the same as the range param
void getValue (double &x, double &y, double &z) const
 get value
void getValueAtTime (double t, double &x, double &y, double &z) const
 get the value at a time
void setValue (double x, double y, double z)
 set value
void setValueAtTime (double t, double x, double y, double z)
 set the value at a time, implicitly adds a keyframe
void differentiate (double t, double &x, double &y, double &z) const
 differentiate the param
Ofx3DPointD differentiate (double t) const
 differentiate the param
void integrate (double t1, double t2, double &x, double &y, double &z) const
 integrate the param
Ofx3DPointD integrate (double t1, double t2) const
 integrate the param

Protected Member Functions

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

Private Member Functions

 mDeclareProtectedAssignAndCC (Double3DParam)
 Double3DParam (void)

Friends

class ParamSet

Detailed Description

Wraps up an doubleeger param.

Definition at line 1360 of file ofxsParam.h.

Constructor & Destructor Documentation

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

Definition at line 1364 of file ofxsParam.h.

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

hidden constructor

Definition at line 1814 of file ofxsParams.cpp.

Member Function Documentation

void OFX::Double3DParam::differentiate ( double  t,
double &  x,
double &  y,
double &  z 
) const

differentiate the param

get the value at a time

Definition at line 1916 of file ofxsParams.cpp.

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

Here is the call graph for this function:

Ofx3DPointD OFX::Double3DParam::differentiate ( double  t) const [inline]

differentiate the param

Definition at line 1411 of file ofxsParam.h.

References differentiate(), Ofx3DPointD::x, Ofx3DPointD::y, and Ofx3DPointD::z.

Referenced by differentiate().

Here is the call graph for this function:

void OFX::Double3DParam::getDefault ( double &  x,
double &  y,
double &  z 
) const

het the default value

Definition at line 1851 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Double3DParam::getDisplayRange ( double &  minX,
double &  minY,
double &  minZ,
double &  maxX,
double &  maxY,
double &  maxZ 
) const

set the display min and max, default is to be the same as the range param

Definition at line 1871 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Double3DParam::getRange ( double &  minX,
double &  minY,
double &  minZ,
double &  maxX,
double &  maxY,
double &  maxZ 
) const

set the hard min/max range, default is DOUBLE_MIN, DOUBLE_MAX

Definition at line 1859 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Double3DParam::getValue ( double &  x,
double &  y,
double &  z 
) const

get value

Definition at line 1883 of file ofxsParams.cpp.

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

Referenced by tuttle::plugin::pinning::PinningPlugin::getProcessParams().

Here is the call graph for this function:

void OFX::Double3DParam::getValueAtTime ( double  t,
double &  x,
double &  y,
double &  z 
) const

get the value at a time

Definition at line 1891 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Double3DParam::integrate ( double  t1,
double  t2,
double &  x,
double &  y,
double &  z 
) const

integrate the param

get the value at a time

Definition at line 1925 of file ofxsParams.cpp.

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

Here is the call graph for this function:

Ofx3DPointD OFX::Double3DParam::integrate ( double  t1,
double  t2 
) const [inline]

integrate the param

Definition at line 1417 of file ofxsParam.h.

References integrate(), Ofx3DPointD::x, Ofx3DPointD::y, and Ofx3DPointD::z.

Referenced by integrate().

Here is the call graph for this function:

OFX::Double3DParam::mDeclareProtectedAssignAndCC ( Double3DParam  ) [private]
void OFX::Double3DParam::setDefault ( double  x,
double  y,
double  z 
)

set the default value, default is 0

set the default value

Definition at line 1819 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Double3DParam::setDisplayRange ( double  minX,
double  minY,
double  minZ,
double  maxX,
double  maxY,
double  maxZ 
)

set the display min and max, default is to be the same as the range param

Definition at line 1839 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Double3DParam::setRange ( double  minX,
double  minY,
double  minZ,
double  maxX,
double  maxY,
double  maxZ 
)

set the hard min/max range, default is DOUBLE_MIN, DOUBLE_MAX

Definition at line 1827 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Double3DParam::setValue ( double  x,
double  y,
double  z 
)

set value

Definition at line 1899 of file ofxsParams.cpp.

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

Referenced by tuttle::plugin::pinning::PinningPlugin::changedParam(), tuttle::plugin::set012ParamValues(), tuttle::plugin::av::AVOptionPlugin< IOPlugin >::setParameters(), and tuttle::plugin::setRGBParamValues().

Here is the call graph for this function:

void OFX::Double3DParam::setValueAtTime ( double  t,
double  x,
double  y,
double  z 
)

set the value at a time, implicitly adds a keyframe

Definition at line 1907 of file ofxsParams.cpp.

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

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

Here is the call graph for this function:

Friends And Related Function Documentation

friend class ParamSet [friend]

Reimplemented from OFX::BaseDoubleParam.

Definition at line 1370 of file ofxsParam.h.

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