OMK::Vis::VisObjectExtension Class Reference

Input listener to control the bounding boxes around objects. More...

#include <OMKVisObjectExtension.h>

Inheritance diagram for OMK::Vis::VisObjectExtension:

[legend]Collaboration diagram for OMK::Vis::VisObjectExtension:

[legend]List of all members.

Configuration loaders
See How to configure an extension ? for details.
virtual bool	loadObjectParameters (const ConfigurationParameterDescriptor *node)
	See How to create Visual Objects.
static bool	loadAnimatorParameters (const Name &id, const ConfigurationParameterDescriptor *node, SimulatedObject *sender, const Name &visName, const Name *visualObjectName)
	See How to create Animators.
Private Member Functions
	DECLARE_EXTENSION_FACTORY (VisObjectExtension)
	Factory and constructor/destructor.
Friends
class	VisBase

---

Detailed Description

Input listener to control the bounding boxes around objects.

Date:

2007-03-15

Author:

Benoît Chanclou

Defines a extension to load the visual object description in an object UserParams configuration node.

This extension is automatically add to every visual object.

Definition at line 23 of file OMKVisObjectExtension.h.

---

Member Function Documentation

OMK::Vis::VisObjectExtension::DECLARE_EXTENSION_FACTORY

(

VisObjectExtension

)

[private]

Factory and constructor/destructor.

See Extension feature

bool VisObjectExtension::loadObjectParameters

(

const ConfigurationParameterDescriptor *

node

)

[protected, virtual]

See How to create Visual Objects.

Reimplemented from OMK::Extension.

Definition at line 44 of file OMKVisObjectExtension.cpp.

References OMK::ExtensionT< SimulatedObjectType >::_owner, OMK::Vis::VisBase::ADD_VISUAL_OBJECT_EVENT_ID, OMK::ParametersAccessor::get(), OMK::SimulatedObject::getName(), OMK::ConfigurationParameterDescriptor::getNumberOfSubItems(), OMK::ConfigurationParameterDescriptor::getSubDescriptorByName(), OMK::Type::AddVisualObjectPrm::getVisuName(), loadAnimatorParameters(), OMK::Type::AddVisualObjectPrm::loadParameters(), OMK_DEBUG_VIS_EXEC, OMTRACE, OMTRACEID, and OMK::Type::AddVisualObjectPrm::setObjectName().

{
  // Retrieve the visual objects
  bool ok = true ;
  Name visuName ;
  const VisBase* visu = dynamic_cast< const VisBase* >( _owner ) ;
  if( visu )
  { // The extension owner is the visuable object itself => retrieve its name
    visuName = visu->getName() ;
  }
  else
  { // The extension owner is not the visuable object =>  try to find the name in the object parameters
    ParametersAccessor::get( node, "VisuName", visuName ) ;
  }
  const ConfigurationParameterDescriptor * objectNode = node ? node->getSubDescriptorByName( "VisualObject" ) : 0 ;

  if( objectNode )
  {
    int nbItems = objectNode->getNumberOfSubItems() ;
    for( int i = 0 ; i < nbItems ; ++i )
    { 
      // Retrieve parameters sets for each visual object
      std::string id = static_cast<const MultipleConfigurationParameter *>( objectNode )->getNameOfSubDescriptor( i ) ;
      const ConfigurationParameterDescriptor * param = objectNode->getSubDescriptorByPosition( i ) ;
      AddVisualObjectPrm prm ;
      ok = prm.loadParameters( param, "", _owner ) && ok ;
      if( ok )
      {
        // Fill the name of the object, it is the name of the node
        prm.setObjectName( id ) ;
        // Try to find the name of the visualisation
        visuName = prm.getVisuName() != Name() ? prm.getVisuName() : visuName ;

        OMTRACEID( OMK_DEBUG_VIS_EXEC, "Sender \"" << _owner->getName().getString() << "\" (class "
                   << _owner->getObjectDescriptor().getClass().getString() << ")" << std::endl
                   << ">>> visualisation \"" << visuName << "\"" << std::endl
                   << ">>> object name \"" << id << "\"" << std::endl
                   << ">>> event \"" << prm << "\"" ) ; 
        // sends the appropriate event to create the visual objects
        if( visuName != Name() )
        { // A name was in arg or was found in parameters node
          // Send directly to the visualisation
          _owner->sendValuedEvent( visuName, VisBase::ADD_VISUAL_OBJECT_EVENT_ID, prm ) ;
        }
        else
        { // No name was found
          // Fire signal to any visualisation which listens 
          // => each will creates its own visual object
          _owner->fireValuedSignal( VisBase::ADD_VISUAL_OBJECT_EVENT_ID, prm ) ;
        }
      }
      else
      { // Not ok, display the following message and exit
        OMTRACE( "Error for object \"" << _owner->getName().getString() << "\" (class "
                 << _owner->getObjectDescriptor().getClass().getString() << ")" << std::endl
                 << ">>> :-( Unable to load the visual object named \"" << id << "\"." ) ; 
      }
    }
  }

  // Read the parameters for animators
  const ConfigurationParameterDescriptor * animatorNode = node ? node->getSubDescriptorByName( "Animator" ) : 0 ;

  if( animatorNode )
  {
    int nbItems = animatorNode->getNumberOfSubItems() ;
    for( int i = 0 ; i < nbItems ; ++i )
    { 
      // Retrieve parameters sets for each animator
      std::string id = static_cast<const MultipleConfigurationParameter *>( animatorNode )->getNameOfSubDescriptor( i ) ;
      const ConfigurationParameterDescriptor * param = animatorNode->getSubDescriptorByPosition( i ) ;
      if( !loadAnimatorParameters( id, param, _owner, visuName, 0 ) && ok  )
      { // Not ok, display the following message and exit
        OMTRACE( "Error for object \"" << _owner->getName().getString() << "\" (class "
                 << _owner->getObjectDescriptor().getClass().getString() << ")" << std::endl
                 << ">>> :-( Unable to load the animator named \"" << id << "\"." << std::endl ) ; 
        ok = false ;
      }
    }
  }
  else
  {
    OMTRACE( "Warning for sender \"" << _owner->getName().getString() << "\" (class "
             << _owner->getObjectDescriptor().getClass().getString() << ")" << std::endl
             << ">>> :-| No Animator to create !" << std::endl ) ; 
  }
  return ok ;
}

