Base class for a System. More...

#include <gz/sim/systems/Physics.hh>

Public Member Functions
	Physics ()
	Constructor.

	~Physics () override
	Destructor.

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

System::PriorityType	ConfigurePriority () final
	Documentation inherited.

void	Reset (const UpdateInfo &_info, EntityComponentManager &_ecm) final

void	Update (const UpdateInfo &_info, EntityComponentManager &_ecm) final

Public Member Functions inherited from System
	System ()=default
	Constructor.

virtual	~System ()=default
	Destructor.

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

Base class for a System.

System Parameters

<include_entity_names>: Optional. When set to false, the name of colliding entities is not populated in the contacts. Remains true by default.

Example

<plugin
  filename="gz-sim-physics-system"
  name="systems::Physics">
  <contacts>
    <include_entity_names>false</include_entity_names>
  </contacts>
</plugin>

Constructor & Destructor Documentation

◆ Physics()

Physics ( )

explicit

Constructor.

◆ ~Physics()

~Physics ( )

override

Destructor.

Member Function Documentation

◆ Configure()

void Configure	(	const Entity &	_entity,
		const std::shared_ptr< const sdf::Element > &	_sdf,
		EntityComponentManager &	_ecm,
		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.