argos::CPerspectiveCameraEquippedEntity Class Reference

#include <perspective_camera_equipped_entity.h>

Inheritance diagram for argos::CPerspectiveCameraEquippedEntity:
Collaboration diagram for argos::CPerspectiveCameraEquippedEntity:

Public Member Functions

 ENABLE_VTABLE ()
 
 CPerspectiveCameraEquippedEntity (CComposableEntity *pc_parent)
 Class constructor. More...
 
 CPerspectiveCameraEquippedEntity (CComposableEntity *pc_parent, const std::string &str_id, const CRadians &c_aperture, Real f_focal_length, Real f_range, SInt32 n_width, SInt32 n_height, SAnchor &s_anchor)
 Class constructor. More...
 
virtual void Init (TConfigurationNode &t_tree)
 Initializes the state of the entity from the XML configuration tree. More...
 
virtual void Enable ()
 
virtual void Disable ()
 
const CRadiansGetAperture () const
 Returns the aperture of the visibility cone of the camera. More...
 
void SetAperture (const CRadians &c_aperture)
 Sets the aperture of the visibility cone of the camera. More...
 
Real GetFocalLength () const
 Returns the focal length of the camera. More...
 
void SetFocalLength (Real f_focal_length)
 Sets the focal length of the camera. More...
 
Real GetRange () const
 Returns the range of the camera. More...
 
void SetRange (Real f_range)
 Sets the range of the camera. More...
 
const SAnchorGetAnchor () const
 Returns the offset of the camera with respect to the reference point. More...
 
void SetAnchor (SAnchor &s_anchor)
 Sets the anchor to which the camera is attached. More...
 
SInt32 GetImagePxWidth () const
 Returns the image width in pixel. More...
 
SInt32 GetImagePxHeight () const
 Returns the image height in pixel. More...
 
void SetImagePxSize (SInt32 n_width, SInt32 n_height)
 Sets the image size in pixel. More...
 
Real GetImageMtWidth () const
 Returns the image width in meters. More...
 
Real GetImageMtHeight () const
 Returns the image height in meters. More...
 
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 Reset ()
 Resets the state of the entity to whatever it was after Init() or the standalone constructor was called. 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 23 of file perspective_camera_equipped_entity.h.

Constructor & Destructor Documentation

argos::CPerspectiveCameraEquippedEntity::CPerspectiveCameraEquippedEntity ( CComposableEntity pc_parent)

Class constructor.

This constructor is meant to be used with the Init() method.

Parameters
pc_parentThe parent of this entity.

Definition at line 10 of file perspective_camera_equipped_entity.cpp.

argos::CPerspectiveCameraEquippedEntity::CPerspectiveCameraEquippedEntity ( CComposableEntity pc_parent,
const std::string &  str_id,
const CRadians c_aperture,
Real  f_focal_length,
Real  f_range,
SInt32  n_width,
SInt32  n_height,
SAnchor s_anchor 
)

Class constructor.

This constructor is meant to be standalone. You should not call Init() after using this constructor, or memory leaks are likely to happen.

Parameters
pc_parentThe parent of this entity.
str_idThe id of this entity.
c_apertureThe aperture of the visibility cone.
f_focal_lengthThe camera focal length.
f_rangeThe camera range.
n_widthThe image width in pixels.
n_heightThe image height in pixels.
s_anchorThe anchor to which the camera is attached.

Definition at line 23 of file perspective_camera_equipped_entity.cpp.

Member Function Documentation

void argos::CPerspectiveCameraEquippedEntity::Disable ( )
virtual

Definition at line 84 of file perspective_camera_equipped_entity.cpp.

void argos::CPerspectiveCameraEquippedEntity::Enable ( )
virtual

Definition at line 75 of file perspective_camera_equipped_entity.cpp.

argos::CPerspectiveCameraEquippedEntity::ENABLE_VTABLE ( )
const SAnchor& argos::CPerspectiveCameraEquippedEntity::GetAnchor ( ) const
inline

Returns the offset of the camera with respect to the reference point.

Returns
The offset of the camera with respect to the reference point.

Definition at line 123 of file perspective_camera_equipped_entity.h.

const CRadians& argos::CPerspectiveCameraEquippedEntity::GetAperture ( ) const
inline

Returns the aperture of the visibility cone of the camera.

Returns
The aperture of the visibility cone of the camera.

Definition at line 75 of file perspective_camera_equipped_entity.h.

Real argos::CPerspectiveCameraEquippedEntity::GetFocalLength ( ) const
inline

Returns the focal length of the camera.

Returns
The focal length of the camera.

Definition at line 91 of file perspective_camera_equipped_entity.h.

Real argos::CPerspectiveCameraEquippedEntity::GetImageMtHeight ( ) const
inline

Returns the image height in meters.

Returns
The image height in meters.

Definition at line 181 of file perspective_camera_equipped_entity.h.

Real argos::CPerspectiveCameraEquippedEntity::GetImageMtWidth ( ) const
inline

Returns the image width in meters.

Returns
The image width in meters.

Definition at line 173 of file perspective_camera_equipped_entity.h.

SInt32 argos::CPerspectiveCameraEquippedEntity::GetImagePxHeight ( ) const
inline

Returns the image height in pixel.

Returns
The image height in pixel.

Definition at line 147 of file perspective_camera_equipped_entity.h.

SInt32 argos::CPerspectiveCameraEquippedEntity::GetImagePxWidth ( ) const
inline

Returns the image width in pixel.

Returns
The image width in pixel.

Definition at line 139 of file perspective_camera_equipped_entity.h.

Real argos::CPerspectiveCameraEquippedEntity::GetRange ( ) const
inline

Returns the range of the camera.

Returns
The range of the camera.

Definition at line 107 of file perspective_camera_equipped_entity.h.

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

Returns a string label for this class.

Returns
A string label for this class.

Reimplemented from argos::CEntity.

Definition at line 185 of file perspective_camera_equipped_entity.h.

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

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

Exceptions
CARGoSExceptionif a parse error occurs

Reimplemented from argos::CEntity.

Definition at line 43 of file perspective_camera_equipped_entity.cpp.

void argos::CPerspectiveCameraEquippedEntity::SetAnchor ( SAnchor s_anchor)
inline

Sets the anchor to which the camera is attached.

Parameters
s_anchoranchor to which the camera is attached.

Definition at line 131 of file perspective_camera_equipped_entity.h.

void argos::CPerspectiveCameraEquippedEntity::SetAperture ( const CRadians c_aperture)
inline

Sets the aperture of the visibility cone of the camera.

Parameters
c_apertureThe aperture of the visibility cone of the camera.

Definition at line 83 of file perspective_camera_equipped_entity.h.

void argos::CPerspectiveCameraEquippedEntity::SetFocalLength ( Real  f_focal_length)
inline

Sets the focal length of the camera.

Parameters
c_focallengthThe focal length of the camera.

Definition at line 99 of file perspective_camera_equipped_entity.h.

void argos::CPerspectiveCameraEquippedEntity::SetImagePxSize ( SInt32  n_width,
SInt32  n_height 
)
inline

Sets the image size in pixel.

Parameters
un_widthThe image width in pixel.
un_heightThe image height in pixel.

Definition at line 156 of file perspective_camera_equipped_entity.h.

void argos::CPerspectiveCameraEquippedEntity::SetRange ( Real  f_range)
inline

Sets the range of the camera.

Parameters
c_rangeThe range of the camera.

Definition at line 115 of file perspective_camera_equipped_entity.h.