OFX::ParametricParamDescriptor Class Reference

Wraps up a push button param, not much to it at all. More...

#include <ofxsParam.h>

Inheritance diagram for OFX::ParametricParamDescriptor:

Collaboration diagram for OFX::ParametricParamDescriptor:

Public Member Functions
void	setDimension (const int dimension)
void	setRange (const double min, const double max)
void	setLabel (const std::string &label)
void	setDimensionLabel (const std::string &label, const int id)
void	setUIColour (const int id, const OfxRGBColourD &color)
void	addControlPoint (const int id, const OfxTime time, const double x, const double y, const bool addKey)
void	setIdentity (const int id)
void	setIdentity ()
void	setInteractDescriptor (ParamInteractWrap *desc)
Protected Member Functions
	mDeclareProtectedAssignAndCC (ParametricParamDescriptor)
	ParametricParamDescriptor (void)
	ParametricParamDescriptor (const std::string &name, OfxPropertySetHandle props)
	hidden constructor
void	setParamSet (ParamSetDescriptor &paramSet)
Protected Attributes
OfxParamHandle	_ofxParamHandle
ParamSetDescriptor *	_paramSet
std::auto_ptr< ParamInteractWrap >	_interact
Friends
class	ParamSetDescriptor

---

Detailed Description

Wraps up a push button param, not much to it at all.

Definition at line 680 of file ofxsParam.h.

---

Constructor & Destructor Documentation

OFX::ParametricParamDescriptor::ParametricParamDescriptor

(

void

)

[inline, protected]

Definition at line 684 of file ofxsParam.h.

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

hidden constructor

Definition at line 733 of file ofxsParams.cpp.

---

Member Function Documentation

void OFX::ParametricParamDescriptor::addControlPoint	(	const int	id,
		const OfxTime	time,
		const double	x,
		const double	y,
		const bool	addKey
	)

Definition at line 772 of file ofxsParams.cpp.

References _ofxParamHandle, OFX::Private::gParametricParameterSuite, and OfxParametricParameterSuiteV1::parametricParamAddControlPoint.

Referenced by setIdentity().

OFX::ParametricParamDescriptor::mDeclareProtectedAssignAndCC

(

ParametricParamDescriptor

)

[protected]

void OFX::ParametricParamDescriptor::setDimension

(

const int

dimension

)

Definition at line 750 of file ofxsParams.cpp.

References OFX::ParamDescriptor::getProps(), kOfxParamPropParametricDimension, and OFX::PropertySet::propSetInt().

Here is the call graph for this function:

void OFX::ParametricParamDescriptor::setDimensionLabel	(	const std::string &	label,
		const int	id
	)

Definition at line 760 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::ParametricParamDescriptor::setIdentity

(

const int

id

)

Definition at line 783 of file ofxsParams.cpp.

References addControlPoint().

Here is the call graph for this function:

void OFX::ParametricParamDescriptor::setIdentity

(

)

Definition at line 789 of file ofxsParams.cpp.

References OFX::ParamDescriptor::getProps(), kOfxParamPropParametricDimension, tuttle::plugin::histogram::nbCurves, and OFX::PropertySet::propGetInt().

Here is the call graph for this function:

void OFX::ParametricParamDescriptor::setInteractDescriptor

(

ParamInteractWrap *

desc

)

Definition at line 798 of file ofxsParams.cpp.

References _interact, OFX::ParamInteractWrap::getDescriptor(), OFX::ParamInteractWrap::getMainEntry(), OFX::ParamDescriptor::getName(), OFX::ParamDescriptor::getProps(), kOfxParamPropParametricInteractBackground, OFX::PropertySet::propSetPointer(), and OFX::ParamInteractDescriptor::setParamName().

Here is the call graph for this function:

void OFX::ParametricParamDescriptor::setLabel

(

const std::string &

label

)

Reimplemented from OFX::ParamDescriptor.

Definition at line 755 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::ParametricParamDescriptor::setParamSet

(

ParamSetDescriptor &

paramSet

)

[protected]

Definition at line 738 of file ofxsParams.cpp.

References _ofxParamHandle, _paramSet, OFX::ParamDescriptor::getName(), OFX::ParamSetDescriptor::getOfxParamSetHandle(), OFX::Private::gParamSuite, and OfxParameterSuiteV1::paramGetHandle.

Referenced by OFX::ParamSetDescriptor::defineParametricParam().

Here is the call graph for this function:

void OFX::ParametricParamDescriptor::setRange	(	const double	min,
		const double	max
	)

Definition at line 744 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::ParametricParamDescriptor::setUIColour	(	const int	id,
		const OfxRGBColourD &	color
	)

Definition at line 765 of file ofxsParams.cpp.

References OfxRGBColourD::b, OfxRGBColourD::g, OFX::ParamDescriptor::getProps(), kOfxParamPropParametricUIColour, OFX::PropertySet::propSetDouble(), and OfxRGBColourD::r.

Here is the call graph for this function:

---

Friends And Related Function Documentation

friend class ParamSetDescriptor [friend]

Reimplemented from OFX::ParamDescriptor.

Definition at line 695 of file ofxsParam.h.

---

Field Documentation

std::auto_ptr<ParamInteractWrap> OFX::ParametricParamDescriptor::_interact [protected]

Definition at line 692 of file ofxsParam.h.

Referenced by setInteractDescriptor().

OfxParamHandle OFX::ParametricParamDescriptor::_ofxParamHandle [protected]

Definition at line 690 of file ofxsParam.h.

Referenced by addControlPoint(), and setParamSet().

ParamSetDescriptor* OFX::ParametricParamDescriptor::_paramSet [protected]

Definition at line 691 of file ofxsParam.h.

Referenced by setParamSet().

---

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

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