OFX::ValueParamDescriptor Class Reference

Wraps up a value holding param. More...

#include <ofxsParam.h>

Inheritance diagram for OFX::ValueParamDescriptor:

Collaboration diagram for OFX::ValueParamDescriptor:

Public Member Functions
virtual	~ValueParamDescriptor ()
	dtor
void	setAnimates (bool v)
	set whether the param can animate, defaults to true in most cases
void	setIsPersistant (bool v)
	set whether the param is persistant, defaults to true
void	setEvaluateOnChange (bool v)
	Set's whether the value of the param is significant (ie: affects the rendered image), defaults to true.
void	setCacheInvalidation (CacheInvalidationEnum v)
	Set's how any cache should be invalidated if the parameter is changed, defaults to eCacheInvalidateValueChange.
void	setCanUndo (bool v)
	Set whether the param should appear on any undo stack.
void	setInteractDescriptor (ParamInteractWrap *desc)
Protected Member Functions
	mDeclareProtectedAssignAndCC (ValueParamDescriptor)
	ValueParamDescriptor (void)
	ValueParamDescriptor (const std::string &name, ParamTypeEnum type, OfxPropertySetHandle props)
	hidden constructor
Protected Attributes
std::auto_ptr< ParamInteractWrap >	_interact
Friends
class	ParamSetDescriptor

---

Detailed Description

Wraps up a value holding param.

Definition at line 260 of file ofxsParam.h.

---

Constructor & Destructor Documentation

OFX::ValueParamDescriptor::ValueParamDescriptor

(

void

)

[inline, protected]

Definition at line 264 of file ofxsParam.h.

OFX::ValueParamDescriptor::ValueParamDescriptor	(	const std::string &	name,
		ParamTypeEnum	type,
		OfxPropertySetHandle	props
	)		[protected]

hidden constructor

ctor

Definition at line 191 of file ofxsParams.cpp.

OFX::ValueParamDescriptor::~ValueParamDescriptor

(

)

[virtual]

dtor

Definition at line 196 of file ofxsParams.cpp.

---

Member Function Documentation

OFX::ValueParamDescriptor::mDeclareProtectedAssignAndCC

(

ValueParamDescriptor

)

[protected]

void OFX::ValueParamDescriptor::setAnimates

(

bool

v

)

set whether the param can animate, defaults to true in most cases

Definition at line 200 of file ofxsParams.cpp.

References OFX::ParamDescriptor::getProps(), kOfxParamPropAnimates, and OFX::PropertySet::propSetInt().

Referenced by tuttle::plugin::describeGeneratorParamsInContext(), tuttle::plugin::describeReaderParamsInContext(), and tuttle::plugin::describeWriterParamsInContext().

Here is the call graph for this function:

void OFX::ValueParamDescriptor::setCacheInvalidation

(

CacheInvalidationEnum

v

)

Set's how any cache should be invalidated if the parameter is changed, defaults to eCacheInvalidateValueChange.

Definition at line 224 of file ofxsParams.cpp.

References OFX::eCacheInvalidateValueAll, OFX::eCacheInvalidateValueChange, OFX::eCacheInvalidateValueChangeToEnd, OFX::ParamDescriptor::getProps(), kOfxParamInvalidateAll, kOfxParamInvalidateValueChange, kOfxParamInvalidateValueChangeToEnd, kOfxParamPropCacheInvalidation, and OFX::PropertySet::propSetString().

Referenced by tuttle::plugin::describeGeneratorParamsInContext(), tuttle::plugin::describeReaderParamsInContext(), and tuttle::plugin::describeWriterParamsInContext().

Here is the call graph for this function:

void OFX::ValueParamDescriptor::setCanUndo

(

bool

v

)

Set whether the param should appear on any undo stack.

Set's whether the value of the param is significant (ie: affects the rendered image), defaults to true.

Definition at line 218 of file ofxsParams.cpp.

References OFX::ParamDescriptor::getProps(), kOfxParamPropCanUndo, and OFX::PropertySet::propSetInt().

Here is the call graph for this function:

void OFX::ValueParamDescriptor::setEvaluateOnChange

(

bool

v

)

Set's whether the value of the param is significant (ie: affects the rendered image), defaults to true.

Definition at line 212 of file ofxsParams.cpp.

References OFX::ParamDescriptor::getProps(), kOfxParamPropEvaluateOnChange, and OFX::PropertySet::propSetInt().

Referenced by tuttle::plugin::describeWriterParamsInContext().

Here is the call graph for this function:

void OFX::ValueParamDescriptor::setInteractDescriptor

(

ParamInteractWrap *

desc

)

Definition at line 242 of file ofxsParams.cpp.

References _interact, OFX::ParamInteractWrap::getDescriptor(), OFX::ParamInteractWrap::getMainEntry(), OFX::ParamDescriptor::getName(), OFX::ParamDescriptor::getProps(), kOfxParamPropInteractV1, OFX::PropertySet::propSetPointer(), and OFX::ParamInteractDescriptor::setParamName().

Here is the call graph for this function:

void OFX::ValueParamDescriptor::setIsPersistant

(

bool

v

)

set whether the param is persistant, defaults to true

Definition at line 206 of file ofxsParams.cpp.

References OFX::ParamDescriptor::getProps(), kOfxParamPropPersistant, and OFX::PropertySet::propSetInt().

Referenced by tuttle::plugin::describeWriterParamsInContext().

Here is the call graph for this function:

---

Friends And Related Function Documentation

friend class ParamSetDescriptor [friend]

Reimplemented from OFX::ParamDescriptor.

Reimplemented in OFX::CustomParamDescriptor, OFX::ChoiceParamDescriptor, OFX::BooleanParamDescriptor, OFX::RGBAParamDescriptor, OFX::RGBParamDescriptor, OFX::Double3DParamDescriptor, OFX::Double2DParamDescriptor, OFX::DoubleParamDescriptor, OFX::BaseDoubleParamDescriptor, OFX::Int3DParamDescriptor, OFX::Int2DParamDescriptor, OFX::IntParamDescriptor, and OFX::StringParamDescriptor.

Definition at line 270 of file ofxsParam.h.

---

Field Documentation

std::auto_ptr<ParamInteractWrap> OFX::ValueParamDescriptor::_interact [protected]

Definition at line 271 of file ofxsParam.h.

Referenced by setInteractDescriptor().

---

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

• libraries/openfxHack/Support/include/ofxsParam.h
• libraries/openfxHack/Support/Library/ofxsParams.cpp