castor3d::Overlay Class Reference

#include <Overlay.hpp>

Inheritance diagram for castor3d::Overlay:

Collaboration diagram for castor3d::Overlay:

Public Types
using	iterator = OverlayPtrArray::iterator
using	const_iterator = OverlayPtrArray::const_iterator

Public Member Functions
C3D_API	Overlay (castor::String const &name, Engine &engine, OverlayType type, Scene *scene, OverlayRPtr parent, uint32_t level=0u)
	Constructor.
C3D_API	Overlay (Engine &engine, OverlayType type, Scene *scene, OverlayRPtr parent, uint32_t level=0u)
	Constructor.
C3D_API	Overlay (Engine &engine, OverlayType type, uint32_t level=0u)
	Constructor.
C3D_API uint32_t	getChildrenCount (uint32_t level) const
C3D_API PanelOverlayRPtr	getPanelOverlay () const noexcept
C3D_API BorderPanelOverlayRPtr	getBorderPanelOverlay () const noexcept
C3D_API TextOverlayRPtr	getTextOverlay () const noexcept
C3D_API bool	isVisible () const
C3D_API bool	isDisplayable () const
C3D_API uint32_t	computeLevel () const
Getters.
OverlayCategory &	getCategory () const noexcept
castor::Position	getAbsolutePosition (castor::Size const &size) const noexcept
castor::Size	getAbsoluteSize (castor::Size const &size) const noexcept
castor::Point2d	getAbsolutePosition () const noexcept
castor::Point2d	getAbsoluteSize () const noexcept
bool	isSizeChanged () const noexcept
bool	isPositionChanged () const noexcept
castor::String const &	getName () const noexcept
castor::Point2d const &	getRelativePosition () const noexcept
castor::Point2d const &	getRelativeSize () const noexcept
OverlayType	getType () const noexcept
OverlayRPtr	getParent () const noexcept
MaterialObs	getMaterial () const noexcept
SceneRPtr	getScene () const noexcept
uint32_t	getIndex () const noexcept
uint32_t	getLevel () const noexcept
Array access to childs.
size_t	size () const noexcept
bool	empty () const noexcept
iterator	begin ()
const_iterator	begin () const noexcept
iterator	end ()
const_iterator	end () const noexcept
Mutators.
void	setVisible (bool val)
void	setMaterial (MaterialObs material)
void	setRelativePosition (castor::Point2d const &position)
void	setRelativeSize (castor::Point2d const &size)
void	setPixelPosition (castor::Position const &position)
void	setPixelSize (castor::Size const &size)
void	rename (castor::StringView name)
void	reparent (OverlayRPtr parent)
Public Member Functions inherited from castor::OwnedBy< Engine >
Engine *	getOwner () const noexcept
void	setOwner (Engine &owner) noexcept

Static Public Member Functions
static C3D_API void	addParsers (castor::AttributeParsers &result)

Friends
class	castor::ResourceCacheT< Overlay, castor::String, OverlayCacheTraits >

Additional Inherited Members
Protected Member Functions inherited from castor::OwnedBy< Engine >
	OwnedBy (Engine &owner) noexcept
	Constructor.

Member Typedef Documentation

const_iterator

using castor3d::Overlay::const_iterator = OverlayPtrArray::const_iterator

iterator

using castor3d::Overlay::iterator = OverlayPtrArray::iterator

Constructor & Destructor Documentation

Overlay() [1/3]

C3D_API castor3d::Overlay::Overlay	(	castor::String const &	name,
		Engine &	engine,
		OverlayType	type,
		Scene *	scene,
		OverlayRPtr	parent,
		uint32_t	level = 0u )

Constructor.

Parameters

[in]	name	The overlay name.
[in]	engine	The engine.
[in]	type	The overlay type.
[in]	scene	The scene holding the overlay.
[in]	parent	The parent overlay (if any).
[in]	level	The overlay base level.

Overlay() [2/3]

C3D_API castor3d::Overlay::Overlay	(	Engine &	engine,
		OverlayType	type,
		Scene *	scene,
		OverlayRPtr	parent,
		uint32_t	level = 0u )

Constructor.

Parameters

[in]	engine	The engine.
[in]	type	The overlay type.
[in]	scene	The scene holding the overlay.
[in]	parent	The parent overlay (if any).
[in]	level	The overlay base level.

Overlay() [3/3]

C3D_API castor3d::Overlay::Overlay	(	Engine &	engine,
		OverlayType	type,
		uint32_t	level = 0u )

Constructor.

Parameters

[in]	engine	The engine.
[in]	type	The overlay type.
[in]	level	The overlay base level.

Member Function Documentation

addParsers()

static C3D_API void castor3d::Overlay::addParsers ( castor::AttributeParsers & result )

static

begin() [1/2]

iterator castor3d::Overlay::begin ( )

