Gazebo Sim

API Reference

10.0.0
List of all members | Public Member Functions
ParticleEmitter Class Reference

A system for running and managing particle emitters. A particle emitter is defined using the <particle_emitter> SDF element. More...

#include <ParticleEmitter.hh>

Public Member Functions

 ParticleEmitter ()
 Constructor.
 
void Configure (const Entity &_entity, const std::shared_ptr< const sdf::Element > &_sdf, EntityComponentManager &_ecm, EventManager &_eventMgr) override
 Configure the system.
 
void PreUpdate (const UpdateInfo &_info, EntityComponentManager &_ecm) override
 
- Public Member Functions inherited from System
 System ()=default
 Constructor.
 
virtual ~System ()=default
 Destructor.
 
- Public Member Functions inherited from ISystemConfigure
virtual ~ISystemConfigure ()=default
 
- Public Member Functions inherited from ISystemPreUpdate
virtual ~ISystemPreUpdate ()=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 system for running and managing particle emitters. A particle emitter is defined using the <particle_emitter> SDF element.

This system will create a transport subscriber for each <particle_emitter> using the child <topic> name. If a <topic> is not specified, the following topic naming scheme will be used: /model/{model_name}/link/{link_name}/particle_emitter/{emitter_name}/cmd

Constructor & Destructor Documentation

◆ ParticleEmitter()

ParticleEmitter ( )

Constructor.

Member Function Documentation

◆ Configure()

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

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.

◆ PreUpdate()

void PreUpdate ( const UpdateInfo &  _info,
EntityComponentManager &  _ecm 
)
overridevirtual

Implements ISystemPreUpdate.

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