Castor3D 0.15.0
Multiplatform 3D engine
Types publics | Fonctions membres publiques | Amis | Liste de tous les membres
Référence de la classe castor3d::Overlayfinal

#include <Overlay.hpp>

Graphe d'héritage de castor3d::Overlay:
Inheritance graph
[légende]
Graphe de collaboration de castor3d::Overlay:
Collaboration graph
[légende]

Types publics

using iterator = OverlayPtrArray::iterator
 
using const_iterator = OverlayPtrArray::const_iterator
 

Fonctions membres publiques

C3D_API Overlay (castor::String const &name, Engine &engine, OverlayType type, Scene *scene, OverlayRPtr parent, uint32_t level=0u)
 Constructeur.
 
C3D_API Overlay (Engine &engine, OverlayType type, Scene *scene, OverlayRPtr parent, uint32_t level=0u)
 Constructeur.
 
C3D_API Overlay (Engine &engine, OverlayType type, uint32_t level=0u)
 Constructeur.
 
C3D_API uint32_t getChildrenCount (uint32_t level) const
 
C3D_API PanelOverlayRPtr getPanelOverlay () const
 
C3D_API BorderPanelOverlayRPtr getBorderPanelOverlay () const
 
C3D_API TextOverlayRPtr getTextOverlay () const
 
C3D_API bool isVisible () const
 
C3D_API bool isDisplayable () const
 
C3D_API uint32_t computeLevel () const
 

Accesseurs.

OverlayCategorygetCategory () 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
 

Acces au tableau d'enfants.

size_t size () const noexcept
 
bool empty () const noexcept
 
iterator begin ()
 
const_iterator begin () const noexcept
 
iterator end ()
 
const_iterator end () const noexcept
 

Mutateurs.

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::String const &name)
 
void reparent (OverlayRPtr parent)
 

Amis

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

Documentation des définitions de type membres

◆ const_iterator

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

◆ iterator

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

Documentation des constructeurs et destructeur

◆ Overlay() [1/3]

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

Constructeur.

Paramètres
[in]nameLe nom de l'incrustation.
[in]engineLe moteur.
[in]typeLe type de l'incrustation.
[in]sceneLa scène parent.
[in]parentL'incrustation parente.
[in]levelLe niveau de base de l'incrustation.

◆ Overlay() [2/3]

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

Constructeur.

Paramètres
[in]engineLe moteur.
[in]typeLe type de l'incrustation.
[in]sceneLa scène parent.
[in]parentL'incrustation parente.
[in]levelLe niveau de base de l'incrustation.

◆ Overlay() [3/3]

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

Constructeur.

Paramètres
[in]engineLe moteur.
[in]typeLe type de l'incrustation.
[in]levelLe niveau de base de l'incrustation.

Documentation des fonctions membres

◆ 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
Renvoie
Le niveau dans la hiérarchie de cet 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

Références size().

Voici le graphe d'appel pour cette fonction :

◆ getAbsoluteSize() [1/2]

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

◆ getAbsoluteSize() [2/2]

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

Références size().

Voici le graphe d'appel pour cette fonction :

◆ getBorderPanelOverlay()

C3D_API BorderPanelOverlayRPtr castor3d::Overlay::getBorderPanelOverlay ( ) const
Renvoie
L'incrustation panneau borduré.

◆ getCategory()

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

◆ getChildrenCount()

C3D_API uint32_t castor3d::Overlay::getChildrenCount ( uint32_t  level) const
Paramètres
[in]levelLe niveau voulu.
Renvoie
Le compte des enfants du niveau donné.

◆ 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
Renvoie
L'incrustation panneau.

◆ 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
Renvoie
L'incrustation texte.

◆ getType()

OverlayType castor3d::Overlay::getType ( ) const
inlinenoexcept

◆ isDisplayable()

C3D_API bool castor3d::Overlay::isDisplayable ( ) const
Renvoie
Le statut d'affichabilité.

◆ isPositionChanged()

bool castor3d::Overlay::isPositionChanged ( ) const
inlinenoexcept

◆ isSizeChanged()

bool castor3d::Overlay::isSizeChanged ( ) const
inlinenoexcept

◆ isVisible()

C3D_API bool castor3d::Overlay::isVisible ( ) const
Renvoie
Le statut de visibilité.

◆ rename()

void castor3d::Overlay::rename ( castor::String const &  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

Références size().

Voici le graphe d'appel pour cette fonction :

◆ setRelativePosition()

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

◆ setRelativeSize()

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

Références size().

Voici le graphe d'appel pour cette fonction :

◆ setVisible()

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

◆ size()

size_t castor3d::Overlay::size ( ) const
inlinenoexcept

Référencé par getAbsolutePosition(), getAbsoluteSize(), setPixelSize(), et setRelativeSize().

Voici le graphe des appelants de cette fonction :

Documentation des fonctions amies et associées

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

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

La documentation de cette classe a été générée à partir du fichier suivant :