tuttle::host::attribute::AnimatedParam< T, OFX_PARAM > Class Template Reference

#include <AnimatedParam.hpp>

Inheritance diagram for tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >:

Collaboration diagram for tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >:

Public Types
typedef AnimatedParam< T, OFX_PARAM >	This
typedef std::vector< TimeValue < T > >::iterator	TimeValueTIterator
typedef std::vector< TimeValue < T > >::const_iterator	TimeValueTConstIterator
Public Member Functions
	AnimatedParam (INode &effect, const std::string &name, const ofx::attribute::OfxhParamDescriptor &descriptor, const std::size_t index, const T value)
	AnimatedParam (const AnimatedParam< T, OFX_PARAM > &other)
	~AnimatedParam ()
void	setInterpolator (const ofx::attribute::EInterpolatorType interpolatorType) OFX_EXCEPTION_SPEC
void	getValue (T &v) const OFX_EXCEPTION_SPEC
void	getValueAtTime (const OfxTime time, T &v) const OFX_EXCEPTION_SPEC
void	setValue (const T &v, const ofx::attribute::EChange change) OFX_EXCEPTION_SPEC
void	setValueAtTime (const OfxTime time, const T &v, const ofx::attribute::EChange change) OFX_EXCEPTION_SPEC
void	setValueFromExpression (const std::string &value, const ofx::attribute::EChange change) OFX_EXCEPTION_SPEC
void	derive (const OfxTime time, T &) const OFX_EXCEPTION_SPEC
void	integrate (const OfxTime time1, const OfxTime time2, T &) const OFX_EXCEPTION_SPEC
void	copy (const AnimatedParam< T, OFX_PARAM > &p) OFX_EXCEPTION_SPEC
void	copy (const ofx::attribute::OfxhParam &p) OFX_EXCEPTION_SPEC
This *	clone () const
void	getNumKeys (unsigned int &outNumKeys) const OFX_EXCEPTION_SPEC
void	getKeyTime (const int nth, OfxTime &outTime) const OFX_EXCEPTION_SPEC
void	getKeyIndex (const OfxTime time, const int direction, int &outIndex) const OFX_EXCEPTION_SPEC
void	deleteKey (const OfxTime time) OFX_EXCEPTION_SPEC
void	deleteAllKeys () OFX_EXCEPTION_SPEC
bool	paramTypeHasData () const
std::size_t	getHash () const
std::size_t	getHashAtTime_valueChangeToEnd (const OfxTime time) const
std::size_t	getHashAtTime (const OfxTime time) const
Protected Attributes
T	_value
std::vector< TimeValue< T > >	_key_frames
boost::scoped_ptr < Interpolator< T > >	_interpolator

---

Detailed Description

template<typename T, typename OFX_PARAM>
class tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >

Definition at line 27 of file AnimatedParam.hpp.

---

Member Typedef Documentation

template<typename T, typename OFX_PARAM>

typedef AnimatedParam<T, OFX_PARAM> tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::This

Definition at line 43 of file AnimatedParam.hpp.

template<typename T, typename OFX_PARAM>

typedef std::vector< TimeValue<T> >::const_iterator tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::TimeValueTConstIterator

Definition at line 45 of file AnimatedParam.hpp.

template<typename T, typename OFX_PARAM>

typedef std::vector< TimeValue<T> >::iterator tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::TimeValueTIterator

Definition at line 44 of file AnimatedParam.hpp.

---

Constructor & Destructor Documentation

template<typename T, typename OFX_PARAM>

tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::AnimatedParam	(	INode &	effect,
		const std::string &	name,
		const ofx::attribute::OfxhParamDescriptor &	descriptor,
		const std::size_t	index,
		const T	value
	)		[inline]

Definition at line 47 of file AnimatedParam.hpp.

template<typename T, typename OFX_PARAM>

tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::AnimatedParam

(

const AnimatedParam< T, OFX_PARAM > &

other

)

[inline]

Definition at line 60 of file AnimatedParam.hpp.

template<typename T, typename OFX_PARAM>

tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::~AnimatedParam

(

)

[inline]

Definition at line 68 of file AnimatedParam.hpp.

---

Member Function Documentation

template<typename T, typename OFX_PARAM>

This* tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::clone

(

)

const [inline]

Definition at line 203 of file AnimatedParam.hpp.

template<typename T, typename OFX_PARAM>

void tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::copy

(

const AnimatedParam< T, OFX_PARAM > &

p

)

[inline]

Definition at line 189 of file AnimatedParam.hpp.

Referenced by tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::copy().

template<typename T, typename OFX_PARAM>

void tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::copy

(

const ofx::attribute::OfxhParam &

p

)

[inline]

Definition at line 196 of file AnimatedParam.hpp.

template<typename T, typename OFX_PARAM>

void tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::deleteAllKeys

(

)

[inline]

Definition at line 294 of file AnimatedParam.hpp.

template<typename T, typename OFX_PARAM>

void tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::deleteKey

