OMK::Vis::AnimatorPlugT< T > Class Template Reference

A typed plug offering the interface to retrieve information the animator needs. More...

#include <OMKAnimatorPlugT.h>

Inheritance diagram for OMK::Vis::AnimatorPlugT< T >:

Inheritance graph
[legend]
Collaboration diagram for OMK::Vis::AnimatorPlugT< T >:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual ~AnimatorPlugT ()
 Destructor.
Interface.
virtual const T & getTypedValue () const=0
 Returns the typed associated value.

Detailed Description

template<typename T>
class OMK::Vis::AnimatorPlugT< T >

A typed plug offering the interface to retrieve information the animator needs.

Author:
Benoit Chanclou, Michaël Rouillé, bunraku <bchanclo@irisa.fr> Class used by OMK::Vis::AnimatorT to retrieve a typed value associated to a valued event or an input.

Definition at line 38 of file OMKAnimatorPlugT.h.


Constructor & Destructor Documentation

template<typename T>
virtual OMK::Vis::AnimatorPlugT< T >::~AnimatorPlugT (  )  [inline, virtual]

Destructor.

Definition at line 42 of file OMKAnimatorPlugT.h.

00042 {}


Member Function Documentation

template<typename T>
virtual const T& OMK::Vis::AnimatorPlugT< T >::getTypedValue (  )  const [pure virtual]

Returns the typed associated value.

Returns:
A constant pointer to the typed associated value retrieved in the input or the valued event.
Called by sons of Animator to retrieve the typed value.

Implemented in OMK::Vis::AnimatorEventPlugT< T >, and OMK::Vis::AnimatorInputPlugT< T >.


logo OpenMask

Documentation generated on Mon Jun 9 11:46:05 2008

Generated with doxygen by Dimitri van Heesch ,   1997-2007