OFX::Double3DParam Class Reference

#include <ofxsParam.h>

Inheritance diagram for OFX::Double3DParam:

List of all members.

---

Detailed Description

Wraps up an doubleeger param.

Public Member Functions
void	setDefault (double x, double y, double z)
	set the default value
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)
	het the default value
void	getRange (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	getDisplayRange (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	getValue (double &x, double &y, double &z)
	get value
void	getValueAtTime (double t, double &x, double &y, double &z)
	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)
	get the value at a time
Ofx3DPointD	differentiate (double t)
	differentiate the param
void	integrate (double t1, double t2, double &x, double &y, double &z)
	get the value at a time
Ofx3DPointD	integrate (double t1, double t2)
	integrate the param
Protected Member Functions
	mDeclareProtectedAssignAndCC (Double3DParam)
	Double3DParam (void)
	Double3DParam (const ParamSet *paramSet, const std::string &name, OfxParamHandle handle)
	hidden constructor
Friends
class	ParamSet

---

Constructor & Destructor Documentation

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

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

hidden constructor

---

Member Function Documentation

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

differentiate the param

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

get the value at a time

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

het the default value

void OFX::Double3DParam::getDisplayRange (  double &  xmin, double &  ymin, double &  zmin, double &  xmax, double &  ymax, double &  zmax )

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

void OFX::Double3DParam::getRange (  double &  xmin, double &  ymin, double &  zmin, double &  xmax, double &  ymax, double &  zmax )

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

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

get value

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

get the value at a time

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

integrate the param

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

get the value at a time

OFX::Double3DParam::mDeclareProtectedAssignAndCC (  Double3DParam   )  [protected]

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

set the default value

void OFX::Double3DParam::setDisplayRange (  double  xmin, double  ymin, double  zmin, double  xmax, double  ymax, double  zmax )

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

void OFX::Double3DParam::setRange (  double  xmin, double  ymin, double  zmin, double  xmax, double  ymax, double  zmax )

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

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

set value

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

set the value at a time, implicitly adds a keyframe

---

Friends And Related Function Documentation

friend class ParamSet [friend]

Reimplemented from OFX::BaseDoubleParam.

---

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

• ofxsParam.h
• ofxsParams.cpp

---