OFX::DoubleParam Class Reference

#include <ofxsParam.h>

Inheritance diagram for OFX::DoubleParam:

List of all members.

---

Detailed Description

Wraps up an doubleeger param.

Public Member Functions
void	setDefault (double v)
	set the default value
void	setShowTimeMarker (bool v)
	if the double type is Absolute time, show a time marker on the time line if possible
void	setRange (double min, double max)
	set the hard min/max range, default is DOUBLE_MIN, DOUBLE_MAX
void	setDisplayRange (double min, double max)
	set the display min and max, default is to be the same as the range param
void	getDefault (double &v)
	het the default value
double	getDefault (void)
	het the default value
void	getRange (double &min, double &max)
	set the hard min/max range, default is DOUBLE_MIN, DOUBLE_MAX
void	getDisplayRange (double &min, double &max)
	set the display min and max, default is to be the same as the range param
void	getValue (double &v)
	get value
double	getValue (void)
	get value
void	getValueAtTime (double t, double &v)
	get the value at a time
double	getValueAtTime (double t)
	get value
void	setValue (double v)
	set value
void	setValueAtTime (double t, double v)
	set the value at a time, implicitly adds a keyframe
void	differentiate (double t, double &v)
	get the value at a time
double	differentiate (double t)
	differentiate the param
void	integrate (double t1, double t2, double &v)
	get the value at a time
double	integrate (double t1, double t2)
	integrate the param
Protected Member Functions
	mDeclareProtectedAssignAndCC (DoubleParam)
	DoubleParam (void)
	DoubleParam (const ParamSet *paramSet, const std::string &name, OfxParamHandle handle)
	hidden constructor
Friends
class	ParamSet

---

Constructor & Destructor Documentation

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

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

hidden constructor

---

Member Function Documentation

double OFX::DoubleParam::differentiate (  double  t  )  [inline]

differentiate the param

void OFX::DoubleParam::differentiate (  double  t, double &  v )

get the value at a time

double OFX::DoubleParam::getDefault (  void   )  [inline]

het the default value

void OFX::DoubleParam::getDefault (  double &  v  )

het the default value

void OFX::DoubleParam::getDisplayRange (  double &  min, double &  max )

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

void OFX::DoubleParam::getRange (  double &  min, double &  max )

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

double OFX::DoubleParam::getValue (  void   )  [inline]

get value

void OFX::DoubleParam::getValue (  double &  v  )

get value

double OFX::DoubleParam::getValueAtTime (  double  t  )  [inline]

get value

void OFX::DoubleParam::getValueAtTime (  double  t, double &  v )

get the value at a time

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

integrate the param

void OFX::DoubleParam::integrate (  double  t1, double  t2, double &  v )

get the value at a time

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

void OFX::DoubleParam::setDefault (  double  v  )

set the default value

void OFX::DoubleParam::setDisplayRange (  double  min, double  max )

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

void OFX::DoubleParam::setRange (  double  min, double  max )

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

void OFX::DoubleParam::setShowTimeMarker (  bool  v  )

if the double type is Absolute time, show a time marker on the time line if possible

void OFX::DoubleParam::setValue (  double  v  )

set value

void OFX::DoubleParam::setValueAtTime (  double  t, double  v )

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

---