ParticleEmitter2 Class Reference
A system for running and managing particle emitters. A particle emitter is defined using the <particle_emitter> SDF element. More...
#include <ParticleEmitter2.hh>
Public Member Functions | |
ParticleEmitter2 () | |
Constructor. More... | |
void | Configure (const Entity &_entity, const std::shared_ptr< const sdf::Element > &_sdf, EntityComponentManager &_ecm, EventManager &_eventMgr) override |
Configure the system. More... | |
void | PreUpdate (const ignition::gazebo::UpdateInfo &_info, ignition::gazebo::EntityComponentManager &_ecm) override |
Public Member Functions inherited from System | |
System ()=default | |
Constructor. More... | |
virtual | ~System ()=default |
Destructor. More... | |
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
- Todo:
- (nkoenig) Plan for ParticleEmitter and ParticleEmitter2:
- Deprecate ParticleEmitter in Ignition Fortress.
- Remove ParticleEmitter in Ignition G.
- Copy ParticleEmitter2 to ParticleEmitter in Ignition G.
- Deprecrate ParticleEmitter2 in Ignition G.
- Remove ParticleEmitter2 in Ignition H.
Constructor & Destructor Documentation
◆ ParticleEmitter2()
ParticleEmitter2 | ( | ) |
Constructor.
Member Function Documentation
◆ Configure()
|
overridevirtual |
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.
◆ PreUpdate()
|
overridevirtual |
Implements ISystemPreUpdate.
The documentation for this class was generated from the following file: