OMK::BasicHumano Class Reference

Base class for humano simulated objects. More...

#include <OMKBasicHumano.h>

Inheritance diagram for OMK::BasicHumano:

[legend]Collaboration diagram for OMK::BasicHumano:

[legend]List of all members.

Public Member Functions
virtual	~BasicHumano ()
	Destructor.
Protected Member Functions
	BasicHumano (Controller &ctrl, const ObjectDescriptor &objectDescriptor)
	Constructor.
virtual bool	loadParameters (const ConfigurationParameterDescriptor *node)
	Configuration parameters loader of BasicHumano.
virtual void	computeParameters ()
	This a part of the compute method.
virtual OMK::Type::AddVisualObjectPrm	getVisualObjectPrm (ConfigurationParameterDescriptor *node) const
	The parameter to create the associated avatar visual object.
virtual HBT::InitialisationSequence *	getInitialiseSequence ()=0
	To get the initialisation sequence.
Protected Attributes
bool	_initDone
	Initialisation flag.
AttributeT< Type::Transform >	_position
	Position.

---

Detailed Description

Base class for humano simulated objects.

This class provides the basic items to manage a humano. It creates automatically an avatar visual object and fires the initialisation sequence.

Definition at line 23 of file OMKBasicHumano.h.

---

Constructor & Destructor Documentation

BasicHumano::BasicHumano	(	Controller &	ctrl,
		const ObjectDescriptor &	objectDescriptor
	)			[protected]

Constructor.

It is protected, because it is only called by the friend creator.

Definition at line 12 of file OMKBasicHumano.cpp.

References _position, and OMK::ExtensibleSimulatedObject::addAttribute().

: ExtensibleSimulatedObject( ctrl, objectDescriptor ),
  _initDone( false ),
  _position( "PositionMKM", Transform() )
{ 
  addAttribute( _position, true ) ;
}

BasicHumano::~BasicHumano

(

)

[virtual]

Destructor.

Definition at line 22 of file OMKBasicHumano.cpp.

{
}

---

Member Function Documentation

bool BasicHumano::loadParameters

(

const ConfigurationParameterDescriptor *

node

)

[protected, virtual]

Configuration parameters loader of BasicHumano.

This initialisation fire a signal to create the visual object in all the visualisations. To get the parameter to create the associated avatar visual object it calls getVisualObjectPrm.

Reimplemented from OMK::ExtensibleSimulatedObject.

Reimplemented in OMK::HumanoPlayer.

Definition at line 26 of file OMKBasicHumano.cpp.

References OMK::ConfigurationParameterDescriptor::clone(), OMK::SimulatedObject::fireValuedSignal(), getVisualObjectPrm(), and OMK::ExtensibleSimulatedObject::loadParameters().

Referenced by OMK::HumanoPlayer::loadParameters().

{
  ConfigurationParameterDescriptor* modifiedNode( node->clone() ) ;
  fireValuedSignal( VisBase::ADD_VISUAL_OBJECT_EVENT_ID, getVisualObjectPrm( modifiedNode ) ) ;
  delete modifiedNode ;
  return ExtensibleSimulatedObject::loadParameters( node ) ;
}

void BasicHumano::computeParameters

(

)

[protected, virtual]

This a part of the compute method.

Fire the signal which includes the initialisation sequence at the first call. This initialises the associated avatar visual object.

Reimplemented from OMK::ExtensibleSimulatedObject.

Reimplemented in OMK::HumanoPlayer, and OMK::MKMHumano.

Definition at line 39 of file OMKBasicHumano.cpp.

References _initDone, OMK::SimulatedObject::fireValuedSignal(), getInitialiseSequence(), and OMK::EventId::INITIALISATION_SEQUENCE.

Referenced by OMK::MKMHumano::computeParameters(), and OMK::HumanoPlayer::computeParameters().

{
  if( !_initDone ) 
  {
    HBT::InitialisationSequence* initialisationSequence = getInitialiseSequence();
    if( initialisationSequence )
    {
      _initDone = true ;
      fireValuedSignal( EventId::INITIALISATION_SEQUENCE, InitialisationSequenceType( *initialisationSequence ) ) ;
    }
  }
}

AddVisualObjectPrm BasicHumano::getVisualObjectPrm

(

ConfigurationParameterDescriptor *

node

)

const [protected, virtual]

The parameter to create the associated avatar visual object.

Returns:

The basic parameters to create a avatar visual object.

This function is called by loadParameters.

Reimplemented in OMK::MovingHumano.

Definition at line 34 of file OMKBasicHumano.cpp.

References OMK::SimulatedObject::getName().

Referenced by OMK::MovingHumano::getVisualObjectPrm(), and loadParameters().

{
  return AddVisualObjectPrm( getName().getString(), "AvatarVisualObject", "", node ) ;
}

virtual HBT::InitialisationSequence* OMK::BasicHumano::getInitialiseSequence

(

)

[protected, pure virtual]

To get the initialisation sequence.

Returns:

A pointer to a valid initialisation sequence to fire to the associated avatar visual objects.

This function is used by computeParameters to get the initialisation sequence. It is implemented in sons classes.

Implemented in OMK::MovingHumano, and OMK::StaticHumano.

Referenced by computeParameters().

---

Member Data Documentation

bool OMK::BasicHumano::_initDone [protected]

Initialisation flag.

Set to true when the InitialisationSequence has been sent, false before.

Definition at line 58 of file OMKBasicHumano.h.

Referenced by OMK::MKMHumano::computeParameters(), OMK::HumanoPlayer::computeParameters(), and computeParameters().

AttributeT< Type::Transform > OMK::BasicHumano::_position [protected]

Position.

Humano position, only for read.

Definition at line 61 of file OMKBasicHumano.h.

Referenced by BasicHumano(), OMK::MKMHumano::computeParameters(), and OMK::StaticHumano::getInitialiseSequence().

---