OFX::RGBParam Class Reference

Wraps up an RGB param. More...

#include <ofxsParam.h>

Inheritance diagram for OFX::RGBParam:

Collaboration diagram for OFX::RGBParam:

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

---

Detailed Description

Wraps up an RGB param.

Definition at line 1422 of file ofxsParam.h.

---

Constructor & Destructor Documentation

OFX::RGBParam::RGBParam

(

void

)

[inline, private]

Definition at line 1426 of file ofxsParam.h.

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

hidden constructor

Definition at line 1936 of file ofxsParams.cpp.

---

Member Function Documentation

void OFX::RGBParam::getDefault	(	double &	r,
		double &	g,
		double &	b
	)		const

get default value

het the default value

Definition at line 1949 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::RGBParam::getValue	(	double &	r,
		double &	g,
		double &	b
	)		const

get value

Definition at line 1957 of file ofxsParams.cpp.

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

Referenced by tuttle::plugin::warp::WarpOverlayInteract::draw(), tuttle::plugin::interact::ColorRGBParam::getColor(), and tuttle::plugin::anisotropicFilter::diffusion::AnisotropicDiffusionPlugin::getMargin().

Here is the call graph for this function:

OfxRGBColourD OFX::RGBParam::getValue

(

void

)

const [inline]

Definition at line 1443 of file ofxsParam.h.

References OfxRGBColourD::b, OfxRGBColourD::g, getValue(), and OfxRGBColourD::r.

Referenced by getValue().

Here is the call graph for this function:

void OFX::RGBParam::getValueAtTime	(	double	t,
		double &	r,
		double &	g,
		double &	b
	)		const

get the value at a time

Definition at line 1965 of file ofxsParams.cpp.

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

Here is the call graph for this function:

OfxRGBColourD OFX::RGBParam::getValueAtTime

(

double

t

)

const [inline]

Definition at line 1447 of file ofxsParam.h.

References OfxRGBColourD::b, OfxRGBColourD::g, getValueAtTime(), and OfxRGBColourD::r.

Referenced by getValueAtTime().

Here is the call graph for this function:

OFX::RGBParam::mDeclareProtectedAssignAndCC

(

RGBParam

)

[private]

void OFX::RGBParam::setDefault	(	double	r,
		double	g,
		double	b
	)

set the default value, default is 0

set the default value

Definition at line 1941 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::RGBParam::setValue	(	double	r,
		double	g,
		double	b
	)

set value

Definition at line 1973 of file ofxsParams.cpp.

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

Referenced by tuttle::plugin::set012ParamValues(), tuttle::plugin::av::AVOptionPlugin< IOPlugin >::setParameters(), and tuttle::plugin::setRGBParamValues().

Here is the call graph for this function:

void OFX::RGBParam::setValueAtTime	(	double	t,
		double	r,
		double	g,
		double	b
	)

set the value at a time, implicitly adds a keyframe

Definition at line 1981 of file ofxsParams.cpp.

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

Referenced by tuttle::plugin::set012ParamValuesAtTime(), and tuttle::plugin::setRGBParamValuesAtTime().

Here is the call graph for this function:

---

Friends And Related Function Documentation

friend class ParamSet [friend]

Reimplemented from OFX::ValueParam.

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