Label Class Reference

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

Additional Inherited Members
Public Types inherited from System
using	PriorityType = int32_t
	Signed integer type used for specifying priority of the execution order of PreUpdate and Update phases.
Static Public Attributes inherited from System
static constexpr PriorityType	kDefaultPriority = {0}
	Default priority value for execution order of the PreUpdate and Update phases.
static constexpr std::string_view	kPriorityElementName
	Name of the XML element from which the priority value will be parsed.

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, sim::EventManager &  _eventMgr  )

finalvirtual

Configure the system.

Parameters

[in]	_entity	The entity this plugin is attached to.
[in]	_sdf	The SDF Element associated with this system plugin.
[in]	_ecm	The EntityComponentManager of the given simulation instance.
[in]	_eventMgr	The EventManager of the given simulation instance.

Implements ISystemConfigure.

---

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

• Label.hh