EnvironmentPreload Class Reference
A plugin to preload an Environment component into the ECM upon simulation start-up. More...
#include <gz/sim/systems/EnvironmentPreload.hh>
Public Member Functions | |
| EnvironmentPreload () | |
| Constructor. More... | |
| ~EnvironmentPreload () override | |
| Destructor. More... | |
| void | Configure (const Entity &_entity, const std::shared_ptr< const sdf::Element > &_sdf, EntityComponentManager &_ecm, sim::EventManager &_eventMgr) final |
| Configure the system. More... | |
| void | PreUpdate (const UpdateInfo &_info, EntityComponentManager &_ecm) final |
 Public Member Functions inherited from System | |
| System ()=default | |
| Constructor. More... | |
| virtual | ~System ()=default |
| Destructor. More... | |
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. More... | |
| Static Public Attributes inherited from System | |
| constexpr static PriorityType | kDefaultPriority = {0} |
| Default priority value for execution order of the PreUpdate and Update phases. More... | |
| constexpr static std::string_view | kPriorityElementName |
| Name of the XML element from which the priority value will be parsed. More... | |
Detailed Description
A plugin to preload an Environment component into the ECM upon simulation start-up.
Constructor & Destructor Documentation
◆ EnvironmentPreload()
|
explicit |
Constructor.
◆ ~EnvironmentPreload()
|
override |
Destructor.
Member Function Documentation
◆ Configure()
|
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.
◆ PreUpdate()
|
finalvirtual |
Implements ISystemPreUpdate.
The documentation for this class was generated from the following file: