OMKAnimator.h

Go to the documentation of this file.

/************************************************************************/
/* This file is part of openMask(c) INRIA, CNRS, Universite de Rennes 1 */
/* 1993-2002, thereinafter the Software                                 */
/*                                                                      */
/* The Software has been developped within the Siames Project.          */
/* INRIA, the University of Rennes 1 and CNRS jointly hold intellectual */
/* property rights                                                      */
/*                                                                      */
/* The Software has been registered with the Agence pour la Protection  */
/* des Programmes (APP) under registration number                       */
/* IDDN.FR.001.510008.00.S.P.2001.000.41200                             */
/*                                                                      */
/* This file may be distributed under the terms of the Q Public License */
/* version 1.0 as defined by Trolltech AS of Norway and appearing in    */
/* the file LICENSE.QPL included in the packaging of this file.         */
/*                                                                      */
/* Licensees holding valid specific licenses issued by INRIA, CNRS or   */
/* Universite Rennes 1 for the software may use this file in            */
/* acordance with that specific license                                 */
/************************************************************************/
#ifndef OMK_VIS_ANIMATOR_H
#define OMK_VIS_ANIMATOR_H

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

namespace OMK  
{
class ConfigurationParameterDescriptor ;
namespace Vis 
{
class VisBase ;
class AnimatorPlug ;
class OMKVIS_API Animator
{
public:



  virtual ~Animator() ;

  virtual void processVis() ;
  
  const Name& getId() const ;

  const VisualObject& getVisualObject() const ;
  VisualObject& getVisualObject() ;
  
  template < typename T > T* getTemplateNode (  );
protected:



  Animator( VisualObject& visualObject, const Name& id, const ConfigurationParameterDescriptor& node ) ;
  Animator( VisualObject& visualObject, const Name& id );







  virtual void selfProcessVis() = 0 ;

  AnimatorPlug* _plugUpdate ;
  
 
private:

  Name _id ;

  VisualObject& _visualObject ;
  
protected: 
  void * _tNode;
 
} ;
#define DECLARE_ANIMATOR_FACTORY( AnimatorClass ) \
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() 

#define DECLARE_TEMPLATE_ANIMATOR_FACTORY( AnimatorClass, Type ) \
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() 

#define REGISTER_ANIMATOR_FACTORY( AnimatorClass, Id )\
  /* 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 ) )

#define REGISTER_TEMPLATE_ANIMATOR_FACTORY( AnimatorClass, Id )\
  /* 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 ) )


//-----------------------------------------------------------------------------
class AnimatorCreator
{
public:
  virtual ~AnimatorCreator() {}
  virtual Animator* operator()( VisualObject& visualObject,
                  const Name& instanceId, 
                  const ConfigurationParameterDescriptor& node  ) const
  {
    OMERROR( "Creator is not registered for \"" << instanceId << "\"" << std::endl << node ) ;
    throw Exception( "Creator is not registered" ) ;
    return 0 ;
  }
} ;


//-----------------------------------------------------------------------------
template <class T>
class AnimatorCreatorT : public AnimatorCreator
{
public:
  virtual ~AnimatorCreatorT() {}

  typedef T object_to_create ;

  Animator* operator()( VisualObject& visualObject,
              const Name& instanceId, 
              const ConfigurationParameterDescriptor& node ) const
  {
    return new T( visualObject, instanceId, node ) ;
  }
} ;

//-------------------------------------------------------------------------
// getId
//-------------------------------------------------------------------------
inline const Name& 
Animator::getId() const 
{
  return _id ;
}
//-------------------------------------------------------------------------
//const  getVisualObject
//-------------------------------------------------------------------------
inline const VisualObject& Animator::getVisualObject() const 
{
  return _visualObject ;
}
//-------------------------------------------------------------------------
// getVisualObject
//-------------------------------------------------------------------------
inline  VisualObject& Animator::getVisualObject()
{
  return _visualObject ;
}
//-------------------------------------------------------------------------
// getTemplateNode
//-------------------------------------------------------------------------
template < typename T > inline T* Animator::getTemplateNode( )
{
  return (T *) _tNode ;
}

typedef OBT::Singleton< OBT::PrototypeFactory< OMK::Name, Vis::AnimatorCreator > > AnimatorFactory ;

std::string OMKVIS_API debugMsg( const Vis::Animator* anim ) ;
}// namespace Vis
}// namespace OMK

template class OMKVIS_API OBT::PrototypeFactory< OMK::Name, OMK::Vis::AnimatorCreator > ;
template class OMKVIS_API OBT::Singleton< OBT::PrototypeFactory< OMK::Name, OMK::Vis::AnimatorCreator > > ;

#endif // OMK_VIS_ANIMATOR_H

---