OFX::CustomParam Class Reference

Wraps up a custom param, not animation support yet. More...

#include <ofxsParam.h>

Inheritance diagram for OFX::CustomParam:

Collaboration diagram for OFX::CustomParam:

Public Member Functions
void	setDefault (const std::string &v)
	set the default value of the param
void	getDefault (std::string &v) const
	get the default value of the param
void	getValue (std::string &v) const
	get value
std::string	getValue () const
	get value
void	getValueAtTime (double t, std::string &v) const
	get the value at a time
std::string	getValueAtTime (double t) const
	get the value at a time
void	setValue (const std::string &v)
	set value
void	setValueAtTime (double t, const std::string &v)
	set the value at a time, implicitly adds a keyframe
Protected Member Functions
	CustomParam (const ParamSet *paramSet, const std::string &name, OfxParamHandle handle)
	hidden constructor
Private Member Functions
	mDeclareProtectedAssignAndCC (CustomParam)
	CustomParam (void)
Friends
class	ParamSet

---

Detailed Description

Wraps up a custom param, not animation support yet.

Definition at line 1663 of file ofxsParam.h.

---

Constructor & Destructor Documentation

OFX::CustomParam::CustomParam

(

void

)

[inline, private]

Definition at line 1667 of file ofxsParam.h.

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

hidden constructor

Definition at line 2269 of file ofxsParams.cpp.

---

Member Function Documentation

void OFX::CustomParam::getDefault

(

std::string &

v

)

const

get the default value of the param

het the default value

Definition at line 2280 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropDefault, and OFX::PropertySet::propGetString().

Here is the call graph for this function:

void OFX::CustomParam::getValue

(

std::string &

v

)

const

get value

Definition at line 2286 of file ofxsParams.cpp.

References OFX::Param::_paramHandle, OFX::Private::gParamSuite, OfxParameterSuiteV1::paramGetValue, and OFX::throwSuiteStatusException().

Here is the call graph for this function:

std::string OFX::CustomParam::getValue

(

void

)

const [inline]

get value

Definition at line 1687 of file ofxsParam.h.

References getValue().

Referenced by getValue().

Here is the call graph for this function:

void OFX::CustomParam::getValueAtTime	(	double	t,
		std::string &	v
	)		const

get the value at a time

Definition at line 2296 of file ofxsParams.cpp.

References OFX::Param::_paramHandle, OFX::Private::gParamSuite, OfxParameterSuiteV1::paramGetValueAtTime, and OFX::throwSuiteStatusException().

Here is the call graph for this function:

std::string OFX::CustomParam::getValueAtTime

(

double

t

)

const [inline]

get the value at a time

Definition at line 1693 of file ofxsParam.h.

References getValueAtTime().

Referenced by getValueAtTime().

Here is the call graph for this function:

OFX::CustomParam::mDeclareProtectedAssignAndCC

(

CustomParam

)

[private]

void OFX::CustomParam::setDefault

(

const std::string &

v

)

set the default value of the param

set the default value

Definition at line 2274 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropDefault, and OFX::PropertySet::propSetString().

Here is the call graph for this function:

void OFX::CustomParam::setValue

(

const std::string &

v

)

set value

Definition at line 2306 of file ofxsParams.cpp.

References OFX::Param::_paramHandle, OFX::Private::gParamSuite, OfxParameterSuiteV1::paramSetValue, and OFX::throwSuiteStatusException().

Here is the call graph for this function:

void OFX::CustomParam::setValueAtTime	(	double	t,
		const std::string &	v
	)

set the value at a time, implicitly adds a keyframe

Definition at line 2314 of file ofxsParams.cpp.

References OFX::Param::_paramHandle, OFX::Private::gParamSuite, OfxParameterSuiteV1::paramSetValueAtTime, OFX::throwHostMissingSuiteException(), and OFX::throwSuiteStatusException().

Here is the call graph for this function:

---

Friends And Related Function Documentation

friend class ParamSet [friend]

Reimplemented from OFX::ValueParam.

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