#include <Scene.hh>
◆ Scene() [1/3]
sdf::v9::Scene::Scene |
( |
| ) |
|
◆ Scene() [2/3]
sdf::v9::Scene::Scene |
( |
const Scene & |
_scene | ) |
|
Copy constructor.
- Parameters
-
[in] | _scene | Scene element to copy. |
◆ Scene() [3/3]
sdf::v9::Scene::Scene |
( |
Scene && |
_scene | ) |
|
|
noexcept |
Move constructor.
- Parameters
-
◆ ~Scene()
sdf::v9::Scene::~Scene |
( |
| ) |
|
◆ Ambient()
gz::math::Color sdf::v9::Scene::Ambient |
( |
| ) |
const |
Get the ambient color of the scene.
- Returns
- Scene ambient color
◆ Background()
gz::math::Color sdf::v9::Scene::Background |
( |
| ) |
const |
Get the background color of the scene.
- Returns
- Scene background color
◆ 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.
◆ Grid()
bool sdf::v9::Scene::Grid |
( |
| ) |
const |
Get whether grid is enabled.
- Returns
- True if grid is enabled
◆ Load()
Load the scene 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]
Scene& sdf::v9::Scene::operator= |
( |
const Scene & |
_scene | ) |
|
Assignment operator.
- Parameters
-
[in] | _scene | The scene to set values from. |
- Returns
- *this
◆ operator=() [2/2]
Scene& sdf::v9::Scene::operator= |
( |
Scene && |
_scene | ) |
|
Move assignment operator.
- Parameters
-
[in] | _workflow | The scene to move from. |
- Returns
- *this
◆ OriginVisual()
bool sdf::v9::Scene::OriginVisual |
( |
| ) |
const |
Get whether origin visual is enabled.
- Returns
- True if origin visual is enabled
◆ SetAmbient()
void sdf::v9::Scene::SetAmbient |
( |
const gz::math::Color & |
_ambient | ) |
|
Set the ambient color of the scene.
- Parameters
-
[in] | _ambient | Ambient color to set to |
◆ SetBackground()
void sdf::v9::Scene::SetBackground |
( |
const gz::math::Color & |
_background | ) |
|
Set the background color of the scene.
- Parameters
-
[in] | _background | Background color to set to |
◆ SetGrid()
void sdf::v9::Scene::SetGrid |
( |
const bool |
_enabled | ) |
|
Set whether the grid should be enabled.
- Parameters
-
[in] | enabled | True to enable grid |
◆ SetOriginVisual()
void sdf::v9::Scene::SetOriginVisual |
( |
const bool |
_enabled | ) |
|
Set whether the origin visual should be enabled.
- Parameters
-
[in] | enabled | True to enable origin visual |
◆ SetShadows()
void sdf::v9::Scene::SetShadows |
( |
const bool |
_shadows | ) |
|
Set whether shadows should be enabled.
- Parameters
-
[in] | enabled | True to enable shadows |
◆ SetSky()
void sdf::v9::Scene::SetSky |
( |
const Sky & |
_sky | ) |
|
◆ Shadows()
bool sdf::v9::Scene::Shadows |
( |
| ) |
const |
Get whether shadows are enabled.
- Returns
- True if shadows are enabled
◆ Sky()
const sdf::Sky* sdf::v9::Scene::Sky |
( |
| ) |
const |
The documentation for this class was generated from the following file: