#include <Sky.hh>
◆ Sky() [1/3]
◆ Sky() [2/3]
sdf::v9::Sky::Sky |
( |
const Sky & |
_sky | ) |
|
Copy constructor.
- Parameters
-
[in] | _sky | Sky element to copy. |
◆ Sky() [3/3]
sdf::v9::Sky::Sky |
( |
Sky && |
_sky | ) |
|
|
noexcept |
Move constructor.
- Parameters
-
◆ ~Sky()
◆ CloudAmbient()
gz::math::Color sdf::v9::Sky::CloudAmbient |
( |
| ) |
const |
Get cloud ambient color.
- Returns
- cloud ambient color
◆ CloudDirection()
gz::math::Angle sdf::v9::Sky::CloudDirection |
( |
| ) |
const |
Get cloud direction angle (angle around up axis)
- Returns
- cloud direction angle in world frame
◆ CloudHumidity()
double sdf::v9::Sky::CloudHumidity |
( |
| ) |
const |
Get cloud humidity.
- Returns
- cloud humidity [0..1]
◆ CloudMeanSize()
double sdf::v9::Sky::CloudMeanSize |
( |
| ) |
const |
Get cloud mean size.
- Returns
- cloud mean size [0..1]
◆ CloudSpeed()
double sdf::v9::Sky::CloudSpeed |
( |
| ) |
const |
Get cloud speed.
- Returns
- cloud speed in meters per second
◆ Element()
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()
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
-
- Returns
- Errors, which is a vector of Error objects. Each Error includes an error code and message. An empty vector indicates no error.
◆ operator=() [1/2]
Sky& sdf::v9::Sky::operator= |
( |
const Sky & |
_sky | ) |
|
Assignment operator.
- Parameters
-
[in] | _sky | The sky to set values from. |
- Returns
- *this
◆ operator=() [2/2]
Sky& sdf::v9::Sky::operator= |
( |
Sky && |
_sky | ) |
|
Move assignment operator.
- Parameters
-
[in] | _workflow | The sky to move from. |
- Returns
- *this
◆ SetCloudAmbient()
void sdf::v9::Sky::SetCloudAmbient |
( |
const gz::math::Color & |
_ambient | ) |
|
Set cloud ambient color.
- Parameters
-
[in] | _ambient | cloud ambient color |
◆ SetCloudDirection()
void sdf::v9::Sky::SetCloudDirection |
( |
const gz::math::Angle & |
_angle | ) |
|
Set cloud direction angle (angle around up axis)
- Parameters
-
[in] | _angle | Cloud direction angle in world frame. |
◆ SetCloudHumidity()
void sdf::v9::Sky::SetCloudHumidity |
( |
double |
_humidity | ) |
|
Set cloud humidity.
- Parameters
-
[in] | _humidity | cloud humidity [0..1] |
◆ SetCloudMeanSize()
void sdf::v9::Sky::SetCloudMeanSize |
( |
double |
_size | ) |
|
Set cloud mean siz.
- Parameters
-
[in] | _size | cloud mean size [0..1] |
◆ SetCloudSpeed()
void sdf::v9::Sky::SetCloudSpeed |
( |
double |
_speed | ) |
|
Set cloud speed.
- Parameters
-
[in] | _speed | cloud speed in meters per second. |
◆ SetSunrise()
void sdf::v9::Sky::SetSunrise |
( |
double |
_time | ) |
|
Set Sunrise time.
- Parameters
-
[in] | _time | Sunrise time [0..24] |
◆ SetSunset()
void sdf::v9::Sky::SetSunset |
( |
double |
_time | ) |
|
Set Sunset time.
- Parameters
-
[in] | _time | Sunset time [0..24] |
◆ SetTime()
void sdf::v9::Sky::SetTime |
( |
double |
_time | ) |
|
Set time of day.
- Parameters
-
[in] | _time | Time of day [0..24] |
◆ Sunrise()
double sdf::v9::Sky::Sunrise |
( |
| ) |
const |
Get sunrise time.
- Returns
- sunrise time [0..24]
◆ Sunset()
double sdf::v9::Sky::Sunset |
( |
| ) |
const |
Get sunset time.
- Returns
- sunset time [0..24]
◆ Time()
double sdf::v9::Sky::Time |
( |
| ) |
const |
Get time of day [0..24].
- Returns
- Time of day
The documentation for this class was generated from the following file: