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::LidarCore Class Reference

A class for executing lidar operations, such as data acquisition and visualization. More...

#include <LidarCore.h>

Public Member Functions

 AZ_TYPE_INFO (LidarCore, "{e46126a2-7a86-bb65-367a-416f2cab393c}")
 
 LidarCore (const AZStd::vector< LidarTemplate::LidarModel > &availableModels={})
 
 LidarCore (const LidarSensorConfiguration &lidarConfiguration)
 
void Init (AZ::EntityId entityId)
 
void Deinit ()
 Deinitialize when deactivating the lidar.
 
RaycastResult PerformRaycast ()
 
void VisualizeResults () const
 Visualize the results of the last performed raycast.
 
LidarId GetLidarRaycasterId () const
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Public Attributes

LidarSensorConfiguration m_lidarConfiguration
 Configuration according to which the lidar performs its raycasts.
 

Detailed Description

A class for executing lidar operations, such as data acquisition and visualization.

Member Function Documentation

◆ GetLidarRaycasterId()

LidarId ROS2::LidarCore::GetLidarRaycasterId ( ) const

Get the raycaster used by this lidar.

Returns
Used raycaster's id.

◆ Init()

void ROS2::LidarCore::Init ( AZ::EntityId  entityId)

Initialize when activating the lidar.

Parameters
entityIdEntity from which the rays are sent.

◆ PerformRaycast()

RaycastResult ROS2::LidarCore::PerformRaycast ( )

Perform a raycast.

Returns
Results of the raycast.

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