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

Wraps up an integer param. More...

#include <ofxsParam.h>

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

Public Member Functions

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

Protected Member Functions

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

Private Member Functions

 mDeclareProtectedAssignAndCC (Int3DParam)
 Int3DParam (void)

Friends

class ParamSet

Detailed Description

Wraps up an integer param.

Definition at line 1133 of file ofxsParam.h.

Constructor & Destructor Documentation

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

Definition at line 1137 of file ofxsParam.h.

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

hidden constructor

Definition at line 1431 of file ofxsParams.cpp.

Member Function Documentation

void OFX::Int3DParam::getDefault ( int &  x,
int &  y,
int &  z 
) const

het the default value

Definition at line 1468 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Int3DParam::getDisplayRange ( int &  minX,
int &  minY,
int &  minZ,
int &  maxX,
int &  maxY,
int &  maxZ 
) const

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

Definition at line 1488 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Int3DParam::getRange ( int &  minX,
int &  minY,
int &  minZ,
int &  maxX,
int &  maxY,
int &  maxZ 
) const

set the hard min/max range, default is INT_MIN, INT_MAX

Definition at line 1476 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Int3DParam::getValue ( int &  x,
int &  y,
int &  z 
) const

get value

Definition at line 1500 of file ofxsParams.cpp.

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

Here is the call graph for this function:

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

get the value at a time

Definition at line 1508 of file ofxsParams.cpp.

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

Here is the call graph for this function:

OFX::Int3DParam::mDeclareProtectedAssignAndCC ( Int3DParam  ) [private]
void OFX::Int3DParam::setDefault ( int  x,
int  y,
int  z 
)

set the default value, default is 0

set the default value

Definition at line 1436 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Int3DParam::setDisplayRange ( int  minX,
int  minY,
int  minZ,
int  maxX,
int  maxY,
int  maxZ 
)

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

Definition at line 1456 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Int3DParam::setRange ( int  minX,
int  minY,
int  minZ,
int  maxX,
int  maxY,
int  maxZ 
)

set the hard min/max range, default is INT_MIN, INT_MAX

Definition at line 1444 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Int3DParam::setValue ( int  x,
int  y,
int  z 
)

set value

Definition at line 1516 of file ofxsParams.cpp.

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

Referenced by tuttle::plugin::av::AVOptionPlugin< IOPlugin >::setParameters().

Here is the call graph for this function:

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

set the value at a time, implicitly adds a keyframe

Definition at line 1524 of file ofxsParams.cpp.

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

Here is the call graph for this function:

Friends And Related Function Documentation

friend class ParamSet [friend]

Reimplemented from OFX::ValueParam.

Definition at line 1143 of file ofxsParam.h.

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