sdf::v12::Sky Class Reference

#include <Sky.hh>

Public Member Functions
	Sky ()
	Default constructor. More...
ignition::math::Color	CloudAmbient () const
	Get cloud ambient color. More...
ignition::math::Angle	CloudDirection () const
	Get cloud direction angle (angle around up axis) More...
double	CloudHumidity () const
	Get cloud humidity. More...
double	CloudMeanSize () const
	Get cloud mean size. More...
double	CloudSpeed () const
	Get cloud speed. More...
const std::string &	CubemapUri () const
	Get the skybox texture URI. More...
sdf::ElementPtr	Element () const
	Get a pointer to the SDF element that was used during load. More...
Errors	Load (ElementPtr _sdf)
	Load the sky based on a element pointer. More...
void	SetCloudAmbient (const ignition::math::Color &_ambient)
	Set cloud ambient color. More...
void	SetCloudDirection (const ignition::math::Angle &_angle)
	Set cloud direction angle (angle around up axis) More...
void	SetCloudHumidity (double _humidity)
	Set cloud humidity. More...
void	SetCloudMeanSize (double _size)
	Set cloud mean siz. More...
void	SetCloudSpeed (double _speed)
	Set cloud speed. More...
void	SetCubemapUri (const std::string &_uri)
	Set the skybox texture URI. More...
void	SetSunrise (double _time)
	Set Sunrise time. More...
void	SetSunset (double _time)
	Set Sunset time. More...
void	SetTime (double _time)
	Set time of day. More...
double	Sunrise () const
	Get sunrise time. More...
double	Sunset () const
	Get sunset time. More...
double	Time () const
	Get time of day [0..24]. More...
sdf::ElementPtr	ToElement () const
	Create and return an SDF element filled with data from this sky. More...

Constructor & Destructor Documentation

Sky()

sdf::v12::Sky::Sky

(

)

Default constructor.

Member Function Documentation

CloudAmbient()

ignition::math::Color sdf::v12::Sky::CloudAmbient

(

)

const

Get cloud ambient color.

Returns

cloud ambient color

CloudDirection()

ignition::math::Angle sdf::v12::Sky::CloudDirection

(

)

const

Get cloud direction angle (angle around up axis)

Returns

cloud direction angle in world frame

CloudHumidity()

double sdf::v12::Sky::CloudHumidity

(

)

const

Get cloud humidity.

Returns

cloud humidity [0..1]

CloudMeanSize()

double sdf::v12::Sky::CloudMeanSize

(

)

const

Get cloud mean size.

Returns

cloud mean size [0..1]

CloudSpeed()

double sdf::v12::Sky::CloudSpeed

(

)

const

Get cloud speed.

Returns

cloud speed in meters per second

CubemapUri()

const std::string& sdf::v12::Sky::CubemapUri

(

)

const

Get the skybox texture URI.

Returns

The URI of the skybox texture.

Element()

sdf::ElementPtr sdf::v12::Sky::Element

(

)

const

Get a pointer to the SDF element that was used during load.

Returns

SDF element pointer. The value will be nullptr if Load has not been called.

Load()

Errors sdf::v12::Sky::Load

(

ElementPtr

_sdf

)

Load the sky 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.

SetCloudAmbient()

void sdf::v12::Sky::SetCloudAmbient

(

const ignition::math::Color &

_ambient

)

Set cloud ambient color.

Parameters

[in]

_ambient

cloud ambient color

SetCloudDirection()

void sdf::v12::Sky::SetCloudDirection

(

const ignition::math::Angle &

_angle

)

Set cloud direction angle (angle around up axis)

Parameters

[in]

_angle

Cloud direction angle in world frame.

SetCloudHumidity()

void sdf::v12::Sky::SetCloudHumidity

(

double

_humidity

)

Set cloud humidity.

Parameters

[in]

_humidity

cloud humidity [0..1]

SetCloudMeanSize()

void sdf::v12::Sky::SetCloudMeanSize

(

double

_size

)

Set cloud mean siz.

Parameters

[in]

_size

cloud mean size [0..1]

SetCloudSpeed()

void sdf::v12::Sky::SetCloudSpeed

(

double

_speed

)

Set cloud speed.

Parameters

[in]

_speed

cloud speed in meters per second.

SetCubemapUri()

void sdf::v12::Sky::SetCubemapUri

(

const std::string &

_uri

)

Set the skybox texture URI.

Parameters

[in]

_uri

The URI of the skybox texture.

SetSunrise()

void sdf::v12::Sky::SetSunrise

(

double

_time

)

Set Sunrise time.

Parameters

[in]

_time

Sunrise time [0..24]

SetSunset()

void sdf::v12::Sky::SetSunset

(

double

_time

)

Set Sunset time.

Parameters

[in]

_time

Sunset time [0..24]

SetTime()

void sdf::v12::Sky::SetTime

(

double

_time

)

Set time of day.

Parameters

[in]

_time

Time of day [0..24]

Sunrise()

double sdf::v12::Sky::Sunrise

(

)

const

Get sunrise time.

Returns

sunrise time [0..24]

Sunset()

double sdf::v12::Sky::Sunset

(

)

const

Get sunset time.

Returns

sunset time [0..24]

Time()

double sdf::v12::Sky::Time

(

)

const

Get time of day [0..24].

Returns

Time of day

ToElement()

sdf::ElementPtr sdf::v12::Sky::ToElement

(

)

const

Create and return an SDF element filled with data from this sky.

Note that parameter passing functionality is not captured with this function.

Returns

SDF element pointer with updated sky values.

---

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

• Sky.hh