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

Wraps up a 3D double param. More...

#include <ofxsParam.h>

Inheritance diagram for OFX::Double3DParamDescriptor:
Inheritance graph
[legend]
Collaboration diagram for OFX::Double3DParamDescriptor:
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 (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 INT_MIN, INT_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

Protected Member Functions

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

Friends

class ParamSetDescriptor

Detailed Description

Wraps up a 3D double param.

Definition at line 494 of file ofxsParam.h.

Constructor & Destructor Documentation

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

Definition at line 498 of file ofxsParam.h.

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

hidden constructor

ctor

Definition at line 499 of file ofxsParams.cpp.

Member Function Documentation

OFX::Double3DParamDescriptor::mDeclareProtectedAssignAndCC ( Double3DParamDescriptor  ) [protected]
void OFX::Double3DParamDescriptor::setDefault ( double  x,
double  y,
double  z 
)

set the default value, default is 0

Definition at line 504 of file ofxsParams.cpp.

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

Here is the call graph for this function:

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

set the dimension labels

Definition at line 535 of file ofxsParams.cpp.

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

Here is the call graph for this function:

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

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

Here is the call graph for this function:

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

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

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

Definition at line 512 of file ofxsParams.cpp.

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

Here is the call graph for this function:

Friends And Related Function Documentation

friend class ParamSetDescriptor [friend]

Reimplemented from OFX::BaseDoubleParamDescriptor.

Definition at line 504 of file ofxsParam.h.

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