TuttleOFX: OFX::Int2DParam Class Reference

TuttleOFX 1

Wraps up an integer param. More...

#include <ofxsParam.h>

Inheritance diagram for OFX::Int2DParam:

Inheritance graph

Collaboration diagram for OFX::Int2DParam:

Collaboration graph

Public Member Functions
void	setDefault (int x, int y)
	set the default value, default is 0
void	setDefault (const OfxPointI &v)
	set the default value, default is 0
void	setRange (int minX, int minY, int maxX, int maxY)
	set the hard min/max range, default is INT_MIN, INT_MAX
void	setDisplayRange (int minX, int minY, int maxX, int maxY)
	set the display min and max, default is to be the same as the range param
void	getDefault (int &x, int &y) const
	het the default value
OfxPointI	getDefault (void) const
	get the default value
void	getRange (int &minX, int &minY, int &maxX, int &maxY) const
	set the hard min/max range, default is INT_MIN, INT_MAX
void	getDisplayRange (int &minX, int &minY, int &maxX, int &maxY) const
	set the display min and max, default is to be the same as the range param
void	getValue (int &x, int &y) const
	get value
OfxPointI	getValue (void) const
	get the value
void	getValueAtTime (double t, int &x, int &y) const
	get the value at a time
OfxPointI	getValueAtTime (double t) const
	get the value
void	setValue (int x, int y)
	set value
void	setValue (const OfxPointI &v)
	set the current value
void	setValueAtTime (double t, int x, int y)
	set the value at a time, implicitly adds a keyframe
void	setValueAtTime (double t, const OfxPointI &v)
	set the current value
Protected Member Functions
	Int2DParam (const ParamSet *paramSet, const std::string &name, OfxParamHandle handle)
	hidden constructor
Private Member Functions
	mDeclareProtectedAssignAndCC (Int2DParam)
	Int2DParam (void)
Friends
class	ParamSet

Detailed Description

Wraps up an integer param.

Definition at line 1065 of file ofxsParam.h.

Constructor & Destructor Documentation

OFX::Int2DParam::Int2DParam ( void ) [inline, private]

Definition at line 1069 of file ofxsParam.h.

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

hidden constructor

Definition at line 1336 of file ofxsParams.cpp.

Member Function Documentation

void OFX::Int2DParam::getDefault	(	int &	x,
		int &	y
	)		const

het the default value

Definition at line 1368 of file ofxsParams.cpp.

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

Here is the call graph for this function:

OfxPointI OFX::Int2DParam::getDefault ( void ) const [inline]

get the default value

Definition at line 1096 of file ofxsParam.h.

References getDefault(), OfxPointI::x, and OfxPointI::y.

Referenced by getDefault().

Here is the call graph for this function:

void OFX::Int2DParam::getDisplayRange	(	int &	minX,
		int &	minY,
		int &	maxX,
		int &	maxY
	)		const

set the display min and max, default is to be the same as the range param

Definition at line 1385 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Int2DParam::getRange	(	int &	minX,
		int &	minY,
		int &	maxX,
		int &	maxY
	)		const

set the hard min/max range, default is INT_MIN, INT_MAX

Definition at line 1375 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Int2DParam::getValue	(	int &	x,
		int &	y
	)		const

get value

Definition at line 1395 of file ofxsParams.cpp.

References OFX::Param::_paramHandle, OFX::Private::gParamSuite, OfxParameterSuiteV1::paramGetValue, and OFX::throwSuiteStatusException().

Referenced by tuttle::plugin::GeneratorPlugin::changedParam(), tuttle::plugin::swscale::SwscalePlugin::changedParam(), tuttle::plugin::resize::ResizePlugin::changedParam(), tuttle::plugin::convolution::ConvolutionPlugin::changedParam(), tuttle::plugin::print::PrintPlugin::getProcessParams(), tuttle::plugin::merge::MergePlugin::getProcessParams(), tuttle::plugin::convolution::ConvolutionPlugin::getProcessParams(), tuttle::plugin::GeneratorPlugin::getRegionOfDefinition(), tuttle::plugin::swscale::SwscalePlugin::getRegionOfDefinition(), tuttle::plugin::resize::ResizePlugin::getRegionOfDefinition(), tuttle::plugin::convolution::ConvolutionPlugin::getRegionsOfInterest(), tuttle::plugin::convolution::ConvolutionPlugin::isIdentity(), and tuttle::plugin::av::AVOptionPlugin< IOPlugin >::setParameters().

