TuttleOFX: OFX::Double2DParam Class Reference

TuttleOFX 1

Wraps up an doubleeger param. More...

#include <ofxsParam.h>

Inheritance diagram for OFX::Double2DParam:

Inheritance graph

Collaboration diagram for OFX::Double2DParam:

Collaboration graph

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

Detailed Description

Wraps up an doubleeger param.

Definition at line 1286 of file ofxsParam.h.

Constructor & Destructor Documentation

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

Definition at line 1290 of file ofxsParam.h.

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

hidden constructor

Definition at line 1701 of file ofxsParams.cpp.

Member Function Documentation

void OFX::Double2DParam::differentiate	(	double	t,
		double &	x,
		double &	y
	)		const

differentiate the param

get the value at a time

Definition at line 1793 of file ofxsParams.cpp.

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

Here is the call graph for this function:

OfxPointD OFX::Double2DParam::differentiate ( double t ) const [inline]

differentiate the param

Definition at line 1349 of file ofxsParam.h.

References differentiate(), OfxPointD::x, and OfxPointD::y.

Referenced by differentiate().

Here is the call graph for this function:

void OFX::Double2DParam::getDefault	(	double &	x,
		double &	y
	)		const

get the default value

het the default value

Definition at line 1733 of file ofxsParams.cpp.

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

Referenced by tuttle::plugin::lens::LensDistortPlugin::isIdentity().

Here is the call graph for this function:

OfxPointD OFX::Double2DParam::getDefault ( void ) const [inline]

get the default value

Definition at line 1314 of file ofxsParam.h.

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

Referenced by getDefault().

Here is the call graph for this function:

void OFX::Double2DParam::getDisplayRange	(	double &	minX,
		double &	minY,
		double &	maxX,
		double &	maxY
	)		const

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

Definition at line 1750 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Double2DParam::getRange	(	double &	minX,
		double &	minY,
		double &	maxX,
		double &	maxY
	)		const

set the hard min/max range, default is DOUBLE_MIN, DOUBLE_MAX

Definition at line 1740 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Double2DParam::getValue	(	double &	x,
		double &	y
	)		const

get value

Definition at line 1760 of file ofxsParams.cpp.

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

Referenced by tuttle::plugin::imageStatistics::ImageStatisticsPlugin::changedParam(), tuttle::plugin::pinning::PinningPlugin::changedParam(), tuttle::plugin::interact::clicDouble2D(), tuttle::plugin::lens::LensDistortOverlayInteract::draw(), tuttle::plugin::inputBuffer::InputBufferPlugin::getClipPreferences(), tuttle::plugin::interact::ParamPointRelativePoint< TFrame, coord >::getPoint(), tuttle::plugin::interact::ParamPoint< TFrame, CoordinateSystemNotCentered< coord >::value >::getPoint(), tuttle::plugin::interact::ParamRectangleFromTwoCorners< TFrame, coord >::getPoint(), tuttle::plugin::move2D::Move2DPlugin::getProcessParams(), tuttle::plugin::imageStatistics::ImageStatisticsPlugin::getProcessParams(), tuttle::plugin::seExpr::SeExprPlugin::getProcessParams(), tuttle::plugin::resize::ResizePlugin::getProcessParams(), tuttle::plugin::blur::BlurPlugin::getProcessParams(), tuttle::plugin::text::TextPlugin::getProcessParams(), tuttle::plugin::pinning::PinningPlugin::getProcessParams(), tuttle::plugin::sobel::SobelPlugin::getProcessParams(), tuttle::plugin::raw::reader::RawReaderPlugin::getProcessParams(), tuttle::plugin::lens::LensDistortPlugin::getProcessParams(), tuttle::plugin::swscale::SwscalePlugin::getRegionOfDefinition(), tuttle::plugin::resize::ResizePlugin::getRegionOfDefinition(), tuttle::plugin::inputBuffer::InputBufferPlugin::getTimeDomain(), tuttle::plugin::swscale::SwscalePlugin::isIdentity(), tuttle::plugin::lens::LensDistortPlugin::isIdentity(), and tuttle::plugin::interact::ParamRectangleFromTwoCorners< TFrame, coord >::setPoint().

Here is the call graph for this function:

OfxPointD OFX::Double2DParam::getValue ( void ) const [inline]

get value

Definition at line 1328 of file ofxsParam.h.

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

Referenced by getValue().

Here is the call graph for this function:

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

get the value at a time

Definition at line 1768 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Double2DParam::integrate	(	double	t1,
		double	t2,
		double &	x,
		double &	y
	)		const

integrate the param

get the value at a time

Definition at line 1802 of file ofxsParams.cpp.

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

Here is the call graph for this function:

OfxPointD OFX::Double2DParam::integrate	(	double	t1,
		double	t2
	)		const `[inline]`

integrate the param

Definition at line 1355 of file ofxsParam.h.

References integrate(), OfxPointD::x, and OfxPointD::y.

Referenced by integrate().

Here is the call graph for this function:

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

void OFX::Double2DParam::setDefault	(	double	x,
		double	y
	)

set the default value, default is 0

set the default value

Definition at line 1706 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Double2DParam::setDisplayRange	(	double	minX,
		double	minY,
		double	maxX,
		double	maxY
	)

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

Definition at line 1723 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Double2DParam::setRange	(	double	minX,
		double	minY,
		double	maxX,
		double	maxY
	)

set the hard min/max range, default is DOUBLE_MIN, DOUBLE_MAX

Definition at line 1713 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::Double2DParam::setValue	(	double	x,
		double	y
	)

set value

Definition at line 1776 of file ofxsParams.cpp.

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

Referenced by tuttle::plugin::imageStatistics::ImageStatisticsPlugin::changedParam(), tuttle::plugin::pinning::PinningPlugin::changedParam(), tuttle::plugin::av::AVOptionPlugin< IOPlugin >::setParameters(), tuttle::plugin::interact::ParamPointRelativePoint< TFrame, coord >::setPoint(), tuttle::plugin::interact::ParamPoint< TFrame, CoordinateSystemNotCentered< coord >::value >::setPoint(), and tuttle::plugin::interact::ParamRectangleFromTwoCorners< TFrame, coord >::setPoint().

Here is the call graph for this function:

void OFX::Double2DParam::setValue ( const OfxPointD & p ) [inline]

set value

Definition at line 1337 of file ofxsParam.h.

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

Referenced by setValue().

Here is the call graph for this function:

void OFX::Double2DParam::setValueAtTime	(	double	t,
		double	x,
		double	y
	)

set the value at a time, implicitly adds a keyframe

Definition at line 1784 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::Double2DParam::setValueAtTime	(	double	t,
		const OfxPointD &	p
	)		`[inline]`

set the value at a time, implicitly adds a keyframe

Definition at line 1343 of file ofxsParam.h.

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

Referenced by setValueAtTime().

Here is the call graph for this function:

Friends And Related Function Documentation

friend class ParamSet [friend]

Reimplemented from OFX::BaseDoubleParam.

Definition at line 1296 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
Double2DParam

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

Generated by 1.7.5.1