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

Wraps up an 3d integer param. More...

#include <ofxsParam.h>

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

Public Member Functions

void setDimensionLabels (const std::string &x, const std::string &y, const std::string &z)
 set the dimension labels
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

Protected Member Functions

 mDeclareProtectedAssignAndCC (Int3DParamDescriptor)
 Int3DParamDescriptor (void)
 Int3DParamDescriptor (const std::string &name, OfxPropertySetHandle props)
 hidden constructor

Friends

class ParamSetDescriptor

Detailed Description

Wraps up an 3d integer param.

Definition at line 378 of file ofxsParam.h.

Constructor & Destructor Documentation

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

Definition at line 382 of file ofxsParam.h.

OFX::Int3DParamDescriptor::Int3DParamDescriptor ( const std::string &  name,
OfxPropertySetHandle  props 
) [protected]

hidden constructor

ctor

Definition at line 322 of file ofxsParams.cpp.

Member Function Documentation

OFX::Int3DParamDescriptor::mDeclareProtectedAssignAndCC ( Int3DParamDescriptor  ) [protected]
void OFX::Int3DParamDescriptor::setDefault ( int  x,
int  y,
int  z 
)

set the default value, default is 0

Definition at line 327 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Int3DParamDescriptor::setDimensionLabels ( const std::string &  x,
const std::string &  y,
const std::string &  z 
)

set the dimension labels

Definition at line 358 of file ofxsParams.cpp.

References OFX::ParamDescriptor::getProps(), kOfxParamPropDimensionLabel, and OFX::PropertySet::propSetString().

Here is the call graph for this function:

void OFX::Int3DParamDescriptor::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 347 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Int3DParamDescriptor::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 335 of file ofxsParams.cpp.

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

Here is the call graph for this function:

Friends And Related Function Documentation

friend class ParamSetDescriptor [friend]

Reimplemented from OFX::ValueParamDescriptor.

Definition at line 388 of file ofxsParam.h.

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