tuttle::host::ofx::property::OfxhPropSpec Struct Reference

#include <OfxhSet.hpp>

Data Fields
const char *	name
	name of the property
EPropType	type
	type
int	dimension
	fixed dimension of the property, set to zero if variable dimension
bool	readonly
	is the property plug-in read only
const char *	defaultValue
	Default value as a string. Pointers are ignored and always null.

---

Detailed Description

A class that is used to initialize a property set. Feed in an array of these to a property and it will construct a bunch of properties. Terminate such an array with an empty (all zero) set.

Definition at line 44 of file OfxhSet.hpp.

---

Field Documentation

const char* tuttle::host::ofx::property::OfxhPropSpec::defaultValue

Default value as a string. Pointers are ignored and always null.

Definition at line 50 of file OfxhSet.hpp.

Referenced by tuttle::host::ofx::property::OfxhSet::createProperty(), tuttle::host::ofx::imageEffect::OfxhImageEffectNode::getFramesNeededAction(), and tuttle::host::ofx::imageEffect::OfxhImageEffectNode::getRegionOfInterestAction().

int tuttle::host::ofx::property::OfxhPropSpec::dimension

fixed dimension of the property, set to zero if variable dimension

Definition at line 48 of file OfxhSet.hpp.

Referenced by tuttle::host::ofx::property::OfxhSet::createProperty(), tuttle::host::ofx::imageEffect::OfxhImageEffectNode::getFramesNeededAction(), and tuttle::host::ofx::imageEffect::OfxhImageEffectNode::getRegionOfInterestAction().

const char* tuttle::host::ofx::property::OfxhPropSpec::name

name of the property

Definition at line 46 of file OfxhSet.hpp.

Referenced by tuttle::host::ofx::property::OfxhSet::addProperties(), tuttle::host::ofx::property::OfxhSet::createProperty(), tuttle::host::ofx::imageEffect::OfxhImageEffectNode::getFramesNeededAction(), tuttle::host::ofx::imageEffect::OfxhImageEffectNode::getRegionOfInterestAction(), and tuttle::host::ofx::imageEffect::OfxhImageEffectNode::initHook().

bool tuttle::host::ofx::property::OfxhPropSpec::readonly

is the property plug-in read only

Definition at line 49 of file OfxhSet.hpp.

Referenced by tuttle::host::ofx::property::OfxhSet::createProperty(), tuttle::host::ofx::imageEffect::OfxhImageEffectNode::getFramesNeededAction(), and tuttle::host::ofx::imageEffect::OfxhImageEffectNode::getRegionOfInterestAction().

EPropType tuttle::host::ofx::property::OfxhPropSpec::type

type

Definition at line 47 of file OfxhSet.hpp.

Referenced by tuttle::host::ofx::property::OfxhSet::createProperty(), tuttle::host::ofx::imageEffect::OfxhImageEffectNode::getFramesNeededAction(), tuttle::host::ofx::imageEffect::OfxhImageEffectNode::getRegionOfInterestAction(), and tuttle::host::ofx::imageEffect::OfxhImageEffectNode::initHook().

---

The documentation for this struct was generated from the following file:

• TuttleOFX/libraries/tuttle/src/tuttle/host/ofx/property/OfxhSet.hpp