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

Interface class that allows for retrieval of segmentation class information. More...

#include <ClassSegmentationBus.h>

Public Member Functions

 AZ_RTTI (ClassSegmentationRequests, "{69b4109e-25ff-482f-b92e-f19cdf06bce2}")
 
virtual AZ::Color GetClassColor (uint8_t classId) const =0
 
virtual AZStd::optional< uint8_t > GetClassIdForTag (LmbrCentral::Tag tag) const =0
 
virtual const SegmentationClassConfigList & GetClassConfigList () const =0
 Returns a reference to the segmentation config list.
 

Detailed Description

Interface class that allows for retrieval of segmentation class information.

Member Function Documentation

◆ GetClassColor()

virtual AZ::Color ROS2::ClassSegmentationRequests::GetClassColor ( uint8_t  classId) const
pure virtual

Returns the color of segmentation class with the provided class ID. If no segmentation class is found with provided class ID, returns AZ::Colors::White.

Parameters
classIdClass ID of the segmentation class.
Returns
Color of the class with provided ID.

◆ GetClassIdForTag()

virtual AZStd::optional< uint8_t > ROS2::ClassSegmentationRequests::GetClassIdForTag ( LmbrCentral::Tag  tag) const
pure virtual

If segmentation class exists that is associated with provided tag, returns ID of this class. Otherwise, returns AZStd::nullopt;

Parameters
tagTag associated with the segmentation class.
Returns
ID of found class or AZStd::nullopt.

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