argos::CCameraDefaultSensor Class Reference

#include <camera_default_sensor.h>

Inheritance diagram for argos::CCameraDefaultSensor:
Collaboration diagram for argos::CCameraDefaultSensor:

Classes

struct  SSensor
 

Public Member Functions

 CCameraDefaultSensor ()
 
virtual ~CCameraDefaultSensor ()
 
virtual void SetRobot (CComposableEntity &c_entity)
 Sets the entity associated to this sensor. More...
 
virtual void Init (TConfigurationNode &t_tree)
 Initializes the sensor from the XML configuration tree. More...
 
virtual void Update ()
 Updates the state of the entity associated to this sensor, if the sensor is currently enabled. More...
 
- Public Member Functions inherited from argos::CSimulatedSensor
virtual ~CSimulatedSensor ()
 Class destructor. More...
 
- Public Member Functions inherited from argos::CCI_CameraSensor
 CCI_CameraSensor ()
 Constructor. More...
 
virtual ~CCI_CameraSensor ()
 Destructor. More...
 
const SInterface::TVectorGetInterfaces () const
 Returns a const reference to the camera interfaces. More...
 
- Public Member Functions inherited from argos::CCI_Sensor
virtual ~CCI_Sensor ()
 Class destructor. More...
 
virtual void Reset ()
 Resets the sensor to the state it had just after Init(). More...
 
virtual void Destroy ()
 Destroys the sensor. More...
 
virtual void Enable ()
 Enables updating of sensor information in the event loop. More...
 
virtual void Disable ()
 Disables updating of sensor information in the event loop. More...
 
bool IsEnabled () const
 
bool IsDisabled () const
 
- Public Member Functions inherited from argos::CBaseConfigurableResource
virtual ~CBaseConfigurableResource ()
 Class destructor. More...
 

Protected Attributes

bool m_bShowFrustum
 
CEmbodiedEntitym_pcEmbodiedEntity
 
CControllableEntitym_pcControllableEntity
 
std::vector< SSensorm_vecSensors
 
- Protected Attributes inherited from argos::CCI_CameraSensor
SInterface::TVector m_vecInterfaces
 

Additional Inherited Members

- Public Types inherited from argos::CCI_Sensor
typedef std::map< std::string, CCI_Sensor *, std::less< std::string > > TMap
 

Detailed Description

Definition at line 23 of file camera_default_sensor.h.

Constructor & Destructor Documentation

◆ CCameraDefaultSensor()

argos::CCameraDefaultSensor::CCameraDefaultSensor ( )

Definition at line 17 of file camera_default_sensor.cpp.

◆ ~CCameraDefaultSensor()

virtual argos::CCameraDefaultSensor::~CCameraDefaultSensor ( )
inlinevirtual

Definition at line 60 of file camera_default_sensor.h.

Member Function Documentation

◆ Init()

void argos::CCameraDefaultSensor::Init ( TConfigurationNode t_node)
virtual

Initializes the sensor from the XML configuration tree.

The default implementation of this method does nothing.

Parameters
t_nodeThe XML configuration tree relative to this sensor.
See also
Reset()
Destroy()

Reimplemented from argos::CCI_Sensor.

Definition at line 34 of file camera_default_sensor.cpp.

◆ SetRobot()

void argos::CCameraDefaultSensor::SetRobot ( CComposableEntity c_entity)
virtual

Sets the entity associated to this sensor.

When a controller is created, all the sensors and actuators are created, too. This function is called right before the Init() method of the sensor is called.

Parameters
c_entityThe entity to associate to this sensor.
See also
CComposableEntity
CControllableEntity::SetController()
CCI_Sensor::Init()

Implements argos::CSimulatedSensor.

Definition at line 25 of file camera_default_sensor.cpp.

◆ Update()

void argos::CCameraDefaultSensor::Update ( )
virtual

Updates the state of the entity associated to this sensor, if the sensor is currently enabled.

If it is disabled, then this function should do nothing.

Implements argos::CSimulatedSensor.

Definition at line 128 of file camera_default_sensor.cpp.

Member Data Documentation

◆ m_bShowFrustum

bool argos::CCameraDefaultSensor::m_bShowFrustum
protected

Definition at line 69 of file camera_default_sensor.h.

◆ m_pcControllableEntity

CControllableEntity* argos::CCameraDefaultSensor::m_pcControllableEntity
protected

Definition at line 71 of file camera_default_sensor.h.

◆ m_pcEmbodiedEntity

CEmbodiedEntity* argos::CCameraDefaultSensor::m_pcEmbodiedEntity
protected

Definition at line 70 of file camera_default_sensor.h.

◆ m_vecSensors

std::vector<SSensor> argos::CCameraDefaultSensor::m_vecSensors
protected

Definition at line 72 of file camera_default_sensor.h.