(

const OfxTime

time

)

[inline]

Definition at line 281 of file AnimatedParam.hpp.

template<typename T, typename OFX_PARAM>

void tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::derive	(	const OfxTime	time,
		T &
	)		const [inline]

Definition at line 179 of file AnimatedParam.hpp.

template<typename T, typename OFX_PARAM>

std::size_t tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::getHash

(

)

const [inline]

Definition at line 303 of file AnimatedParam.hpp.

Referenced by tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::getHashAtTime().

template<typename T, typename OFX_PARAM>

std::size_t tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::getHashAtTime

(

const OfxTime

time

)

const [inline]

Definition at line 330 of file AnimatedParam.hpp.

template<typename T, typename OFX_PARAM>

std::size_t tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::getHashAtTime_valueChangeToEnd

(

const OfxTime

time

)

const [inline]

Definition at line 314 of file AnimatedParam.hpp.

Referenced by tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::getHashAtTime().

template<typename T, typename OFX_PARAM>

void tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::getKeyIndex	(	const OfxTime	time,
		const int	direction,
		int &	outIndex
	)		const [inline]

Definition at line 225 of file AnimatedParam.hpp.

template<typename T, typename OFX_PARAM>

void tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::getKeyTime	(	const int	nth,
		OfxTime &	outTime
	)		const [inline]

Definition at line 217 of file AnimatedParam.hpp.

template<typename T, typename OFX_PARAM>

void tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::getNumKeys

(

unsigned int &

outNumKeys

)

const [inline]

Definition at line 212 of file AnimatedParam.hpp.

template<typename T, typename OFX_PARAM>

void tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::getValue

(

T &

v

)

const [inline]

Definition at line 91 of file AnimatedParam.hpp.

template<typename T, typename OFX_PARAM>

void tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::getValueAtTime	(	const OfxTime	time,
		T &	v
	)		const [inline]

Definition at line 96 of file AnimatedParam.hpp.

Referenced by tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::getHashAtTime(), and tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::getHashAtTime_valueChangeToEnd().

template<typename T, typename OFX_PARAM>

void tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::integrate	(	const OfxTime	time1,
		const OfxTime	time2,
		T &
	)		const [inline]

Definition at line 184 of file AnimatedParam.hpp.

template<typename T, typename OFX_PARAM>

bool tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::paramTypeHasData

(

)

const [inline]

Definition at line 301 of file AnimatedParam.hpp.

template<typename T, typename OFX_PARAM>

void tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::setInterpolator

(

const ofx::attribute::EInterpolatorType

interpolatorType

)

[inline]

Definition at line 72 of file AnimatedParam.hpp.

template<typename T, typename OFX_PARAM>

void tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::setValue	(	const T &	v,
		const ofx::attribute::EChange	change
	)		[inline]

Reimplemented in tuttle::host::attribute::AnimatedParamDouble, and tuttle::host::attribute::ParamDouble.

Definition at line 145 of file AnimatedParam.hpp.

template<typename T, typename OFX_PARAM>

void tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::setValueAtTime	(	const OfxTime	time,
		const T &	v,
		const ofx::attribute::EChange	change
	)		[inline]

Reimplemented in tuttle::host::attribute::AnimatedParamDouble, and tuttle::host::attribute::ParamDouble.

Definition at line 153 of file AnimatedParam.hpp.

template<typename T, typename OFX_PARAM>

void tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::setValueFromExpression	(	const std::string &	value,
		const ofx::attribute::EChange	change
	)		[inline]

Definition at line 173 of file AnimatedParam.hpp.

---

Field Documentation

template<typename T, typename OFX_PARAM>

boost::scoped_ptr< Interpolator<T> > tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::_interpolator [protected]

Definition at line 40 of file AnimatedParam.hpp.

Referenced by tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::getValueAtTime(), and tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::setInterpolator().

template<typename T, typename OFX_PARAM>

std::vector< TimeValue<T> > tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::_key_frames [protected]

Definition at line 34 of file AnimatedParam.hpp.

Referenced by tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::copy(), tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::deleteAllKeys(), tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::deleteKey(), tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::getHash(), tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::getHashAtTime_valueChangeToEnd(), tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::getKeyIndex(), tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::getKeyTime(), tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::getNumKeys(), tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::getValueAtTime(), tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::setValue(), and tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::setValueAtTime().

template<typename T, typename OFX_PARAM>

T tuttle::host::attribute::AnimatedParam< T, OFX_PARAM >::_value [protected]

Definition at line 30 of file AnimatedParam.hpp.

Referenced by tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::copy(), tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::getValue(), tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::getValueAtTime(), tuttle::host::attribute::ParamInteger::ParamInteger(), tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::setValue(), and tuttle::host::attribute::AnimatedParam< double, ofx::attribute::OfxhParamDouble >::setValueFromExpression().

---

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

• TuttleOFX/libraries/tuttle/src/tuttle/host/attribute/AnimatedParam.hpp