Ignition Gazebo

API Reference

6.1.0

A label plugin that annotates models by setting the label for the parent entity's visuals. The plugin can be attached to models, visuals, or actors. More...

#include <Label.hh>

Public Member Functions

 Label ()
 Constructor. More...
 
 ~Label () override
 Destructor. More...
 
void Configure (const Entity &_entity, const std::shared_ptr< const sdf::Element > &_sdf, EntityComponentManager &_ecm, gazebo::EventManager &_eventMgr) final
 Configure the system. More...
 
- Public Member Functions inherited from System
 System ()=default
 Constructor. More...
 
virtual ~System ()=default
 Destructor. More...
 

Detailed Description

A label plugin that annotates models by setting the label for the parent entity's visuals. The plugin can be attached to models, visuals, or actors.

Ex: "<label>1</label>" means the visual has a label of 1 Label value must be in [0-255] range

Constructor & Destructor Documentation

◆ Label()

Label ( )
explicit

Constructor.

◆ ~Label()

~Label ( )
override

Destructor.

Member Function Documentation

◆ Configure()

void Configure ( const Entity _entity,
const std::shared_ptr< const sdf::Element > &  _sdf,
EntityComponentManager _ecm,
gazebo::EventManager _eventMgr 
)
finalvirtual

Configure the system.

Parameters
[in]_entityThe entity this plugin is attached to.
[in]_sdfThe SDF Element associated with this system plugin.
[in]_ecmThe EntityComponentManager of the given simulation instance.
[in]_eventMgrThe EventManager of the given simulation instance.

Implements ISystemConfigure.


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