tuttle::host::ofx::attribute::OfxhParamGroup Class Reference

#include <OfxhParamGroup.hpp>

Inheritance diagram for tuttle::host::ofx::attribute::OfxhParamGroup:

Collaboration diagram for tuttle::host::ofx::attribute::OfxhParamGroup:

Public Member Functions
	OfxhParamGroup (const OfxhParamDescriptor &descriptor, const std::string &name, OfxhParamSet &setInstance)
virtual	~OfxhParamGroup ()
void	deleteChildrens ()
void	setChildrens (const OfxhParamSet *childrens)
OfxhParamSet *	getChildrens () const
void	addChildren (OfxhParam *children)
property::OfxhSet &	getParamSetProps ()
virtual OfxhParam *	newParam (const OfxhParamDescriptor &descriptor) OFX_EXCEPTION_SPEC
virtual void	paramChanged (const attribute::OfxhParam &param, const EChange change)
virtual void	editBegin (const std::string &name) OFX_EXCEPTION_SPEC
	Triggered when the plug-in calls OfxParameterSuiteV1::paramEditBegin.
virtual void	editEnd () OFX_EXCEPTION_SPEC
	Triggered when the plug-in calls OfxParameterSuiteV1::paramEditEnd.
bool	paramTypeHasData () const
std::size_t	getHashAtTime (const OfxTime time) const

---

Detailed Description

Definition at line 13 of file OfxhParamGroup.hpp.

---

Constructor & Destructor Documentation

tuttle::host::ofx::attribute::OfxhParamGroup::OfxhParamGroup	(	const OfxhParamDescriptor &	descriptor,
		const std::string &	name,
		OfxhParamSet &	setInstance
	)		[inline]

Definition at line 18 of file OfxhParamGroup.hpp.

virtual tuttle::host::ofx::attribute::OfxhParamGroup::~OfxhParamGroup

(

)

[inline, virtual]

Definition at line 19 of file OfxhParamGroup.hpp.

---

Member Function Documentation

void tuttle::host::ofx::attribute::OfxhParamGroup::addChildren

(

OfxhParam *

children

)

Definition at line 24 of file OfxhParamGroup.cpp.

References tuttle::host::ofx::attribute::OfxhParamSet::_paramVector, and tuttle::host::ofx::attribute::OfxhParam::setParamSetInstance().

Here is the call graph for this function:

void tuttle::host::ofx::attribute::OfxhParamGroup::deleteChildrens

(

)

[inline]

Definition at line 21 of file OfxhParamGroup.hpp.

References tuttle::host::ofx::attribute::OfxhParamSet::_paramVector.

Referenced by setChildrens().

virtual void tuttle::host::ofx::attribute::OfxhParamGroup::editBegin

(

const std::string &

name

)

[inline, virtual]

Triggered when the plug-in calls OfxParameterSuiteV1::paramEditBegin.

Implements tuttle::host::ofx::attribute::OfxhParamSet.

Definition at line 49 of file OfxhParamGroup.hpp.

References tuttle::host::ofx::attribute::OfxhParam::_paramSetInstance, and tuttle::host::ofx::attribute::OfxhParamSet::editBegin().

Here is the call graph for this function:

virtual void tuttle::host::ofx::attribute::OfxhParamGroup::editEnd

(

)

[inline, virtual]

Triggered when the plug-in calls OfxParameterSuiteV1::paramEditEnd.

Implements tuttle::host::ofx::attribute::OfxhParamSet.

Definition at line 55 of file OfxhParamGroup.hpp.

References tuttle::host::ofx::attribute::OfxhParam::_paramSetInstance, and tuttle::host::ofx::attribute::OfxhParamSet::editEnd().

Here is the call graph for this function:

OfxhParamSet * tuttle::host::ofx::attribute::OfxhParamGroup::getChildrens

(

)

const

Definition at line 30 of file OfxhParamGroup.cpp.

std::size_t tuttle::host::ofx::attribute::OfxhParamGroup::getHashAtTime

(

const OfxTime

time

)

const [inline, virtual]

Implements tuttle::host::ofx::attribute::OfxhParam.

Definition at line 62 of file OfxhParamGroup.hpp.

property::OfxhSet& tuttle::host::ofx::attribute::OfxhParamGroup::getParamSetProps

(

)

[inline, virtual]

get the property handle that lives with the set The plugin descriptor/instance that derives from this will provide this.

Implements tuttle::host::ofx::attribute::OfxhParamSetAccessor.

Definition at line 30 of file OfxhParamGroup.hpp.

References tuttle::host::ofx::attribute::OfxhParam::_paramSetInstance, and tuttle::host::ofx::attribute::OfxhParamSetAccessor::getParamSetProps().

Here is the call graph for this function:

virtual OfxhParam* tuttle::host::ofx::attribute::OfxhParamGroup::newParam

(

const OfxhParamDescriptor &

Descriptor

)

[inline, virtual]

make a parameter instance

Client host code needs to implement this

Implements tuttle::host::ofx::attribute::OfxhParamSet.

Definition at line 35 of file OfxhParamGroup.hpp.

virtual void tuttle::host::ofx::attribute::OfxhParamGroup::paramChanged	(	const attribute::OfxhParam &	param,
		const EChange	change
	)		[inline, virtual]

The inheriting plugin instance needs to set this up to deal with plug-ins changing their own values.

Implements tuttle::host::ofx::attribute::OfxhParamSet.

Definition at line 43 of file OfxhParamGroup.hpp.

References tuttle::host::ofx::attribute::OfxhParam::_paramSetInstance, and tuttle::host::ofx::attribute::OfxhParamSet::paramChanged().

Here is the call graph for this function:

bool tuttle::host::ofx::attribute::OfxhParamGroup::paramTypeHasData

(

)

const [inline, virtual]

Implements tuttle::host::ofx::attribute::OfxhParam.

Definition at line 60 of file OfxhParamGroup.hpp.

void tuttle::host::ofx::attribute::OfxhParamGroup::setChildrens

(

const OfxhParamSet *

childrens

)

setChildrens have to clone each source instance recursively

Todo:

tuttle: use clone ?

Definition at line 11 of file OfxhParamGroup.cpp.

References tuttle::host::ofx::attribute::OfxhParamSet::_paramVector, deleteChildrens(), and tuttle::host::ofx::attribute::OfxhParamSet::getParamVector().

Here is the call graph for this function:

---

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

• libraries/tuttle/src/tuttle/host/ofx/attribute/OfxhParamGroup.hpp
• libraries/tuttle/src/tuttle/host/ofx/attribute/OfxhParamGroup.cpp