#include <OfxhGetHook.hpp>

Inheritance diagram for tuttle::host::ofx::property::OfxhGetHook:

Public Member Functions
virtual	~OfxhGetHook ()
	dtor
template<class T >
T::ReturnType	getProperty (const std::string &name, int index=0) const OFX_EXCEPTION_SPEC
	this does some magic so that it calls get string/int/double/pointer appropriately
template<class T >
void	getPropertyN (const std::string &name, typename T::APIType *values, int count) const OFX_EXCEPTION_SPEC
virtual const std::string &	getStringProperty (const std::string &name, int index=0) const OFX_EXCEPTION_SPEC
	override this to fetch a single value at the given index.
virtual int	getIntProperty (const std::string &name, int index=0) const OFX_EXCEPTION_SPEC
	override this to fetch a single value at the given index.
virtual void	getIntPropertyN (const std::string &name, int *values, int count) const OFX_EXCEPTION_SPEC
	override this to fetch a multiple values in a multi-dimension property
virtual double	getDoubleProperty (const std::string &name, int index=0) const OFX_EXCEPTION_SPEC
	override this to fetch a single value at the given index.
virtual void	getDoublePropertyN (const std::string &name, double *values, int count) const OFX_EXCEPTION_SPEC
	override this to fetch a multiple values in a multi-dimension property
virtual void *	getPointerProperty (const std::string &name, int index=0) const OFX_EXCEPTION_SPEC
	override this to fetch a single value at the given index.
virtual void	getPointerPropertyN (const std::string &name, void **values, int count) const OFX_EXCEPTION_SPEC
	override this to fetch a multiple values in a multi-dimension property
virtual size_t	getDimension (const std::string &name) const OFX_EXCEPTION_SPEC
	override this to fetch the dimension size.
virtual void	reset (const std::string &name) OFX_EXCEPTION_SPEC
	override this to handle a reset().
template<>
void	getPropertyN (const std::string &name, int *values, int count) const OFX_EXCEPTION_SPEC
	this does some magic so that it calls get string/int/double/pointer appropriately
template<>
void	getPropertyN (const std::string &name, double *values, int count) const OFX_EXCEPTION_SPEC
	this does some magic so that it calls get string/int/double/pointer appropriately
template<>
void	getPropertyN (const std::string &name, void **values, int count) const OFX_EXCEPTION_SPEC
	this does some magic so that it calls get string/int/double/pointer appropriately

Detailed Description

Sits on a property and can override the local property value when a value is being fetched only one of these can be in any property (as the thing has only a single value). We deliberately don't have a getStringPropertyN as it is somewhat more painfull and never used in practice.

Definition at line 17 of file OfxhGetHook.hpp.

Constructor & Destructor Documentation

virtual tuttle::host::ofx::property::OfxhGetHook::~OfxhGetHook ( ) [inline, virtual]

dtor

Definition at line 21 of file OfxhGetHook.hpp.

Member Function Documentation

size_t tuttle::host::ofx::property::OfxhGetHook::getDimension ( const std::string & name ) const [virtual]

override this to fetch the dimension size.

Reimplemented in tuttle::host::ofx::imageEffect::OfxhImageEffectNode.

Definition at line 122 of file OfxhGetHook.cpp.

double tuttle::host::ofx::property::OfxhGetHook::getDoubleProperty	(	const std::string &	name,
		int	index = `0`
	)		const `[virtual]`

override this to fetch a single value at the given index.

Reimplemented in tuttle::host::ofx::imageEffect::OfxhImageEffectNode.

Definition at line 77 of file OfxhGetHook.cpp.

void tuttle::host::ofx::property::OfxhGetHook::getDoublePropertyN	(	const std::string &	name,
		double *	values,
		int	count
	)		const `[virtual]`

override this to fetch a multiple values in a multi-dimension property

Reimplemented in tuttle::host::ofx::imageEffect::OfxhImageEffectNode.

Definition at line 95 of file OfxhGetHook.cpp.

int tuttle::host::ofx::property::OfxhGetHook::getIntProperty	(	const std::string &	name,
		int	index = `0`
	)		const `[virtual]`

override this to fetch a single value at the given index.

Definition at line 68 of file OfxhGetHook.cpp.

void tuttle::host::ofx::property::OfxhGetHook::getIntPropertyN	(	const std::string &	name,
		int *	values,
		int	count
	)		const `[virtual]`

override this to fetch a multiple values in a multi-dimension property

Definition at line 104 of file OfxhGetHook.cpp.

void * tuttle::host::ofx::property::OfxhGetHook::getPointerProperty	(	const std::string &	name,
		int	index = `0`
	)		const `[virtual]`

override this to fetch a single value at the given index.

Definition at line 86 of file OfxhGetHook.cpp.

void tuttle::host::ofx::property::OfxhGetHook::getPointerPropertyN	(	const std::string &	name,
		void **	values,
		int	count
	)		const `[virtual]`

override this to fetch a multiple values in a multi-dimension property

Definition at line 113 of file OfxhGetHook.cpp.

const std::string & tuttle::host::ofx::property::OfxhGetHook::getProperty< OfxhStringValue >	(	const std::string &	name,
		int	index = `0`
	)		const

this does some magic so that it calls get string/int/double/pointer appropriately

We specialise this to do some magic so that it calls get string/int/double/pointer appropriately this is what is called by the propertytemplate code to fetch values out of a hook.

Definition at line 10 of file OfxhGetHook.cpp.

template<class T >

void tuttle::host::ofx::property::OfxhGetHook::getPropertyN	(	const std::string &	name,
		typename T::APIType *	values,
		int	count
	)		const

We specialise this to do some magic so that it calls get int/double/pointer appropriately this is what is called by the propertytemplate code to fetch values out of a hook.

template<>

void tuttle::host::ofx::property::OfxhGetHook::getPropertyN	(	const std::string &	name,
		int *	values,
		int	count
	)		const

this does some magic so that it calls get string/int/double/pointer appropriately

Definition at line 39 of file OfxhGetHook.cpp.

template<>

void tuttle::host::ofx::property::OfxhGetHook::getPropertyN	(	const std::string &	name,
		double *	values,
		int	count
	)		const

this does some magic so that it calls get string/int/double/pointer appropriately

Definition at line 46 of file OfxhGetHook.cpp.

template<>

void tuttle::host::ofx::property::OfxhGetHook::getPropertyN	(	const std::string &	name,
		void **	values,
		int	count
	)		const

this does some magic so that it calls get string/int/double/pointer appropriately

Definition at line 53 of file OfxhGetHook.cpp.

const std::string & tuttle::host::ofx::property::OfxhGetHook::getStringProperty	(	const std::string &	name,
		int	index = `0`
	)		const `[virtual]`

override this to fetch a single value at the given index.

override this to get a single value at the given index.

Definition at line 59 of file OfxhGetHook.cpp.

References tuttle::host::ofx::property::OfxhStringValue::kEmpty.

void tuttle::host::ofx::property::OfxhGetHook::reset ( const std::string & name ) [virtual]

override this to handle a reset().

Reimplemented in tuttle::host::ofx::imageEffect::OfxhImageEffectNode, tuttle::host::ofx::interact::OfxhInteract, and tuttle::host::ofx::attribute::OfxhClip.

Definition at line 131 of file OfxhGetHook.cpp.

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

TuttleOFX/libraries/tuttle/src/tuttle/host/ofx/property/OfxhGetHook.hpp
TuttleOFX/libraries/tuttle/src/tuttle/host/ofx/property/OfxhGetHook.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation