OMKVisBase.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_OMKVisBase_H
#define OMK_VIS_OMKVisBase_H

#include "OMKExtensibleSimulatedObject.h"
#include "OMKInput.h"
#include "OMKTracer.h"
#include "OMKAddAnimatorPrm.h"
namespace OMK  
{
namespace Type
{
class AddVisualObjectPrm ;
class AddAnimatorPrm ;
}
namespace Vis 
{
class VisualObject ;
class IAnimatorEventPlug ;
class Animator ;
class OMKVIS_API VisBase : public OMK::ExtensibleSimulatedObject
{

public:

  virtual ~VisBase() ;

protected:

  VisBase( Controller& ctrl, const ObjectDescriptor& objectDescriptor );  

public:






  virtual bool processEvent( Event *e ) ;

  virtual void init() ;
  virtual void finish() ;


  virtual void computeParameters() ;


  static EventIdentifier ADD_VISUAL_OBJECT_EVENT_ID    ;
  static EventIdentifier DELETE_VISUAL_OBJECT_EVENT_ID ;
  static EventIdentifier ADD_ANIMATOR_EVENT_ID         ;
  static EventIdentifier DELETE_ANIMATOR_EVENT_ID      ;
  DECLARE_EVENT_LISTENER( OMK::Type::AddVisualObjectPrm, AddVisualObject, VisBase ) ;
  DECLARE_EVENT_LISTENER( Name, DeleteVisualObject, VisBase ) ;
  DECLARE_EVENT_LISTENER( OMK::Type::AddAnimatorPrm, AddAnimator, VisBase ) ;
  typedef std::pair< Name, Name > DeleteAnimatorPrm ;
  DECLARE_TYPE_EVENT_LISTENER( DeleteAnimatorPrm, DeleteAnimator, VisBase ) ;

  template< typename T >
  Input<T>* createInput( const Name& object, const Name& output ) ;

  void registerEventPlug( const EventIdentifier& eventId, 
    const std::string& emitter, 
    OMK::Vis::IAnimatorEventPlug* plug ) ;

  void removeEventPlug( const EventIdentifier& eventId, OMK::Vis::IAnimatorEventPlug *plug ) ;

  OMK::Vis::VisualObject* getVisualObject( const Name& id ) const ;

private:

  bool processAddVisualObjectEvent( AddVisualObjectEvent *e ) ;
  bool processDeleteVisualObjectEvent( DeleteVisualObjectEvent *e ) ;
  bool processAddAnimatorEvent( AddAnimatorEvent *e ) ;
  bool processDeleteAnimatorEvent( DeleteAnimatorEvent *e ) ;
  void addNewVisualObject( OMK::Vis::VisualObject* visualObject );
  void deleteVisualObject( const Name& id ) ;

  typedef std::map< Name, std::vector< OMK::Type::AddAnimatorPrm > > AnimatorsToCreateMap ;
  typedef std::map< Name, OMK::Vis::VisualObject* > VisualObjectMap ;
  typedef std::list< OMK::Vis::IAnimatorEventPlug* > EventPlugList ;
  typedef std::map< EventIdentifier, EventPlugList > EventPlugMap ;

  VisualObjectMap _visualObjects ;

  EventPlugMap _eventIdAndPlug ;

  AnimatorsToCreateMap _animatorsToCreate ;
};

template< typename T >
inline Input< T >* VisBase::createInput( const Name& object, const Name& output ) 
{
  // Create a name for the input 
  // :-( must use a temporary string because + operator doesn't work
  Name inputName( std::string( object.getCString() ) + output.getCString() ) ;
  // add an input, if it already defined => will display an error message and
  // returns the previous input
  Input< T >* input = &addInput< T >( inputName ) ;
  // connection to the output
  if( !input || !input->connect( object, output ) )
  { // unable to connect => display a message 
    OMTRACEID( OMK_DEBUG_VIS, "Error in VisBase::createInput() "
      << "for object \"" << getName().getCString() << "\" (class " 
      << getObjectDescriptor().getClass().getCString() << ")" << std::endl
      << ">>> :-( Invalid connection parameters, unable to connect to the output \"" 
      << output.getCString() << "\" of the object \"" << object.getCString() 
      << "\"." ) ; 
    input = 0 ; // will return null pointer if the input cannot be connected
  }
  // returns the result 
  return input ;
}


}// namespace Vis
}// namespace OMK

#endif // OMK_VIS_OMKVisBase_H

---