bool VisObjectExtension::loadAnimatorParameters	(	const Name &	id,
		const ConfigurationParameterDescriptor *	node,
		SimulatedObject *	sender,
		const Name &	visName,
		const Name *	visualObjectName
	)			[static, protected]

See How to create Animators.

Definition at line 134 of file OMKVisObjectExtension.cpp.

References OMK::Vis::VisBase::ADD_ANIMATOR_EVENT_ID, OMK::SimulatedObject::fireValuedSignal(), OMK::ObjectDescriptor::getClass(), OMK::SimulatedObject::getName(), OMK::SimulatedObject::getObjectDescriptor(), OMK::Name::getString(), OMK::Type::AddAnimatorPrm::getVisualObjectName(), OMK::Type::AddAnimatorPrm::getVisuName(), OMK::Type::AddAnimatorPrm::loadParameters(), OMASSERTM, OMK_DEBUG_VIS_EXEC, OMTRACEID, OMK::SimulatedObject::sendValuedEvent(), OMK::Type::AddAnimatorPrm::setObjectName(), and OMK::Type::AddAnimatorPrm::setVisualObjectName().

Referenced by loadObjectParameters(), and OMK::Vis::VisBase::processAddVisualObjectEvent().

{
  OMASSERTM( sender, "Must be a valid pointer on a simulated object" ) ;
  // read parameters, if unable return false
  AddAnimatorPrm prm ;
  if( !prm.loadParameters( node, "", sender ) ) return false ;

  prm.setObjectName( id ) ;
  if( visualObjectName ) 
  {
    OMASSERTM( ( prm.getVisualObjectName() == *visualObjectName || prm.getVisualObjectName() == Name() ),
               "The visual object owner name must be egal or null" ) ;
    prm.setVisualObjectName( *visualObjectName ) ;
  }
  OMASSERTM( prm.getVisualObjectName() != Name(),
             "The visual object owner name cannot be null" ) ;

  // Try to find the name of the visualisation
  // Try to find the name of the visualisation
  Name visuName( prm.getVisuName() != Name() ? prm.getVisuName() : visuNameTmp ) ;

  OMTRACEID( OMK_DEBUG_VIS_EXEC, "Sender \"" << sender->getName().getString() << "\" (class "
             << sender->getObjectDescriptor().getClass().getString() << ")" << std::endl
             << ">>> visualisation \"" << visuName << "\"" << std::endl
             << ">>> object name \"" << id << "\"" << std::endl
             << ">>> event \"" << prm << "\"" << std::endl ) ; 

  // sends the appropriate event to create the visual objects
  if( visuName != Name() )
  { // A name was in arg or was found in parameters node
    // Send directly to the visualisation
    sender->sendValuedEvent( visuName , VisBase::ADD_ANIMATOR_EVENT_ID, prm ) ;
    OMTRACEID( OMK_DEBUG_VIS_EXEC, "VisBase::loadAnimatorParameters" << std::endl 
               << ">>> :-) Send the event to create the animator to \"" << visuName << "\" ok" << std::endl ) ;
  }
  else
  { // No name was found
    // Fire signal to any visualisation which listens 
    // => each will creates its own visual object
    sender->fireValuedSignal( VisBase::ADD_ANIMATOR_EVENT_ID, prm ) ;
    OMTRACEID( OMK_DEBUG_VIS_EXEC, "VisBase::loadAnimatorParameters" << std::endl 
               << ">>> :-) Fire the signal to create the animator ok" << std::endl ) ;
  }

  return true ;
}

---

Friends And Related Function Documentation

friend class VisBase [friend]

Definition at line 26 of file OMKVisObjectExtension.h.

---