OMKAnimator.h File Reference

#include "OBTPrototypeFactory.h"
#include "OMKVis.h"

Include dependency graph for OMKAnimator.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	OMK
namespace	OMK::Vis
Classes
class	OMK::Vis::Animator
	Animator which updates the visual object thanks to the informations found by its plug. More...
class	OMK::Vis::AnimatorCreator
	Ancestor of animator creator class used by the PrototypeFactory. More...
class	OMK::Vis::AnimatorCreatorT< T >
	Animator creator class to be parametrised by the descendants of Animator This class creates the new animator. More...
Defines
Macros to declare and implement the dynamic creation of animators.
#define	DECLARE_ANIMATOR_FACTORY(AnimatorClass)
	This define declares factory utilities, constructor and destructor for an animator.
#define	DECLARE_TEMPLATE_ANIMATOR_FACTORY(AnimatorClass, Type)
	This define declares factory utilities, constructor and destructor for an animator.
#define	REGISTER_ANIMATOR_FACTORY(AnimatorClass, Id)
	This define implements factory utilities, constructor and destructor for an animator.
#define	REGISTER_TEMPLATE_ANIMATOR_FACTORY(AnimatorClass, Id)
	This define implements factory utilities, constructor and destructor for a template animator.
Typedefs
typedef OBT::Singleton< OBT::PrototypeFactory< OMK::Name, Vis::AnimatorCreator > >	OMK::Vis::AnimatorFactory
Functions
std::string	OMK::Vis::debugMsg (const Vis::Animator *anim)
	Message formatting for animator.

---

Define Documentation

#define DECLARE_ANIMATOR_FACTORY

(

AnimatorClass

)

Value:

public: \ \
  friend class OMK::Vis::AnimatorCreatorT< AnimatorClass > ; \ \
  static OMK::Name OMK_CLASS_ID ; \ \
  static const bool REGISTERED_IN_ANIMATOR_FACTORY ; \
protected: \ \
  AnimatorClass( OMK::Vis::VisualObject& visualObject, const OMK::Name& id, const OMK::ConfigurationParameterDescriptor& node ) ; \
public: \
  virtual ~AnimatorClass()

This define declares factory utilities, constructor and destructor for an animator.

Date:

2007-07-17

Author:

Beno� Chanclou

Should be use with REGISTER_ANIMATOR_FACTORY. See Creation of simulated objects.

Definition at line 120 of file OMKAnimator.h.

#define DECLARE_TEMPLATE_ANIMATOR_FACTORY	(	AnimatorClass,
		Type		)

Value:

public: \ \
  friend class OMK::Vis::AnimatorCreatorT< AnimatorClass< Type > > ; \ \
  static OMK::Name OMK_CLASS_ID ; \ \
  static const bool REGISTERED_IN_ANIMATOR_FACTORY ; \
protected: \ \
  AnimatorClass( OMK::Vis::VisualObject& visualObject, const OMK::Name& id, const OMK::ConfigurationParameterDescriptor& node ) ; \
public: \
  virtual ~AnimatorClass()

This define declares factory utilities, constructor and destructor for an animator.

Date:

2007-07-17

Author:

Beno� Chanclou

Should be use with REGISTER_TEMPLATE_ANIMATOR_FACTORY. See Creation of simulated objects.

Definition at line 140 of file OMKAnimator.h.

#define REGISTER_ANIMATOR_FACTORY	(	AnimatorClass,
		Id		)

Value:

/* Factory */ \
  OMK::Name AnimatorClass::OMK_CLASS_ID( Id ) ; \
  const bool AnimatorClass::REGISTERED_IN_ANIMATOR_FACTORY( OMK::Vis::AnimatorFactory::getInstance().registerCreator< OMK::Vis::AnimatorCreatorT< AnimatorClass > >( Id ) )

This define implements factory utilities, constructor and destructor for an animator.

Date:

2007-07-16

Author:

Beno� Chanclou

Should be use with DECLARE_ANIMATOR_FACTORY. See Creation of simulated objects.

Definition at line 161 of file OMKAnimator.h.

#define REGISTER_TEMPLATE_ANIMATOR_FACTORY	(	AnimatorClass,
		Id		)

Value:

/* Factory */ \
  template <> OMK::Name AnimatorClass::OMK_CLASS_ID( Id ) ; \
  template <> const bool AnimatorClass::REGISTERED_IN_ANIMATOR_FACTORY( OMK::Vis::AnimatorFactory::getInstance().registerCreator< OMK::Vis::AnimatorCreatorT< AnimatorClass > >( Id ) )

This define implements factory utilities, constructor and destructor for a template animator.

Date:

2007-07-16

Author:

Beno� Chanclou

Should be use with DECLARE_ANIMATOR_FACTORY. See Creation of simulated objects.

Definition at line 172 of file OMKAnimator.h.

---