Open 3D Engine ROS2 Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
ROS2::ROS2CameraSensorComponent Class Reference

#include <ROS2CameraSensorComponent.h>

Inherits ROS2::ROS2SensorComponentBase< TickBasedSource >, and CameraCalibrationRequestBus::Handler.

Public Member Functions

 ROS2CameraSensorComponent (const SensorConfiguration &sensorConfiguration, const CameraSensorConfiguration &cameraConfiguration)
 
 AZ_COMPONENT (ROS2CameraSensorComponent, "{3C6B8AE6-9721-4639-B8F9-D8D28FD7A071}", SensorBaseType)
 
void Activate () override
 
void Deactivate () override
 
AZ::Matrix3x3 GetCameraMatrix () const override
 
int GetWidth () const override
 
int GetHeight () const override
 
float GetVerticalFOV () const override
 
- Public Member Functions inherited from ROS2::ROS2SensorComponentBase< TickBasedSource >
 AZ_COMPONENT_DECL ((ROS2SensorComponentBase, AZ_CLASS))
 
void Activate () override
 
void Deactivate () override
 

Static Public Member Functions

static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &required)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incompatible)
 
static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void Reflect (AZ::ReflectContext *context)
 
- Static Public Member Functions inherited from ROS2::ROS2SensorComponentBase< TickBasedSource >
static void Reflect (AZ::ReflectContext *context)
 
static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &required)
 

Additional Inherited Members

- Public Types inherited from ROS2::ROS2SensorComponentBase< TickBasedSource >
using SensorBaseType = ROS2SensorComponentBase< TickBasedSource >
 
- Protected Member Functions inherited from ROS2::ROS2SensorComponentBase< TickBasedSource >
void StartSensor (float sensorFrequency, typename EventSourceT::AdaptedCallbackType adaptedCallback, typename EventSourceT::SourceCallbackType sourceCallback=nullptr)
 
void StopSensor ()
 Stops sensor and disconnects event callbacks passed through RSO2::ROS2SensorComponentBase::StartSensor.
 
AZStd::string GetNamespace () const
 Returns a complete namespace for this sensor topics and frame ids.
 
AZStd::string GetFrameID () const
 Returns this sensor frame ID. The ID contains namespace.
 
- Protected Attributes inherited from ROS2::ROS2SensorComponentBase< TickBasedSource >
SensorConfiguration m_sensorConfiguration
 Basic sensor configuration.
 
EventSourceAdapter< TickBasedSourcem_eventSourceAdapter
 Adapter for selected event source (see this class documentation).
 
EventSourceT::SourceEventHandlerType m_sourceEventHandler
 Handler for source event. Requires manual assignment and connecting to source event in derived class.
 
EventSourceT::AdaptedEventHandlerType m_adaptedEventHandler
 Handler for adapted event. Requires manual assignment and connecting to adapted event in derived class.
 

Detailed Description

ROS2 Camera sensor component class Allows turning an entity into a camera sensor Can be parametrized with following values:

  • camera name
  • camera image width and height in pixels
  • camera vertical field of view in degrees Camera frustum is facing negative Z axis; image plane is parallel to X,Y plane: X - right, Y - up

The documentation for this class was generated from the following file: