OFX::BaseDoubleParam Class Reference

Common base to all double param types. More...

#include <ofxsParam.h>

Inheritance diagram for OFX::BaseDoubleParam:

Collaboration diagram for OFX::BaseDoubleParam:

Public Member Functions
virtual	~BaseDoubleParam ()=0
void	setIncrement (double v)
	set the sensitivity of any gui slider
void	setDigits (int v)
	set the number of digits printed after a decimal point in any gui
void	getIncrement (double &v) const
	get the sensitivity of any gui slider
void	getDigits (int &v) const
	get the number of digits printed after a decimal point in any gui
void	getDoubleType (DoubleTypeEnum &v) const
	get the type of the double param
Protected Member Functions
	mDeclareProtectedAssignAndCC (BaseDoubleParam)
	BaseDoubleParam (void)
	BaseDoubleParam (const ParamSet *paramSet, const std::string &name, ParamTypeEnum type, OfxParamHandle handle)
	hidden constructor
Friends
class	ParamSet

---

Detailed Description

Common base to all double param types.

Definition at line 1183 of file ofxsParam.h.

---

Constructor & Destructor Documentation

OFX::BaseDoubleParam::BaseDoubleParam

(

void

)

[inline, protected]

Definition at line 1187 of file ofxsParam.h.

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

hidden constructor

Definition at line 1536 of file ofxsParams.cpp.

OFX::BaseDoubleParam::~BaseDoubleParam

(

)

[pure virtual]

Definition at line 1540 of file ofxsParams.cpp.

---

Member Function Documentation

void OFX::BaseDoubleParam::getDigits

(

int &

v

)

const

get the number of digits printed after a decimal point in any gui

set the number of digits printed after a decimal point in any gui

Definition at line 1562 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropDigits, and OFX::PropertySet::propGetInt().

Here is the call graph for this function:

void OFX::BaseDoubleParam::getDoubleType

(

DoubleTypeEnum &

v

)

const

get the type of the double param

set the number of digits printed after a decimal point in any gui

Definition at line 1568 of file ofxsParams.cpp.

References OFX::eDoubleTypeAbsoluteTime, OFX::eDoubleTypeAngle, OFX::eDoubleTypeNormalisedX, OFX::eDoubleTypeNormalisedXAbsolute, OFX::eDoubleTypeNormalisedXY, OFX::eDoubleTypeNormalisedXYAbsolute, OFX::eDoubleTypeNormalisedY, OFX::eDoubleTypeNormalisedYAbsolute, OFX::eDoubleTypePlain, OFX::eDoubleTypeScale, OFX::eDoubleTypeTime, OFX::Attribute::getProps(), kOfxParamDoubleTypeAbsoluteTime, kOfxParamDoubleTypeAngle, kOfxParamDoubleTypeNormalisedX, kOfxParamDoubleTypeNormalisedXAbsolute, kOfxParamDoubleTypeNormalisedXY, kOfxParamDoubleTypeNormalisedXYAbsolute, kOfxParamDoubleTypeNormalisedY, kOfxParamDoubleTypeNormalisedYAbsolute, kOfxParamDoubleTypePlain, kOfxParamDoubleTypeScale, kOfxParamDoubleTypeTime, kOfxParamPropDoubleType, and OFX::PropertySet::propGetString().

Here is the call graph for this function:

void OFX::BaseDoubleParam::getIncrement

(

double &

v

)

const

get the sensitivity of any gui slider

set the sensitivity of any gui slider

Definition at line 1556 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropIncrement, and OFX::PropertySet::propGetDouble().

Here is the call graph for this function:

OFX::BaseDoubleParam::mDeclareProtectedAssignAndCC

(

BaseDoubleParam

)

[protected]

void OFX::BaseDoubleParam::setDigits

(

int

v

)

set the number of digits printed after a decimal point in any gui

Definition at line 1550 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropDigits, and OFX::PropertySet::propSetInt().

Here is the call graph for this function:

void OFX::BaseDoubleParam::setIncrement

(

double

v

)

set the sensitivity of any gui slider

Definition at line 1544 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropIncrement, and OFX::PropertySet::propSetDouble().

Here is the call graph for this function:

---

Friends And Related Function Documentation

friend class ParamSet [friend]

Reimplemented from OFX::ValueParam.

Reimplemented in OFX::Double3DParam, OFX::Double2DParam, and OFX::DoubleParam.

Definition at line 1193 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