OMK::Vis::OgreAnimatorCommon Class Reference

Ancestor class for the Ogre animators. More...

#include <OMKOgreAnimatorT.h>

Inheritance diagram for OMK::Vis::OgreAnimatorCommon:

[legend]Collaboration diagram for OMK::Vis::OgreAnimatorCommon:


Public Member Functions
virtual	~OgreAnimatorCommon ()
	Destructor.
const OgreObject &	getOgreObject () const
	Returns a const reference to the associated OgreObject.
const std::string &	getNodeName () const
	Returns the name of the node to animate.
Protected Member Functions
	OgreAnimatorCommon (VisualObject &visualObject, const std::string &nodeName)
	Constructor for inherited animators.
	OgreAnimatorCommon (VisualObject &visualObject, const ConfigurationParameterDescriptor &node)
	Constructor for the animator factory.
Ogre::Node &	getNode () const
	Returns a reference to the ogre node to animate.
void	findOgreNode (Animator animator, void &tNode)
	Find the ogre node named nodeName in the subtree of the associated VisualObject.
Protected Attributes
const OgreObject &	_ogreObject
	associated ogre object
std::string	_nodeName
	name of the node to animate
Ogre::Node *	_node
	pointer to the node to animate

Detailed Description

Ancestor class for the Ogre animators.

Author:: Benoit Chanclou, bunraku <benoit.chanclou@irisa.fr>

Find the named node to animate in the subtree of the animator associated VisualObject. To do this, the inherited animator calls findOgreNode, see OgreAnimator and OgreAnimatorT

Definition at line 43 of file OMKOgreAnimatorT.h.

Constructor & Destructor Documentation

virtual OMK::Vis::OgreAnimatorCommon::~OgreAnimatorCommon ( ) [inline, virtual]

Destructor.

Definition at line 48 of file OMKOgreAnimatorT.h.

00048 {}

OMK::Vis::OgreAnimatorCommon::OgreAnimatorCommon	(	VisualObject &	visualObject,
		const std::string &	nodeName
	)			`[inline, protected]`

Constructor for inherited animators.

Definition at line 59 of file OMKOgreAnimatorT.h.

00060                                                   :
00061     _ogreObject( static_cast< const OgreObject& >( visualObject ) ),
00062     _nodeName( nodeName ), 
00063     _node ( 0 ) 
00064   {
00065   }

OMK::Vis::OgreAnimatorCommon::OgreAnimatorCommon	(	VisualObject &	visualObject,
		const ConfigurationParameterDescriptor &	node
	)			`[inline, protected]`

Constructor for the animator factory.

Definition at line 68 of file OMKOgreAnimatorT.h.

References OMK::ParametersAccessor::get(), OMK_DEBUG_VIS, and OMTRACEID.

00069                                                                      :
00070     _ogreObject( static_cast< const OgreObject& >( visualObject ) ),
00071     _nodeName(),
00072     _node( 0 )
00073   {
00074     if( !ParametersAccessor::get( &node, "NodeName", _nodeName ) )
00075       OMTRACEID( OMK_DEBUG_VIS, ">>> :-| no node name provided for the animator" ) ; 
00076   }

Member Function Documentation

const OgreObject& OMK::Vis::OgreAnimatorCommon::getOgreObject ( ) const [inline]

Returns a const reference to the associated OgreObject.

Definition at line 51 of file OMKOgreAnimatorT.h.

Referenced by findOgreNode(), and OMK::Vis::SwitchAnimator::init().

00051 { return _ogreObject ; }

const std::string& OMK::Vis::OgreAnimatorCommon::getNodeName ( ) const [inline]

Returns the name of the node to animate.

Definition at line 54 of file OMKOgreAnimatorT.h.

Referenced by OMK::Vis::SwitchAnimator::init().

00054 { return _nodeName ; }

Ogre::Node& OMK::Vis::OgreAnimatorCommon::getNode ( ) const [inline, protected]

Returns a reference to the ogre node to animate.

Definition at line 79 of file OMKOgreAnimatorT.h.

Referenced by OMK::Vis::SwitchAnimator::init(), OMK::Vis::TransparencyValueAnimator::selfProcessVis(), OMK::Vis::TransparencyAnimAnimator::selfProcessVis(), and OMK::Vis::TransformAnimator::selfProcessVis().

00079 { return *_node ; }

void OMK::Vis::OgreAnimatorCommon::findOgreNode	(	Animator *	animator,
		void *&	tNode
	)			`[protected]`

Find the ogre node named nodeName in the subtree of the associated VisualObject.

Definition at line 23 of file OMKOgreAnimatorT.cpp.

References _node, _nodeName, OMK::Vis::debugMsg(), OMK::Vis::getOgreNode(), getOgreObject(), and OMASSERTM.

Referenced by OMK::Vis::OgreAnimator::OgreAnimator(), and OMK::Vis::OMK::Vis::OgreAnimatorT< OMK::Type::SimpleTypeTstring > >::OgreAnimatorT().

00024 {
00025         if ( !_nodeName.empty() )
00026         {
00027                 _node = OMK::Vis::getOgreNode( getOgreObject().getSceneNode(), _nodeName ) ;
00028                 OMASSERTM( _node, 
00029       "Error for " << debugMsg( animator ) << std::endl 
00030       << ">>> :-( the node " << _nodeName << " was not found" ) ;
00031     tNode = _node ;
00032   }
00033 }