argos::CPositionalEntity Class Reference

#include <positional_entity.h>

Inheritance diagram for argos::CPositionalEntity:
Collaboration diagram for argos::CPositionalEntity:

Public Member Functions

 ENABLE_VTABLE ()
 
 CPositionalEntity (CComposableEntity *pc_parent)
 
 CPositionalEntity (CComposableEntity *pc_parent, const std::string &str_id, const CVector3 &c_position=CVector3(), const CQuaternion &c_orientation=CQuaternion())
 
virtual void Init (TConfigurationNode &t_tree)
 Initializes the state of the entity from the XML configuration tree. More...
 
virtual void Reset ()
 Resets the state of the entity to whatever it was after Init() or the standalone constructor was called. More...
 
const CVector3GetPosition () const
 
const CVector3GetInitPosition () const
 
void SetPosition (const CVector3 &c_position)
 
void SetInitPosition (const CVector3 &c_position)
 
const CQuaternionGetOrientation () const
 
const CQuaternionGetInitOrientation () const
 
void SetOrientation (const CQuaternion c_orientation)
 
void SetInitOrientation (const CQuaternion c_orientation)
 
virtual void MoveTo (const CVector3 &c_position, const CQuaternion &c_orientation)
 
virtual std::string GetTypeDescription () const
 Returns a string label for this class. More...
 
- Public Member Functions inherited from argos::CEntity
 ENABLE_VTABLE ()
 
 CEntity (CComposableEntity *pc_parent)
 Class constructor. More...
 
 CEntity (CComposableEntity *pc_parent, const std::string &str_id)
 Class constructor. More...
 
virtual ~CEntity ()
 Class destructor. More...
 
virtual void Destroy ()
 Destroys the entity, undoing whatever was done by Init() or by the standalone constructor. More...
 
const std::string & GetId () const
 Returns the id of this entity. More...
 
std::string GetContext () const
 Returns the context of this entity. More...
 
bool HasParent () const
 Returns true if this entity has a parent. More...
 
CEntityGetRootEntity ()
 Returns the root entity containing this entity. More...
 
const CEntityGetRootEntity () const
 Returns the root entity containing this entity. More...
 
CComposableEntityGetParent ()
 Returns this entity's parent. More...
 
const CComposableEntityGetParent () const
 Returns this entity's parent. More...
 
void SetParent (CComposableEntity &c_parent)
 Sets this entity's parent. More...
 
virtual void Update ()
 Updates the state of this entity. More...
 
ssize_t GetIndex () const
 Returns the entity index. More...
 
void SetIndex (ssize_t n_idx)
 Sets the entity index. More...
 
bool IsEnabled () const
 Returns true if the entity is enabled. More...
 
void Enable ()
 Enables the entity. More...
 
void Disable ()
 Disables the entity. More...
 
virtual void SetEnabled (bool b_enabled)
 Enables or disables an entity. More...
 
TConfigurationNodeGetConfigurationNode ()
 Returns a pointer to the configuration node that was used to create this entity. More...
 
- Public Member Functions inherited from argos::CBaseConfigurableResource
virtual ~CBaseConfigurableResource ()
 Class destructor. More...
 
- Public Member Functions inherited from argos::EnableVTableFor< CEntity >
size_t GetTagHelper (const DERIVED *) const
 

Additional Inherited Members

- Public Types inherited from argos::CEntity
typedef std::vector< CEntity * > TVector
 A vector of entities. More...
 
typedef unordered_map< std::string, CEntity * > TMap
 A map of entities. More...
 
typedef std::multimap< std::string, CEntity * > TMultiMap
 A multi-map of entities. More...
 

Detailed Description

Definition at line 20 of file positional_entity.h.

Constructor & Destructor Documentation

argos::CPositionalEntity::CPositionalEntity ( CComposableEntity pc_parent)

Definition at line 18 of file positional_entity.cpp.

argos::CPositionalEntity::CPositionalEntity ( CComposableEntity pc_parent,
const std::string &  str_id,
const CVector3 c_position = CVector3(),
const CQuaternion c_orientation = CQuaternion() 
)

Definition at line 24 of file positional_entity.cpp.

Member Function Documentation

argos::CPositionalEntity::ENABLE_VTABLE ( )
const CQuaternion& argos::CPositionalEntity::GetInitOrientation ( ) const
inline

Definition at line 56 of file positional_entity.h.

const CVector3& argos::CPositionalEntity::GetInitPosition ( ) const
inline

Definition at line 40 of file positional_entity.h.

const CQuaternion& argos::CPositionalEntity::GetOrientation ( ) const
inline

Definition at line 52 of file positional_entity.h.

const CVector3& argos::CPositionalEntity::GetPosition ( ) const
inline

Definition at line 36 of file positional_entity.h.

virtual std::string argos::CPositionalEntity::GetTypeDescription ( ) const
inlinevirtual

Returns a string label for this class.

Returns
A string label for this class.

Reimplemented from argos::CEntity.

Reimplemented in argos::CTagEntity, argos::CRadioEntity, argos::CDirectionalLEDEntity, argos::CLEDEntity, argos::CRABEquippedEntity, and argos::CLightEntity.

Definition at line 71 of file positional_entity.h.

void argos::CPositionalEntity::Init ( TConfigurationNode t_tree)
virtual

Initializes the state of the entity from the XML configuration tree.

If the id of the entity has not been set yet, this method sets an id for the entity. If the entity has no parent, this method parses the passed XML tree and looks for the id attribute, setting its value as id. If, instead, this entity has a parent, the id is set as GetParent().GetId() + "." + GetTypeDescription().

Exceptions
CARGoSExceptionif a parse error occurred

Reimplemented from argos::CEntity.

Reimplemented in argos::CRABEquippedEntity, argos::CDirectionalLEDEntity, argos::CTagEntity, argos::CLEDEntity, argos::CRadioEntity, and argos::CLightEntity.

Definition at line 37 of file positional_entity.cpp.

void argos::CPositionalEntity::MoveTo ( const CVector3 c_position,
const CQuaternion c_orientation 
)
virtual

Definition at line 65 of file positional_entity.cpp.

void argos::CPositionalEntity::Reset ( )
virtual

Resets the state of the entity to whatever it was after Init() or the standalone constructor was called.

The default implementation of this method does nothing.

Reimplemented from argos::CEntity.

Reimplemented in argos::CRABEquippedEntity, argos::CDirectionalLEDEntity, argos::CTagEntity, argos::CLEDEntity, and argos::CRadioEntity.

Definition at line 56 of file positional_entity.cpp.

void argos::CPositionalEntity::SetInitOrientation ( const CQuaternion  c_orientation)
inline

Definition at line 64 of file positional_entity.h.

void argos::CPositionalEntity::SetInitPosition ( const CVector3 c_position)
inline

Definition at line 48 of file positional_entity.h.

void argos::CPositionalEntity::SetOrientation ( const CQuaternion  c_orientation)
inline

Definition at line 60 of file positional_entity.h.

void argos::CPositionalEntity::SetPosition ( const CVector3 c_position)
inline

Definition at line 44 of file positional_entity.h.