EnvironmentPreload Class Reference

A plugin to preload an Environment component into the ECM upon simulation start-up. More...

#include <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...

Detailed Description

A plugin to preload an Environment component into the ECM upon simulation start-up.

gz/sim/systems/EnvironmentPreload.hh

Constructor & Destructor Documentation

EnvironmentPreload()

EnvironmentPreload ( )

explicit

Constructor.

~EnvironmentPreload()

~EnvironmentPreload ( )

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.

PreUpdate()

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

finalvirtual

Implements ISystemPreUpdate.

---

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

• EnvironmentPreload.hh