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

Wraps up a value holding param. More...

#include <ofxsParam.h>

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

Public Member Functions

virtual ~ValueParam ()=0
 dtor
void setEvaluateOnChange (bool v)
 Set's whether the value of the param is significant (ie: affects the rendered image)
bool getIsAnimating (void) const
 is the param animating
bool getIsAutoKeying (void) const
 is the param animating
bool getIsPersistant (void) const
 is the param animating
bool getEvaluateOnChange (void) const
 Get's whether the value of the param is significant (ie: affects the rendered image)
CacheInvalidationEnum getCacheInvalidation (void) const
 Get's whether the value of the param is significant (ie: affects the rendered image)
unsigned int getNumKeys (void) const
 if the param is animating, the number of keys in it, otherwise 0
double getKeyTime (int nthKey) const
 get the time of the nth key, nth must be between 0 and getNumKeys-1
int getKeyIndex (double time, KeySearchEnum searchDir) const
 find the index of a key by a time
void deleteKeyAtTime (double time)
 deletes a key at the given time
void deleteAllKeys (void)
 delete all the keys

Protected Member Functions

 mDeclareProtectedAssignAndCC (ValueParam)
 ValueParam (void)
 ValueParam (const ParamSet *paramSet, const std::string &name, ParamTypeEnum type, OfxParamHandle handle)
 hidden constructor

Friends

class ParamSet

Detailed Description

Wraps up a value holding param.

Definition at line 957 of file ofxsParam.h.

Constructor & Destructor Documentation

OFX::ValueParam::ValueParam ( void  ) [inline, protected]

Definition at line 961 of file ofxsParam.h.

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

hidden constructor

Wraps up a value holding param.

Definition at line 1133 of file ofxsParams.cpp.

OFX::ValueParam::~ValueParam ( ) [pure virtual]

dtor

Definition at line 1138 of file ofxsParams.cpp.

Member Function Documentation

void OFX::ValueParam::deleteAllKeys ( void  )

delete all the keys

Definition at line 1243 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::ValueParam::deleteKeyAtTime ( double  time)

deletes a key at the given time

Definition at line 1232 of file ofxsParams.cpp.

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

Here is the call graph for this function:

CacheInvalidationEnum OFX::ValueParam::getCacheInvalidation ( void  ) const

Get's whether the value of the param is significant (ie: affects the rendered image)

Definition at line 1172 of file ofxsParams.cpp.

References OFX::eCacheInvalidateValueAll, OFX::eCacheInvalidateValueChange, OFX::eCacheInvalidateValueChangeToEnd, OFX::Attribute::getProps(), kOfxParamInvalidateValueChange, kOfxParamInvalidateValueChangeToEnd, kOfxParamPropCacheInvalidation, and OFX::PropertySet::propGetString().

Here is the call graph for this function:

bool OFX::ValueParam::getEvaluateOnChange ( void  ) const

Get's whether the value of the param is significant (ie: affects the rendered image)

Definition at line 1166 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropEvaluateOnChange, and OFX::PropertySet::propGetInt().

Here is the call graph for this function:

bool OFX::ValueParam::getIsAnimating ( void  ) const

is the param animating

Definition at line 1148 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropIsAnimating, and OFX::PropertySet::propGetInt().

Here is the call graph for this function:

bool OFX::ValueParam::getIsAutoKeying ( void  ) const

is the param animating

Definition at line 1154 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropIsAutoKeying, and OFX::PropertySet::propGetInt().

Here is the call graph for this function:

bool OFX::ValueParam::getIsPersistant ( void  ) const

is the param animating

Definition at line 1160 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropPersistant, and OFX::PropertySet::propGetInt().

Here is the call graph for this function:

int OFX::ValueParam::getKeyIndex ( double  time,
KeySearchEnum  searchDir 
) const

find the index of a key by a time

Definition at line 1211 of file ofxsParams.cpp.

References OFX::Param::_paramHandle, OFX::eKeySearchBackwards, OFX::eKeySearchNear, OFX::Private::gParamSuite, kOfxStatFailed, OfxParameterSuiteV1::paramGetKeyIndex, OFX::throwHostMissingSuiteException(), and OFX::throwSuiteStatusException().

Here is the call graph for this function:

double OFX::ValueParam::getKeyTime ( int  nthKey) const

get the time of the nth key, nth must be between 0 and getNumKeys-1

Definition at line 1196 of file ofxsParams.cpp.

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

Here is the call graph for this function:

unsigned int OFX::ValueParam::getNumKeys ( void  ) const

if the param is animating, the number of keys in it, otherwise 0

Definition at line 1185 of file ofxsParams.cpp.

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

Here is the call graph for this function:

OFX::ValueParam::mDeclareProtectedAssignAndCC ( ValueParam  ) [protected]
void OFX::ValueParam::setEvaluateOnChange ( bool  v)

Set's whether the value of the param is significant (ie: affects the rendered image)

Definition at line 1142 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropEvaluateOnChange, and OFX::PropertySet::propSetInt().

Here is the call graph for this function:

Friends And Related Function Documentation

friend class ParamSet [friend]

Reimplemented from OFX::Param.

Reimplemented in OFX::CustomParam, OFX::BooleanParam, OFX::ChoiceParam, OFX::StringParam, OFX::RGBAParam, OFX::RGBParam, OFX::Double3DParam, OFX::Double2DParam, OFX::DoubleParam, OFX::BaseDoubleParam, OFX::Int3DParam, OFX::Int2DParam, and OFX::IntParam.

Definition at line 967 of file ofxsParam.h.

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