sdf::SDF_VERSION_NAMESPACE::Gui Class Reference

#include <Gui.hh>

Public Member Functions
	Gui ()
	Default constructor.
void	AddPlugin (const Plugin &_plugin)
	Add a plugin to this object.
void	ClearPlugins ()
	Remove all plugins.
sdf::ElementPtr	Element () const
	Get a pointer to the SDF element that was used during load.
bool	Fullscreen () const
	Get whether the Gui should be fullscreen.
Errors	Load (ElementPtr _sdf)
	Load the gui based on a element pointer.
bool	operator== (const Gui &_gui) const
	Equality operator that returns true if this Gui instance equals the given Gui instance.
const Plugin *	PluginByIndex (const uint64_t _index) const
	Get a plugin based on an index.
uint64_t	PluginCount () const
	Get the number of plugins.
sdf::Plugins &	Plugins ()
	Get a mutable vector of plugins attached to this object.
const sdf::Plugins &	Plugins () const
	Get the plugins attached to this object.
void	SetFullscreen (const bool _fullscreen)
	Set whether the Gui should be full screen.
sdf::ElementPtr	ToElement () const
	Create and return an SDF element filled with data from this gui.

Constructor & Destructor Documentation

Gui()

sdf::SDF_VERSION_NAMESPACE::Gui::Gui

(

)

Default constructor.

Member Function Documentation

AddPlugin()

void sdf::SDF_VERSION_NAMESPACE::Gui::AddPlugin

(

const Plugin &

_plugin

)

Add a plugin to this object.

Parameters

[in]

_plugin

Plugin to add.

ClearPlugins()

void sdf::SDF_VERSION_NAMESPACE::Gui::ClearPlugins

(

)

Remove all plugins.

Element()

sdf::ElementPtr sdf::SDF_VERSION_NAMESPACE::Gui::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.

Fullscreen()

bool sdf::SDF_VERSION_NAMESPACE::Gui::Fullscreen

(

)

const

Get whether the Gui should be fullscreen.

Returns

True if the Gui should be fullscreen.

Load()

Errors sdf::SDF_VERSION_NAMESPACE::Gui::Load

(

ElementPtr

_sdf

)

Load the gui 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==()

bool sdf::SDF_VERSION_NAMESPACE::Gui::operator==

(

const Gui &

_gui

)

const

Equality operator that returns true if this Gui instance equals the given Gui instance.

Parameters

[in]

_gui

Gui instance to compare.

Returns

True if this instance equals the given Gui.

PluginByIndex()

const Plugin * sdf::SDF_VERSION_NAMESPACE::Gui::PluginByIndex

(

const uint64_t

_index

)

const

Get a plugin based on an index.

Parameters

[in]

_index

Index of the plugin. The index should be in the range [0..PluginCount()).

Returns

Pointer to the plugin. Nullptr if the index does not exist.

See also

uint64_t PluginCount() const

PluginCount()

uint64_t sdf::SDF_VERSION_NAMESPACE::Gui::PluginCount

(

)

const

Get the number of plugins.

Returns

Number of plugins contained in this Gui object.

Plugins() [1/2]

sdf::Plugins & sdf::SDF_VERSION_NAMESPACE::Gui::Plugins

(

)

Get a mutable vector of plugins attached to this object.

Returns

A vector of Plugin, which will be empty if there are no plugins.

Plugins() [2/2]

const sdf::Plugins & sdf::SDF_VERSION_NAMESPACE::Gui::Plugins

(

)

const

Get the plugins attached to this object.

Returns

A vector of Plugin, which will be empty if there are no plugins.

SetFullscreen()

void sdf::SDF_VERSION_NAMESPACE::Gui::SetFullscreen

(

const bool

_fullscreen

)

Set whether the Gui should be full screen.

Parameters

[in]

_fullscreen

True indicates that the Gui should be fullscreen.

ToElement()

sdf::ElementPtr sdf::SDF_VERSION_NAMESPACE::Gui::ToElement

(

)

const

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

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

Returns

SDF element pointer with updated gui values.

---

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

• Gui.hh