OFX::DoubleParamDescriptor Class Reference

Wraps up a double param. More...

#include <ofxsParam.h>

Inheritance diagram for OFX::DoubleParamDescriptor:

Collaboration diagram for OFX::DoubleParamDescriptor:

Public Member Functions
void	setShowTimeMarker (bool v)
	if the double type is Absolute time, show a time marker on the time line if possible
void	setDefault (double v)
	set the default value, default is 0
void	setRange (double min, double max)
	set the hard min/max range, default is INT_MIN, INT_MAX
void	setDisplayRange (double min, double max)
	set the display min and max, default is to be the same as the range param
Protected Member Functions
	mDeclareProtectedAssignAndCC (DoubleParamDescriptor)
	DoubleParamDescriptor (void)
	DoubleParamDescriptor (const std::string &name, OfxPropertySetHandle props)
	hidden constructor
Friends
class	ParamSetDescriptor

---

Detailed Description

Wraps up a double param.

Definition at line 435 of file ofxsParam.h.

---

Constructor & Destructor Documentation

OFX::DoubleParamDescriptor::DoubleParamDescriptor

(

void

)

[inline, protected]

Definition at line 439 of file ofxsParam.h.

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

hidden constructor

ctor

Definition at line 430 of file ofxsParams.cpp.

---

Member Function Documentation

OFX::DoubleParamDescriptor::mDeclareProtectedAssignAndCC

(

DoubleParamDescriptor

)

[protected]

void OFX::DoubleParamDescriptor::setDefault

(

double

v

)

set the default value, default is 0

Definition at line 435 of file ofxsParams.cpp.

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

Referenced by tuttle::plugin::av::addOptionsFromAVOption(), tuttle::plugin::describeGeneratorParamsInContext(), and tuttle::plugin::describeSamplerParamsInContext().

Here is the call graph for this function:

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

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

Definition at line 448 of file ofxsParams.cpp.

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

Referenced by tuttle::plugin::av::addOptionsFromAVOption(), tuttle::plugin::describeGeneratorParamsInContext(), and tuttle::plugin::describeSamplerParamsInContext().

Here is the call graph for this function:

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

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 441 of file ofxsParams.cpp.

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

Referenced by tuttle::plugin::av::addOptionsFromAVOption(), tuttle::plugin::describeGeneratorParamsInContext(), and tuttle::plugin::describeSamplerParamsInContext().

Here is the call graph for this function:

void OFX::DoubleParamDescriptor::setShowTimeMarker

(

bool

v

)

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

---

Friends And Related Function Documentation

friend class ParamSetDescriptor [friend]

Reimplemented from OFX::BaseDoubleParamDescriptor.

Definition at line 445 of file ofxsParam.h.

---

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

• libraries/openfxHack/Support/include/ofxsParam.h
• libraries/openfxHack/Support/Library/ofxsParams.cpp