#include <World.hh>

Public Member Functions
	World ()
	Default constructor. More...

	World (World &&_world)
	Move constructor. More...

	~World ()
	Destructor. More...

std::string	AudioDevice () const
	Get the audio device name. More...

ignition::math::Vector3d	Gravity () const
	Get the acceleration due to gravity. More...

Errors	Load (ElementPtr _sdf)
	Load the world based on a element pointer. More...

ignition::math::Vector3d	MagneticField () const
	Get the magnetic vector in Tesla, expressed in a coordinate frame defined by the SphericalCoordinates property. More...

std::string	Name () const
	Get the name of the world. More...

void	SetAudioDevice (const std::string &_device)
	Set the audio device name. More...

void	SetGravity (const ignition::math::Vector3d &_gravity)
	Set the acceleration due to gravity. More...

void	SetMagneticField (const ignition::math::Vector3d &_mag)
	Set the magnetic vector in Tesla, expressed in a coordinate frame defined by the SphericalCoordinate. More...

void	SetName (const std::string &_name) const
	Set the name of the world. More...

void	SetWindLinearVelocity (const ignition::math::Vector3d &_wind)
	Set the wind linear velocity in the global/world coordinate frame. More...

ignition::math::Vector3d	WindLinearVelocity () const
	Get the wind linear velocity in the global/world coordinate frame. More...

Constructor & Destructor Documentation

sdf::World::World ( )

Default constructor.

sdf::World::World ( World && _world )

Move constructor.

Parameters

[in] _world World to move.

sdf::World::~World ( )

Destructor.

Member Function Documentation

std::string sdf::World::AudioDevice ( ) const

Get the audio device name.

The audio device can be used to playback audio files. A value of "default" or an empty string indicates that the system's default audio device should be used.

Returns: Audio device name.

ignition::math::Vector3d sdf::World::Gravity ( ) const

Get the acceleration due to gravity.

The default value is Earth's standard gravity at sea level, which equals [0, 0, -9.80665] \((\frac{m}{s^2})\)

Returns: Gravity vector in meters per second squared \((\frac{m}{s^2})\)

Errors sdf::World::Load ( ElementPtr _sdf )

Load the world based on a element pointer.

This is not the usual entry point. Typical usage of the SDF DOM is through the Root object.

Parameters

[in] _sdf The SDF Element pointer

Returns: Errors, which is a vector of Error objects. Each Error includes an error code and message. An empty vector indicates no error.

ignition::math::Vector3d sdf::World::MagneticField ( ) const

Get the magnetic vector in Tesla, expressed in a coordinate frame defined by the SphericalCoordinates property.

A spherical coordindate can be specified in SDF using the <spherical_coordinates> element.

Returns: Magnetic field vector.

See Also: SphericalCoordinates

std::string sdf::World::Name ( ) const

Get the name of the world.

Returns: Name of the world.

void sdf::World::SetAudioDevice ( const std::string & _device )

Set the audio device name.

See std::string AudioDevice() const for more information.

Parameters

[in] _device The new audio device name.

See Also: std::string AudioDevice() const

void sdf::World::SetGravity ( const ignition::math::Vector3d & _gravity )

Set the acceleration due to gravity.

Units are meters per second squared \((\frac{m}{s^2})\)

Parameters

[in] _gravity The new gravity vector.

void sdf::World::SetMagneticField ( const ignition::math::Vector3d & _mag )

Set the magnetic vector in Tesla, expressed in a coordinate frame defined by the SphericalCoordinate.

A spherical coordindate can be specified in SDF using the <spherical_coordinates> element.

Parameters

[in] _mag The new magnetic field vector.

See Also: SphericalCoordinates

void sdf::World::SetName ( const std::string & _name ) const

Set the name of the world.

Parameters

[in] _name Name of the world.

void sdf::World::SetWindLinearVelocity ( const ignition::math::Vector3d & _wind )

Set the wind linear velocity in the global/world coordinate frame.

Units are meters per second \((\frac{m}{s})\)

Parameters

[in] _win The new linear velocity of wind.

See Also: ignition::math::Vector3d WindLinearVelocity() const

ignition::math::Vector3d sdf::World::WindLinearVelocity ( ) const

Get the wind linear velocity in the global/world coordinate frame.

Units are meters per second \((\frac{m}{s})\)

Returns: Linear velocity of wind in the global/world coordinate frame.

See Also: void SetWindLinearVelocity(const ignition::math::Vector3d &_wind)

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

World.hh

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation