Castor3D  ..
Classes | Types publics | Fonctions membres publiques | Attributs protégés | Liste de tous les membres
Référence de la classe Castor3D::Overlay

La classe d'incrustation. Plus de détails...

+ Graphe d'héritage de Castor3D::Overlay:
+ Graphe de collaboration de Castor3D::Overlay:

Classes

class  TextWriter
 Overlay loader. Plus de détails...
 

Types publics

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

Fonctions membres publiques

C3D_API Overlay (Engine &p_engine, OverlayType p_type)
 Constructeur. Plus de détails...
 
C3D_API Overlay (Engine &p_engine, OverlayType p_type, SceneSPtr p_scene, OverlaySPtr p_parent)
 
virtual C3D_API ~Overlay ()
 Destructeur. Plus de détails...
 
virtual C3D_API void Render (Castor::Size const &p_size)
 Dessine l'incrustation. Plus de détails...
 
C3D_API void AddChild (OverlaySPtr p_overlay)
 Ajoute un enfant à l'incrustation. Plus de détails...
 
C3D_API uint32_t GetChildrenCount (int p_level) const
 Récupère le compte des enfants du niveau donné Plus de détails...
 
C3D_API PanelOverlaySPtr GetPanelOverlay () const
 Récupère la l'incrustation panneau. Plus de détails...
 
C3D_API BorderPanelOverlaySPtr GetBorderPanelOverlay () const
 Récupère la l'incrustation panneau borduré. Plus de détails...
 
C3D_API TextOverlaySPtr GetTextOverlay () const
 Récupère la l'incrustation texte. Plus de détails...
 
C3D_API bool IsVisible () const
 Récupère le statut de visibilité Plus de détails...
 
OverlayCategorySPtr GetCategory () const
 Récupère la categorie d'incrustation. Plus de détails...
 
Castor::Position GetAbsolutePosition (Castor::Size const &p_size) const
 Récupère la position absolue de l'incrustation, en pixels. Plus de détails...
 
Castor::Size GetAbsoluteSize (Castor::Size const &p_size) const
 Récupère la taille absolue de l'incrustation, en pixels. Plus de détails...
 
Castor::Point2d GetAbsolutePosition () const
 Récupère la position absolue de l'incrustation. Plus de détails...
 
Castor::Point2d GetAbsoluteSize () const
 Récupère la taille absolue de l'incrustation. Plus de détails...
 
bool IsSizeChanged () const
 
bool IsPositionChanged () const
 
Castor::String const & GetName () const
 Récupère le nom de l'incrustation. Plus de détails...
 
Castor::Point2d const & GetPosition () const
 Récupère la position de l'incrustation. Plus de détails...
 
Castor::Point2d const & GetSize () const
 Récupère la taille de l'incrustation. Plus de détails...
 
Castor::Position const & GetPixelPosition () const
 Récupère la position de l'incrustation. Plus de détails...
 
Castor::Size const & GetPixelSize () const
 Récupère la taille de l'incrustation. Plus de détails...
 
OverlayType GetType () const
 Récupère le type de l'incrustation. Plus de détails...
 
OverlaySPtr GetParent () const
 Récupère l'incrustation parente. Plus de détails...
 
MaterialSPtr GetMaterial () const
 Récupère le matériau. Plus de détails...
 
Castor::Point2d & GetPosition ()
 Récupère la position de l'incrustation. Plus de détails...
 
Castor::Point2d & GetSize ()
 Récupère la taille de l'incrustation. Plus de détails...
 
Castor::Position & GetPixelPosition ()
 Récupère la position de l'incrustation. Plus de détails...
 
Castor::Size & GetPixelSize ()
 Récupère la taille de l'incrustation. Plus de détails...
 
SceneSPtr GetScene () const
 Récupère la scène parente. Plus de détails...
 
int GetIndex () const
 Récupère l'indice. Plus de détails...
 
int GetLevel () const
 Récupère le niveau. Plus de détails...
 
uint32_t GetChildrenCount () const
 Récupère le nombre d'enfants. Plus de détails...
 
iterator begin ()
 Récupère un itérateur sur le premier enfant. Plus de détails...
 
const_iterator begin () const
 Récupère un itérateur sur le premier enfant. Plus de détails...
 
iterator end ()
 Récupère un itérateur sur après le dernier enfant. Plus de détails...
 
const_iterator end () const
 Récupère un itérateur sur après le dernier enfant. Plus de détails...
 
void SetVisible (bool val)
 Définit le statut de visibilité Plus de détails...
 
void SetOrder (int p_index, int p_level)
 Définit l'ordre de l'incrustation. Plus de détails...
 
void SetMaterial (MaterialSPtr p_material)
 Définit le matériau. Plus de détails...
 
void SetPosition (Castor::Point2d const &p_position)
 Définit la position relative de l'incrustation. Plus de détails...
 
void SetSize (Castor::Point2d const &p_size)
 Définit les dimensions relatives de l'incrustation. Plus de détails...
 
void SetPixelPosition (Castor::Position const &p_position)
 Définit la position relative de l'incrustation. Plus de détails...
 
void SetPixelSize (Castor::Size const &p_size)
 Définit les dimensions relatives de l'incrustation. Plus de détails...
 
void SetName (Castor::String const &p_name)
 Définit le nom de l'incrustation. Plus de détails...
 

Attributs protégés

Castor::String m_name
 Le nom de l'incrustation. Plus de détails...
 
OverlayWPtr m_parent
 L'incrustation parente, s'il y en a. Plus de détails...
 
OverlayPtrArray m_overlays
 Les enfants. Plus de détails...
 
OverlayCategorySPtr m_category
 La catégorie de l'incrustation. Plus de détails...
 
SceneWPtr m_pScene
 La scène parente. Plus de détails...
 
RenderSystem * m_renderSystem
 Le système de rendu. Plus de détails...
 

Description détaillée

La classe d'incrustation.

Auteur
Sylvain DOREMUS
Date
25/08/2010
Remarques
Une incrustation est un élément 2D qui est affiché en premier plan

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/2]

C3D_API Castor3D::Overlay::Overlay ( Engine &  p_engine,
OverlayType  p_type 
)

Constructeur.

Paramètres
[in]p_engineLe moteur
[in]p_typeLe type de l'incrustation

◆ Overlay() [2/2]

C3D_API Castor3D::Overlay::Overlay ( Engine &  p_engine,
OverlayType  p_type,
SceneSPtr  p_scene,
OverlaySPtr  p_parent 
)

◆ ~Overlay()

virtual C3D_API Castor3D::Overlay::~Overlay ( )
virtual

Destructeur.

Documentation des fonctions membres

◆ AddChild()

C3D_API void Castor3D::Overlay::AddChild ( OverlaySPtr  p_overlay)

Ajoute un enfant à l'incrustation.

Paramètres
[in]p_overlayL'incrustation enfant
Renvoie
true si tout s'est bien passé

◆ begin() [1/2]

iterator Castor3D::Overlay::begin ( )
inline

Récupère un itérateur sur le premier enfant.

Renvoie
La valeur

Références m_overlays.

◆ begin() [2/2]

const_iterator Castor3D::Overlay::begin ( ) const
inline

Récupère un itérateur sur le premier enfant.

Renvoie
La valeur

Références m_overlays.

◆ end() [1/2]

iterator Castor3D::Overlay::end ( )
inline

Récupère un itérateur sur après le dernier enfant.

Renvoie
La valeur

Références m_overlays.

◆ end() [2/2]

const_iterator Castor3D::Overlay::end ( ) const
inline

Récupère un itérateur sur après le dernier enfant.

Renvoie
La valeur

Références m_overlays.

◆ GetAbsolutePosition() [1/2]

Castor::Position Castor3D::Overlay::GetAbsolutePosition ( Castor::Size const &  p_size) const
inline

Récupère la position absolue de l'incrustation, en pixels.

Paramètres
[in]p_sizeLa taille de l'écran
Renvoie
La position

Références m_category.

◆ GetAbsolutePosition() [2/2]

Castor::Point2d Castor3D::Overlay::GetAbsolutePosition ( ) const
inline

Récupère la position absolue de l'incrustation.

Renvoie
La position

Références m_category.

◆ GetAbsoluteSize() [1/2]

Castor::Size Castor3D::Overlay::GetAbsoluteSize ( Castor::Size const &  p_size) const
inline

Récupère la taille absolue de l'incrustation, en pixels.

Paramètres
[in]p_sizeLa taille de l'écran
Renvoie
La taille

Références m_category.

◆ GetAbsoluteSize() [2/2]

Castor::Point2d Castor3D::Overlay::GetAbsoluteSize ( ) const
inline

Récupère la taille absolue de l'incrustation.

Renvoie
La taille

Références m_category.

◆ GetBorderPanelOverlay()

C3D_API BorderPanelOverlaySPtr Castor3D::Overlay::GetBorderPanelOverlay ( ) const

Récupère la l'incrustation panneau borduré.

Renvoie
La catégorie.

◆ GetCategory()

OverlayCategorySPtr Castor3D::Overlay::GetCategory ( ) const
inline

Récupère la categorie d'incrustation.

Renvoie
La catégorie.

Références m_category.

◆ GetChildrenCount() [1/2]

C3D_API uint32_t Castor3D::Overlay::GetChildrenCount ( int  p_level) const

Récupère le compte des enfants du niveau donné

Paramètres
[in]p_levelLe niveau voulu
Renvoie
Le compte

◆ GetChildrenCount() [2/2]

uint32_t Castor3D::Overlay::GetChildrenCount ( ) const
inline

Récupère le nombre d'enfants.

Renvoie
La valeur

Références m_overlays.

◆ GetIndex()

int Castor3D::Overlay::GetIndex ( ) const
inline

Récupère l'indice.

Renvoie
La valeur

Références m_category.

◆ GetLevel()

int Castor3D::Overlay::GetLevel ( ) const
inline

Récupère le niveau.

Renvoie
La valeur

Références m_category.

◆ GetMaterial()

MaterialSPtr Castor3D::Overlay::GetMaterial ( ) const
inline

Récupère le matériau.

Renvoie
La valeur

Références m_category.

◆ GetName()

Castor::String const& Castor3D::Overlay::GetName ( ) const
inline

Récupère le nom de l'incrustation.

Renvoie
La valeur

Références m_name.

◆ GetPanelOverlay()

C3D_API PanelOverlaySPtr Castor3D::Overlay::GetPanelOverlay ( ) const

Récupère la l'incrustation panneau.

Renvoie
La catégorie.

◆ GetParent()

OverlaySPtr Castor3D::Overlay::GetParent ( ) const
inline

Récupère l'incrustation parente.

Renvoie
La valeur

Références m_parent.

◆ GetPixelPosition() [1/2]

Castor::Position const& Castor3D::Overlay::GetPixelPosition ( ) const
inline

Récupère la position de l'incrustation.

Renvoie
La valeur

Références m_category.

◆ GetPixelPosition() [2/2]

Castor::Position& Castor3D::Overlay::GetPixelPosition ( )
inline

Récupère la position de l'incrustation.

Renvoie
La valeur

Références m_category.

◆ GetPixelSize() [1/2]

Castor::Size const& Castor3D::Overlay::GetPixelSize ( ) const
inline

Récupère la taille de l'incrustation.

Renvoie
La valeur

Références m_category.

◆ GetPixelSize() [2/2]

Castor::Size& Castor3D::Overlay::GetPixelSize ( )
inline

Récupère la taille de l'incrustation.

Renvoie
La valeur

Références m_category.

◆ GetPosition() [1/2]

Castor::Point2d const& Castor3D::Overlay::GetPosition ( ) const
inline

Récupère la position de l'incrustation.

Renvoie
La valeur

Références m_category.

◆ GetPosition() [2/2]

Castor::Point2d& Castor3D::Overlay::GetPosition ( )
inline

Récupère la position de l'incrustation.

Renvoie
La valeur

Références m_category.

◆ GetScene()

SceneSPtr Castor3D::Overlay::GetScene ( ) const
inline

Récupère la scène parente.

Renvoie
La valeur

Références m_pScene.

◆ GetSize() [1/2]

Castor::Point2d const& Castor3D::Overlay::GetSize ( ) const
inline

Récupère la taille de l'incrustation.

Renvoie
La valeur

Références m_category.

◆ GetSize() [2/2]

Castor::Point2d& Castor3D::Overlay::GetSize ( )
inline

Récupère la taille de l'incrustation.

Renvoie
La valeur

Références m_category.

◆ GetTextOverlay()

C3D_API TextOverlaySPtr Castor3D::Overlay::GetTextOverlay ( ) const

Récupère la l'incrustation texte.

Renvoie
La catégorie.

◆ GetType()

OverlayType Castor3D::Overlay::GetType ( ) const
inline

Récupère le type de l'incrustation.

Renvoie
La valeur

Références m_category.

◆ IsPositionChanged()

bool Castor3D::Overlay::IsPositionChanged ( ) const
inline
Renvoie
true si la position de cette incrustation ou d'un de ses parents a changé.

Références m_category.

◆ IsSizeChanged()

bool Castor3D::Overlay::IsSizeChanged ( ) const
inline
Renvoie
true si les dimensions de cette incrustation ou d'un de ses parents ont changé.

Références m_category.

◆ IsVisible()

C3D_API bool Castor3D::Overlay::IsVisible ( ) const

Récupère le statut de visibilité

Renvoie
La valeur

◆ Render()

virtual C3D_API void Castor3D::Overlay::Render ( Castor::Size const &  p_size)
virtual

Dessine l'incrustation.

Paramètres
[in]p_sizeLes dimensions de la cible du rendu

◆ SetMaterial()

void Castor3D::Overlay::SetMaterial ( MaterialSPtr  p_material)
inline

Définit le matériau.

Paramètres
[in]p_materialLa nouvelle valeur

Références m_category.

◆ SetName()

void Castor3D::Overlay::SetName ( Castor::String const &  p_name)
inline

Définit le nom de l'incrustation.

Paramètres
[in]p_nameLe nouveau nom

Références m_name.

◆ SetOrder()

void Castor3D::Overlay::SetOrder ( int  p_index,
int  p_level 
)
inline

Définit l'ordre de l'incrustation.

Paramètres
[in]p_indexLe nouvel indice
[in]p_levelLe nouveau niveau

Références m_category.

◆ SetPixelPosition()

void Castor3D::Overlay::SetPixelPosition ( Castor::Position const &  p_position)
inline

Définit la position relative de l'incrustation.

Paramètres
[in]p_positionLa nouvelle position

Références m_category.

◆ SetPixelSize()

void Castor3D::Overlay::SetPixelSize ( Castor::Size const &  p_size)
inline

Définit les dimensions relatives de l'incrustation.

Paramètres
[in]p_sizeLes nouvelles dimensions

Références m_category.

◆ SetPosition()

void Castor3D::Overlay::SetPosition ( Castor::Point2d const &  p_position)
inline

Définit la position relative de l'incrustation.

Paramètres
[in]p_positionLa nouvelle position

Références m_category.

◆ SetSize()

void Castor3D::Overlay::SetSize ( Castor::Point2d const &  p_size)
inline

Définit les dimensions relatives de l'incrustation.

Paramètres
[in]p_sizeLes nouvelles dimensions

Références m_category.

◆ SetVisible()

void Castor3D::Overlay::SetVisible ( bool  val)
inline

Définit le statut de visibilité

Paramètres
[in]valLa nouvelle valeur

Références m_category.

Documentation des données membres

◆ m_category

OverlayCategorySPtr Castor3D::Overlay::m_category
protected

La catégorie de l'incrustation.

Référencé par GetAbsolutePosition(), GetAbsoluteSize(), GetCategory(), GetIndex(), GetLevel(), GetMaterial(), GetPixelPosition(), GetPixelSize(), GetPosition(), GetSize(), GetType(), IsPositionChanged(), IsSizeChanged(), SetMaterial(), SetOrder(), SetPixelPosition(), SetPixelSize(), SetPosition(), SetSize(), et SetVisible().

◆ m_name

Castor::String Castor3D::Overlay::m_name
protected

Le nom de l'incrustation.

Référencé par GetName(), et SetName().

◆ m_overlays

OverlayPtrArray Castor3D::Overlay::m_overlays
protected

Les enfants.

Référencé par begin(), end(), et GetChildrenCount().

◆ m_parent

OverlayWPtr Castor3D::Overlay::m_parent
protected

L'incrustation parente, s'il y en a.

Référencé par GetParent().

◆ m_pScene

SceneWPtr Castor3D::Overlay::m_pScene
protected

La scène parente.

Référencé par GetScene().

◆ m_renderSystem

RenderSystem* Castor3D::Overlay::m_renderSystem
protected

Le système de rendu.

La documentation de cette classe a été générée à partir du fichier suivant :
Généré le Jeudi 23 Mars 2017 10:01:27 pour Castor3D par   doxygen 1.8.13