OMKVisualObject.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_VISUALOBJECT_H
#define OMK_VIS_VISUALOBJECT_H

#include <vector>
#include "OMKVisBase.h"
#include "OMKAnimatorEventPlugT.h"
#include "OMKAnimatorInputPlugT.h"
#include "OMKTransform.h"
#include "OBTPrototypeFactory.h"

namespace OMK 
{
namespace Vis 
{
class Animator ;

class OMKVIS_API VisualObject
{
public:



  VisualObject( VisBase& vis, const Name& id, const ConfigurationParameterDescriptor* node );

  virtual ~VisualObject() ;

  void update() ;

  const VisBase& getVis() const ;

  VisBase& touchVis() const ;

  const Name& getId() const ;

  const Type::Transform& getTransform() const ;

  void addAnimator( OMK::Vis::Animator* animator ) ;

  void deleteAnimator( const Name& id ) ;

  OMK::Vis::Animator* getAnimator( const Name& id ) const ;
protected:

  virtual void visualise() = 0 ;

  typedef std::map< Name, OMK::Vis::Animator* > AnimatorsMap ;
  AnimatorsMap _animators ;


private :

  void readConfigurationParameters( const ConfigurationParameterDescriptor* node ) ;

  VisBase& _vis ;

  Name _id ;

  Type::Transform _transform ;
} ;

#define DECLARE_VISUAL_OBJECT_FACTORY( VisualObjectClass ) \
public: \
 \
  friend class OMK::Vis::VisualObjectCreatorT< VisualObjectClass > ; \
 \
  static OMK::Name OMK_CLASS_ID ; \
 \
  static const bool REGISTERED_IN_VISUAL_OBJECT_FACTORY ; \
protected: \
 \
  VisualObjectClass( OMK::Vis::VisBase& vis, const OMK::Name& instanceId, const OMK::ConfigurationParameterDescriptor* node  ) ; \
public: \
  virtual ~VisualObjectClass() 

#define REGISTER_VISUAL_OBJECT_FACTORY( VisualObjectClass, Id )\
  /* Factory */ \
  OMK::Name VisualObjectClass::OMK_CLASS_ID( Id ) ; \
  const bool VisualObjectClass::REGISTERED_IN_VISUAL_OBJECT_FACTORY( OMK::Vis::VisualObjectFactory::getInstance().registerCreator< OMK::Vis::VisualObjectCreatorT< VisualObjectClass > >( Id ) )


//-----------------------------------------------------------------------------

class VisualObjectCreator
{
public:
  virtual ~VisualObjectCreator() {}
  virtual VisualObject* operator()
    (  VisBase& vis, 
      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 VisualObjectCreatorT : public VisualObjectCreator
{
public:
  virtual ~VisualObjectCreatorT() {}
  typedef T object_to_create ;

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

//-------------------------------------------------------------------------
// getVis
//-------------------------------------------------------------------------
inline const VisBase& 
VisualObject::getVis() const
{
  return _vis ;
}

//-------------------------------------------------------------------------
// touchVis
//-------------------------------------------------------------------------
inline VisBase& 
VisualObject::touchVis() const
{
  return _vis ;
}

//-------------------------------------------------------------------------
// getId
//-------------------------------------------------------------------------
inline const Name& 
VisualObject::getId() const 
{
  return _id ;
}

//-------------------------------------------------------------------------
// getTransform
//-------------------------------------------------------------------------
inline const Type::Transform& 
VisualObject::getTransform() const
{
  return _transform ;
}

std::string OMKVIS_API debugMsg( const Vis::VisualObject* visObj ) ;

typedef OBT::Singleton< OBT::PrototypeFactory< OMK::Name, VisualObjectCreator > > VisualObjectFactory ;
}// namespace Vis
}// namespace OMK

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

#endif // OMK_VIS_VISUALOBJECT_H

---