An magnetometer sensor that reports the magnetic field in its current location. More...

Public Member Functions
	Magnetometer ()
	Constructor. More...

	~Magnetometer () override
	Destructor. More...

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

void	PostUpdate (const UpdateInfo &_info, const EntityComponentManager &_ecm) final
	Documentation inherited. More...

void	PreUpdate (const UpdateInfo &_info, EntityComponentManager &_ecm) final
	Documentation inherited. More...

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

An magnetometer sensor that reports the magnetic field in its current location.

Constructor & Destructor Documentation

Magnetometer ( )

explicit

Constructor.

~Magnetometer ( )

override

Destructor.

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

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.