Here is the call graph for this function:

OfxPointI OFX::Int2DParam::getValue ( void ) const [inline]

get the value

Definition at line 1110 of file ofxsParam.h.

References getValue(), OfxPointI::x, and OfxPointI::y.

Referenced by getValue().

Here is the call graph for this function:

void OFX::Int2DParam::getValueAtTime	(	double	t,
		int &	x,
		int &	y
	)		const

get the value at a time

Definition at line 1403 of file ofxsParams.cpp.

References OFX::Param::_paramHandle, OFX::Private::gParamSuite, OfxParameterSuiteV1::paramGetValueAtTime, and OFX::throwSuiteStatusException().

Referenced by tuttle::plugin::inputBuffer::InputBufferPlugin::getProcessParams(), and tuttle::plugin::inputBuffer::InputBufferPlugin::getRegionOfDefinition().

Here is the call graph for this function:

OfxPointI OFX::Int2DParam::getValueAtTime ( double t ) const [inline]

get the value

Definition at line 1116 of file ofxsParam.h.

References getValueAtTime(), OfxPointI::x, and OfxPointI::y.

Referenced by getValueAtTime().

Here is the call graph for this function:

OFX::Int2DParam::mDeclareProtectedAssignAndCC ( Int2DParam ) [private]

void OFX::Int2DParam::setDefault	(	int	x,
		int	y
	)

set the default value, default is 0

set the default value

Definition at line 1341 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Int2DParam::setDefault ( const OfxPointI & v ) [inline]

set the default value, default is 0

Definition at line 1082 of file ofxsParam.h.

References setDefault(), OfxPointI::x, and OfxPointI::y.

Referenced by setDefault().

Here is the call graph for this function:

void OFX::Int2DParam::setDisplayRange	(	int	minX,
		int	minY,
		int	maxX,
		int	maxY
	)

set the display min and max, default is to be the same as the range param

Definition at line 1358 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Int2DParam::setRange	(	int	minX,
		int	minY,
		int	maxX,
		int	maxY
	)

set the hard min/max range, default is INT_MIN, INT_MAX

Definition at line 1348 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Int2DParam::setValue	(	int	x,
		int	y
	)

set value

Definition at line 1411 of file ofxsParams.cpp.

References OFX::Param::_paramHandle, OFX::Private::gParamSuite, OfxParameterSuiteV1::paramSetValue, and OFX::throwSuiteStatusException().

Referenced by tuttle::plugin::convolution::ConvolutionPlugin::changedParam(), and tuttle::plugin::av::AVOptionPlugin< IOPlugin >::setParameters().

Here is the call graph for this function:

void OFX::Int2DParam::setValue ( const OfxPointI & v ) [inline]

set the current value

Definition at line 1122 of file ofxsParam.h.

References setValue(), OfxPointI::x, and OfxPointI::y.

Referenced by setValue().

Here is the call graph for this function:

void OFX::Int2DParam::setValueAtTime	(	double	t,
		int	x,
		int	y
	)

set the value at a time, implicitly adds a keyframe

Definition at line 1419 of file ofxsParams.cpp.

References OFX::Param::_paramHandle, OFX::Private::gParamSuite, OfxParameterSuiteV1::paramSetValueAtTime, OFX::throwHostMissingSuiteException(), and OFX::throwSuiteStatusException().

Here is the call graph for this function:

void OFX::Int2DParam::setValueAtTime	(	double	t,
		const OfxPointI &	v
	)		`[inline]`

set the current value

Definition at line 1128 of file ofxsParam.h.

References setValueAtTime(), OfxPointI::x, and OfxPointI::y.

Referenced by setValueAtTime().

Here is the call graph for this function:

Friends And Related Function Documentation

friend class ParamSet [friend]

Reimplemented from OFX::ValueParam.

Definition at line 1075 of file ofxsParam.h.

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

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

OFX
Int2DParam

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

Generated by 1.7.5.1