inline

begin() [2/2]

const_iterator castor3d::Overlay::begin ( ) const

inlinenoexcept

computeLevel()

C3D_API uint32_t castor3d::Overlay::computeLevel

(

)

const

Returns

The hierarchy level for this overlay

empty()

bool castor3d::Overlay::empty ( ) const

inlinenoexcept

end() [1/2]

iterator castor3d::Overlay::end ( )

inline

end() [2/2]

const_iterator castor3d::Overlay::end ( ) const

inlinenoexcept

getAbsolutePosition() [1/2]

castor::Point2d castor3d::Overlay::getAbsolutePosition ( ) const

inlinenoexcept

getAbsolutePosition() [2/2]

castor::Position castor3d::Overlay::getAbsolutePosition ( castor::Size const & size ) const

inlinenoexcept

References size().

Here is the call graph for this function:

getAbsoluteSize() [1/2]

castor::Point2d castor3d::Overlay::getAbsoluteSize ( ) const

inlinenoexcept

getAbsoluteSize() [2/2]

castor::Size castor3d::Overlay::getAbsoluteSize ( castor::Size const & size ) const

inlinenoexcept

References size().

Here is the call graph for this function:

getBorderPanelOverlay()

C3D_API BorderPanelOverlayRPtr castor3d::Overlay::getBorderPanelOverlay ( ) const

noexcept

Returns

The border panel overlay.

getCategory()

OverlayCategory & castor3d::Overlay::getCategory ( ) const

inlinenoexcept

getChildrenCount()

C3D_API uint32_t castor3d::Overlay::getChildrenCount

(

uint32_t

level

)

const

Parameters

[in]

level

The wanted level

Returns

The childs count at given level.

getIndex()

uint32_t castor3d::Overlay::getIndex ( ) const

inlinenoexcept

getLevel()

uint32_t castor3d::Overlay::getLevel ( ) const

inlinenoexcept

getMaterial()

MaterialObs castor3d::Overlay::getMaterial ( ) const

inlinenoexcept

getName()

castor::String const & castor3d::Overlay::getName ( ) const

inlinenoexcept

getPanelOverlay()

C3D_API PanelOverlayRPtr castor3d::Overlay::getPanelOverlay ( ) const

noexcept

Returns

The panel overlay.

getParent()

OverlayRPtr castor3d::Overlay::getParent ( ) const

inlinenoexcept

getRelativePosition()

castor::Point2d const & castor3d::Overlay::getRelativePosition ( ) const

inlinenoexcept

getRelativeSize()

castor::Point2d const & castor3d::Overlay::getRelativeSize ( ) const

inlinenoexcept

getScene()

SceneRPtr castor3d::Overlay::getScene ( ) const

inlinenoexcept

getTextOverlay()

C3D_API TextOverlayRPtr castor3d::Overlay::getTextOverlay ( ) const

noexcept

Returns

The text overlay.

getType()

OverlayType castor3d::Overlay::getType ( ) const

inlinenoexcept

isDisplayable()

C3D_API bool castor3d::Overlay::isDisplayable

(

)

const

Returns

The siplayability status.

isPositionChanged()

bool castor3d::Overlay::isPositionChanged ( ) const

inlinenoexcept

isSizeChanged()

bool castor3d::Overlay::isSizeChanged ( ) const

inlinenoexcept

isVisible()

C3D_API bool castor3d::Overlay::isVisible

(

)

const

Returns

The visibility status.

rename()

void castor3d::Overlay::rename ( castor::StringView name )

inline

reparent()

void castor3d::Overlay::reparent ( OverlayRPtr parent )

inline

setMaterial()

void castor3d::Overlay::setMaterial ( MaterialObs material )

inline

setPixelPosition()

void castor3d::Overlay::setPixelPosition ( castor::Position const & position )

inline

setPixelSize()

void castor3d::Overlay::setPixelSize ( castor::Size const & size )

inline

References size().

Here is the call graph for this function:

setRelativePosition()

void castor3d::Overlay::setRelativePosition ( castor::Point2d const & position )

inline

setRelativeSize()

void castor3d::Overlay::setRelativeSize ( castor::Point2d const & size )

inline

References size().

Here is the call graph for this function:

setVisible()

void castor3d::Overlay::setVisible ( bool val )

inline

size()

size_t castor3d::Overlay::size ( ) const

inlinenoexcept

Referenced by getAbsolutePosition(), getAbsoluteSize(), setPixelSize(), and setRelativeSize().

Here is the caller graph for this function:

Friends And Related Symbol Documentation

castor::ResourceCacheT< Overlay, castor::String, OverlayCacheTraits >

friend class castor::ResourceCacheT< Overlay, castor::String, OverlayCacheTraits >

friend

---

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

• Castor3D/Overlay/Overlay.hpp