sdf::v9::Scene Class Reference

#include <Scene.hh>

Public Member Functions
	Scene ()
	Default constructor. More...
	Scene (const Scene &_scene)
	Copy constructor. More...
	Scene (Scene &&_scene) noexcept
	Move constructor. More...
	~Scene ()
	Destructor. More...
ignition::math::Color	Ambient () const
	Get the ambient color of the scene. More...
ignition::math::Color	Background () const
	Get the background color of the scene. More...
sdf::ElementPtr	Element () const
	Get a pointer to the SDF element that was used during load. More...
bool	Grid () const
	Get whether grid is enabled. More...
Errors	Load (ElementPtr _sdf)
	Load the scene based on a element pointer. More...
Scene &	operator= (const Scene &_scene)
	Assignment operator. More...
Scene &	operator= (Scene &&_scene)
	Move assignment operator. More...
bool	OriginVisual () const
	Get whether origin visual is enabled. More...
void	SetAmbient (const ignition::math::Color &_ambient)
	Set the ambient color of the scene. More...
void	SetBackground (const ignition::math::Color &_background)
	Set the background color of the scene. More...
void	SetGrid (const bool _enabled)
	Set whether the grid should be enabled. More...
void	SetOriginVisual (const bool _enabled)
	Set whether the origin visual should be enabled. More...
void	SetShadows (const bool _shadows)
	Set whether shadows should be enabled. More...
bool	Shadows () const
	Get whether shadows are enabled. More...

Constructor & Destructor Documentation

Scene() [1/3]

sdf::v9::Scene::Scene

(

)

Default constructor.

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

[in]

_scene

Scene to move.

~Scene()

sdf::v9::Scene::~Scene

(

)

Destructor.

Member Function Documentation

Ambient()

ignition::math::Color sdf::v9::Scene::Ambient

(

)

const

Get the ambient color of the scene.

Returns

Scene ambient color

Background()

ignition::math::Color sdf::v9::Scene::Background

(

)

const

Get the background color of the scene.

Returns

Scene background color

Element()

sdf::ElementPtr sdf::v9::Scene::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.

Grid()

bool sdf::v9::Scene::Grid

(

)

const

Get whether grid is enabled.

Returns

True if grid is enabled

Load()

Errors sdf::v9::Scene::Load

(

ElementPtr

_sdf

)

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

[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.

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 ignition::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 ignition::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

Shadows()

bool sdf::v9::Scene::Shadows

(

)

const

Get whether shadows are enabled.

Returns

True if shadows are enabled

---

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

• Scene.hh