TuttleOFX: OFX::Param Class Reference

TuttleOFX 1

Base class for all param instances. More...

#include <ofxsParam.h>

Inheritance diagram for OFX::Param:

Inheritance graph

Collaboration diagram for OFX::Param:

Collaboration graph

Public Member Functions
virtual	~Param ()=0
	dtor
void	setLabels (const std::string &label, const std::string &shortLabel, const std::string &longLabel)
	, set the label properties in a plugin
ParamTypeEnum	getParamType () const
	return the derived type of this parameter
void	setIsSecret (bool v)
	set the secretness of the param, defaults to false
void	setHint (const std::string &hint)
	set the param hint
void	setEnabled (bool v)
	whether the param is enabled
void	setIsSecretAndDisabled (bool v)
void	getLabels (std::string &label, std::string &shortLabel, std::string &longLabel) const
	fetch the labels
bool	getIsSecret (void) const
	get whether the param is secret
bool	getIsEnable (void) const
	whether the param is enabled
std::string	getHint (void) const
	get the param hint
std::string	getScriptName (void) const
	get the script name
const GroupParam *	getParent (void) const
	get the group param that is the parent of this one
Protected Member Functions
	Param ()
	Param (const ParamSet *paramSet, const std::string &name, ParamTypeEnum type, OfxParamHandle handle)
	hidden constructor
OfxParamHandle	getOfxHandle ()
Protected Attributes
ParamTypeEnum	_paramType
OfxParamHandle	_paramHandle
const ParamSet *	_paramSet
Private Member Functions
Param &	operator= (const Param &)
	Param (const Param &v)
Friends
class	ParamSet

Detailed Description

Base class for all param instances.

Definition at line 894 of file ofxsParam.h.

Constructor & Destructor Documentation

OFX::Param::Param ( const Param & v ) [inline, private]

Definition at line 899 of file ofxsParam.h.

OFX::Param::Param ( ) [inline, protected]

Definition at line 901 of file ofxsParam.h.

OFX::Param::Param	(	const ParamSet *	paramSet,
		const std::string &	name,
		ParamTypeEnum	type,
		OfxParamHandle	handle
	)		`[protected]`

hidden constructor

Base class for all param instances.

Definition at line 1032 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), OFX::Private::gParamSuite, OfxParameterSuiteV1::paramGetPropertySet, OFX::PropertySet::propSetHandle(), OFX::throwSuiteStatusException(), and OFX::Validation::validateParameterProperties().

Here is the call graph for this function:

OFX::Param::~Param ( ) [pure virtual]

dtor

Definition at line 1050 of file ofxsParams.cpp.

Member Function Documentation

std::string OFX::Param::getHint ( void ) const

get the param hint

Definition at line 1104 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropHint, and OFX::PropertySet::propGetString().

Here is the call graph for this function:

bool OFX::Param::getIsEnable ( void ) const

whether the param is enabled

Definition at line 1096 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropEnabled, and OFX::PropertySet::propGetInt().

Referenced by tuttle::plugin::interact::IsEnableParamFunctor< negate >::active(), and tuttle::plugin::lens::LensDistortPlugin::isIdentity().

Here is the call graph for this function:

bool OFX::Param::getIsSecret ( void ) const

get whether the param is secret

Definition at line 1088 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropSecret, and OFX::PropertySet::propGetInt().

Referenced by tuttle::plugin::interact::IsNotSecretParamFunctor< negate >::active().

Here is the call graph for this function:

void OFX::Param::getLabels	(	std::string &	label,
		std::string &	shortLabel,
		std::string &	longLabel
	)		const

fetch the labels

Definition at line 1080 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxPropLabel, kOfxPropLongLabel, kOfxPropShortLabel, and OFX::PropertySet::propGetString().

Here is the call graph for this function:

OfxParamHandle OFX::Param::getOfxHandle ( ) [inline, protected]

Definition at line 913 of file ofxsParam.h.

References _paramHandle.

Referenced by OFX::ParametricParam::addControlPoint(), OFX::ParametricParam::deleteControlPoint(), OFX::ParametricParam::getNControlPoints(), OFX::ParametricParam::getNthControlPoints(), OFX::ParametricParam::getValue(), and OFX::ParametricParam::setNthControlPoints().

ParamTypeEnum OFX::Param::getParamType ( ) const [inline]

return the derived type of this parameter

Definition at line 923 of file ofxsParam.h.

References _paramType.

const GroupParam * OFX::Param::getParent ( void ) const

get the group param that is the parent of this one

Definition at line 1120 of file ofxsParams.cpp.

References _paramSet, OFX::ParamSet::fetchGroupParam(), OFX::Attribute::getProps(), kOfxParamPropParent, and OFX::PropertySet::propGetString().

Here is the call graph for this function:

std::string OFX::Param::getScriptName ( void ) const

get the script name

Definition at line 1112 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropScriptName, and OFX::PropertySet::propGetString().

Here is the call graph for this function:

Param& OFX::Param::operator= ( const Param & ) [inline, private]

Definition at line 898 of file ofxsParam.h.

void OFX::Param::setEnabled ( bool v )

whether the param is enabled

Definition at line 1074 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropEnabled, and OFX::PropertySet::propSetInt().

Referenced by tuttle::plugin::jpeg2000::writer::Jpeg2000WriterPlugin::changedParam(), tuttle::plugin::colorSuppress::ColorSuppressPlugin::changedParam(), tuttle::plugin::crop::CropPlugin::changedParam(), tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::changedParam(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::changedParam(), tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::ColorCubeViewerPlugin(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::ColorSpaceKeyerPlugin(), and setIsSecretAndDisabled().

Here is the call graph for this function:

void OFX::Param::setHint ( const std::string & hint )

set the param hint

Definition at line 1068 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropHint, and OFX::PropertySet::propSetString().

Here is the call graph for this function:

void OFX::Param::setIsSecret ( bool v )

set the secretness of the param, defaults to false

Definition at line 1062 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropSecret, and OFX::PropertySet::propSetInt().

Referenced by tuttle::plugin::lens::LensDistortPlugin::changedParam(), and setIsSecretAndDisabled().

Here is the call graph for this function:

void OFX::Param::setIsSecretAndDisabled ( bool v ) [inline]

Definition at line 934 of file ofxsParam.h.

References setEnabled(), and setIsSecret().

Referenced by tuttle::plugin::SamplerPlugin::changedParam(), tuttle::plugin::gamma::GammaPlugin::changedParam(), tuttle::plugin::seExpr::SeExprPlugin::changedParam(), tuttle::plugin::av::reader::AVReaderPlugin::changedParam(), tuttle::plugin::crop::CropPlugin::changedParam(), tuttle::plugin::resize::ResizePlugin::changedParam(), tuttle::plugin::normalize::NormalizePlugin::changedParam(), tuttle::plugin::inputBuffer::InputBufferPlugin::changedParam(), tuttle::plugin::pinning::PinningPlugin::changedParam(), tuttle::plugin::av::writer::AVWriterPlugin::disableAVOptionsForCodecOrFormat(), tuttle::plugin::colorspace::ColorSpacePlugin::updateOutParams(), and tuttle::plugin::colorGradation::ColorGradationPlugin::updateParameters().

Here is the call graph for this function:

void OFX::Param::setLabels	(	const std::string &	label,
		const std::string &	shortLabel,
		const std::string &	longLabel
	)

, set the label properties in a plugin

Definition at line 1054 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxPropLabel, kOfxPropLongLabel, kOfxPropShortLabel, and OFX::PropertySet::propSetString().

Here is the call graph for this function:

Friends And Related Function Documentation

friend class ParamSet [friend]

Reimplemented in OFX::CameraParam, OFX::ParametricParam, OFX::PushButtonParam, OFX::CustomParam, OFX::PageParam, OFX::GroupParam, OFX::BooleanParam, OFX::ChoiceParam, OFX::StringParam, OFX::RGBAParam, OFX::RGBParam, OFX::Double3DParam, OFX::Double2DParam, OFX::DoubleParam, OFX::BaseDoubleParam, OFX::Int3DParam, OFX::Int2DParam, OFX::IntParam, and OFX::ValueParam.

Definition at line 911 of file ofxsParam.h.

Field Documentation

OfxParamHandle OFX::Param::_paramHandle [protected]

Definition at line 905 of file ofxsParam.h.

Referenced by OFX::ValueParam::deleteAllKeys(), OFX::ValueParam::deleteKeyAtTime(), OFX::DoubleParam::differentiate(), OFX::Double2DParam::differentiate(), OFX::Double3DParam::differentiate(), OFX::ValueParam::getKeyIndex(), OFX::ValueParam::getKeyTime(), OFX::ValueParam::getNumKeys(), getOfxHandle(), OFX::StringParam::getPointerValue(), OFX::StringParam::getPointerValueAtTime(), OFX::IntParam::getValue(), OFX::Int2DParam::getValue(), OFX::Int3DParam::getValue(), OFX::DoubleParam::getValue(), OFX::Double2DParam::getValue(), OFX::Double3DParam::getValue(), OFX::RGBParam::getValue(), OFX::RGBAParam::getValue(), OFX::ChoiceParam::getValue(), OFX::BooleanParam::getValue(), OFX::CustomParam::getValue(), OFX::IntParam::getValueAtTime(), OFX::Int2DParam::getValueAtTime(), OFX::Int3DParam::getValueAtTime(), OFX::DoubleParam::getValueAtTime(), OFX::Double2DParam::getValueAtTime(), OFX::Double3DParam::getValueAtTime(), OFX::RGBParam::getValueAtTime(), OFX::RGBAParam::getValueAtTime(), OFX::ChoiceParam::getValueAtTime(), OFX::BooleanParam::getValueAtTime(), OFX::CustomParam::getValueAtTime(), OFX::DoubleParam::integrate(), OFX::Double2DParam::integrate(), OFX::Double3DParam::integrate(), OFX::IntParam::setValue(), OFX::Int2DParam::setValue(), OFX::Int3DParam::setValue(), OFX::DoubleParam::setValue(), OFX::Double2DParam::setValue(), OFX::Double3DParam::setValue(), OFX::RGBParam::setValue(), OFX::RGBAParam::setValue(), OFX::StringParam::setValue(), OFX::ChoiceParam::setValue(), OFX::BooleanParam::setValue(), OFX::CustomParam::setValue(), OFX::IntParam::setValueAtTime(), OFX::Int2DParam::setValueAtTime(), OFX::Int3DParam::setValueAtTime(), OFX::DoubleParam::setValueAtTime(), OFX::Double2DParam::setValueAtTime(), OFX::Double3DParam::setValueAtTime(), OFX::RGBParam::setValueAtTime(), OFX::RGBAParam::setValueAtTime(), OFX::StringParam::setValueAtTime(), OFX::ChoiceParam::setValueAtTime(), OFX::BooleanParam::setValueAtTime(), and OFX::CustomParam::setValueAtTime().

const ParamSet* OFX::Param::_paramSet [protected]

Definition at line 906 of file ofxsParam.h.

Referenced by getParent().

ParamTypeEnum OFX::Param::_paramType [protected]

Definition at line 904 of file ofxsParam.h.

Referenced by getParamType().

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

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

OFX
Param

All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated by 1.7.5.1