casa::MWCAnimator Class Reference

Animator for MultiWCHolder class. More...

#include <MWCAnimator.h>

Public Member Functions
	MWCAnimator ()
	Constructor which makes an isolated MWCAnimator.
	MWCAnimator (MultiWCHolder &mholder)
	Constructor which makes a MWCAnimator which is connected to the specified MultiWCHolder.
virtual	~MWCAnimator ()
	Destructor.
virtual void	addMWCHolder (MultiWCHolder &mholder)
	Add or remove a MultiWCHolder, or remove all MultiWCHolders from this MWCAnimator.
virtual void	removeMWCHolder (MultiWCHolder &mholder)
virtual void	removeMWCHolders ()
virtual void	setLinearRestrictions (AttributeBuffer &restrictions, const AttributeBuffer &increments)
	Install the given restriction, spaced by the given increment, on all MultiWCHolders.
template<class T >
void	setLinearRestriction (const String &name, const T &value, const T &increment, const T &tol)
	Install a restriction of the given name, and initial value and increment, on all MultiWCHolders.
virtual void	setLinearRestriction (const RecordInterface &rec)
	Install a restriction described by the given RecordInterface, on all MultiWCHolders.
virtual void	removeRestriction (const String &name)
	Remove a restriction (including a 'linear' (ramped) one).
Private Member Functions
Bool	isAlreadyRegistered (const MultiWCHolder &holder)
	Do we already have this MultiWCHolder registered?
Private Attributes
List< MultiWCHolder * >	itsMWCHList
	The list of MultiWCHolders that are connected to this MWCAnimator.

Detailed Description

Animator for MultiWCHolder class.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Etymology

Synopsis

Motivation

Definition at line 60 of file MWCAnimator.h.

Constructor & Destructor Documentation

casa::MWCAnimator::MWCAnimator ( )

Constructor which makes an isolated MWCAnimator.

casa::MWCAnimator::MWCAnimator ( MultiWCHolder & mholder )

Constructor which makes a MWCAnimator which is connected to the specified MultiWCHolder.

virtual casa::MWCAnimator::~MWCAnimator ( ) [virtual]

Destructor.

Member Function Documentation

virtual void casa::MWCAnimator::addMWCHolder ( MultiWCHolder & mholder ) [virtual]

Add or remove a MultiWCHolder, or remove all MultiWCHolders from this MWCAnimator.

mholder is added at the end of the list.

Bool casa::MWCAnimator::isAlreadyRegistered ( const MultiWCHolder & holder ) [private]

Do we already have this MultiWCHolder registered?

virtual void casa::MWCAnimator::removeMWCHolder ( MultiWCHolder & mholder ) [virtual]

virtual void casa::MWCAnimator::removeMWCHolders ( ) [virtual]

virtual void casa::MWCAnimator::removeRestriction ( const String & name ) [virtual]

Remove a restriction (including a 'linear' (ramped) one).

(Can be (and is) used to remove 'bindex' restriction).

virtual void casa::MWCAnimator::setLinearRestriction ( const RecordInterface & rec ) [virtual]

Install a restriction described by the given RecordInterface, on all MultiWCHolders.

This method simply extracts the fields name, value, and increment from rec, and calls the explicit version of setLinearRestriction. The value and increment fields can contain either Int, Float or Double data at the moment.

template<class T >

void casa::MWCAnimator::setLinearRestriction	(	const String &	name,
		const T &	value,
		const T &	increment,
		const T &	tol
	)			`[inline]`

Install a restriction of the given name, and initial value and increment, on all MultiWCHolders.

This is templated and the templates are valid for any type which can be added to an AttributeBuffer. This function simply sets up a single-element AttributeBuffer and calls setLinearRestrictions.

virtual void casa::MWCAnimator::setLinearRestrictions	(	AttributeBuffer &	restrictions,
		const AttributeBuffer &	increments
	)			`[virtual]`

Install the given restriction, spaced by the given increment, on all MultiWCHolders.

Ultimately this will go private and be called (for example) by next(), prev(). But for now we leave it public for testing purposes. After being called, restrictions is the set of restrictions which have been placed on the final WorldCanvasHolder of the final MultiWCHolder in the list.

Member Data Documentation

List<MultiWCHolder *> casa::MWCAnimator::itsMWCHList [private]

The list of MultiWCHolders that are connected to this MWCAnimator.

Definition at line 119 of file MWCAnimator.h.

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

code/display/DisplayEvents/MWCAnimator.h