OMKVisualObject.h File Reference

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

Include dependency graph for OMKVisualObject.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::VisualObject
 Visual object used by the visualisation to visualise the simulated objects. More...
class  OMK::Vis::VisualObjectCreator
 ancestor of the VisualObject creator class used by the PrototypeFactory More...
class  OMK::Vis::VisualObjectCreatorT< T >
 VisualObject creator class to be parametrized by the descendants of VisualObject. More...

Defines

Macros to declare and implement the dynamic creation of visual objects.
#define DECLARE_VISUAL_OBJECT_FACTORY(VisualObjectClass)
 This define declares factory utilities, constructor and destructor for an animator.
#define REGISTER_VISUAL_OBJECT_FACTORY(VisualObjectClass, Id)
 This define implements factory utilities, constructor and destructor for an visual object.

Typedefs

typedef OBT::Singleton< OBT::PrototypeFactory<
OMK::Name, VisualObjectCreator > > 
OMK::Vis::VisualObjectFactory

Functions

std::string OMK::Vis::debugMsg (const Vis::VisualObject *visObj)
 Message formatting for visual object.


Define Documentation

#define DECLARE_VISUAL_OBJECT_FACTORY ( VisualObjectClass   ) 

Value:

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()
This define declares factory utilities, constructor and destructor for an animator.

Author:
Beno� Chanclou
Should be use with REGISTER_VISUAL_OBJECT_FACTORY. See Creation of simulated objects.

Definition at line 140 of file OMKVisualObject.h.

#define REGISTER_VISUAL_OBJECT_FACTORY ( VisualObjectClass,
Id   ) 

Value:

/* 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 ) )
This define implements factory utilities, constructor and destructor for an visual object.

Author:
Beno� Chanclou
Should be use with DECLARE_VISUAL_OBJECT_FACTORY. See Creation of simulated objects.

Definition at line 160 of file OMKVisualObject.h.


logo OpenMask

Documentation generated on Mon Jun 9 11:45:59 2008

Generated with doxygen by Dimitri van Heesch ,   1997-2007