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

Contient les membres spécifiques à une catégorie d'incrustation. Plus de détails...

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

Classes

class  BinaryParser
 
class  TextLoader
 OverlayCategory loader. Plus de détails...
 
struct  Vertex
 Contient les données spécifiques de sommet pour un Overlay. Plus de détails...
 

Fonctions membres publiques

 OverlayCategory (eOVERLAY_TYPE p_eType)
 Constructeur. Plus de détails...
 
virtual ~OverlayCategory ()
 Destructeur. Plus de détails...
 
void Render ()
 Dessine l'incrustation. Plus de détails...
 
virtual void SetMaterial (MaterialSPtr p_pMaterial)
 Définit le matériau. Plus de détails...
 
Castor::String const & GetOverlayName () const
 Récupère le nom de l'incrustation. Plus de détails...
 
virtual void UpdatePositionAndSize ()
 Met à jour la position et la tille de l'incrustation, en prenant en compte la taille en pixel et la position en pixel voulues. 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...
 
void SetPosition (Castor::Point2d const &p_ptPosition)
 Définit la position de l'incrustation. Plus de détails...
 
void SetSize (Castor::Point2d const &p_ptSize)
 Définit la taille 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::Point2d const & GetPosition () 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...
 
Castor::Position const & GetPixelPosition () const
 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::Point2d & GetPosition ()
 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...
 
Castor::Position & GetPixelPosition ()
 Récupère la position de l'incrustation. Plus de détails...
 
eOVERLAY_TYPE GetType () const
 Récupère le type de l'incrustation. Plus de détails...
 
bool IsVisible () const
 Récupère le statut de visibilité Plus de détails...
 
MaterialSPtr GetMaterial () const
 Récupère le matériau. Plus de détails...
 
int GetZIndex () const
 Récupère le Z index. Plus de détails...
 
Overlay const & GetOverlay () const
 Récupère l'incrustation. Plus de détails...
 
Overlay & GetOverlay ()
 Récupère l'incrustation. Plus de détails...
 
void SetOverlay (Overlay *val)
 Définit l'incrustation. Plus de détails...
 
void SetVisible (bool val)
 Définit le statut de visibilité Plus de détails...
 
void SetPixelPosition (Castor::Position const &val)
 Définit la position de l'incrustation. Plus de détails...
 
void SetPixelSize (Castor::Size const &val)
 Définit la taille de l'incrustation. Plus de détails...
 
void SetZIndex (int p_iZIndex)
 Définit le Z index. Plus de détails...
 
void SetRenderer (OverlayRendererSPtr p_pRenderer)
 Définit le renderer d'incrustations. Plus de détails...
 
std::vector
< OverlayCategory::Vertex >
const & 		GetVertexBuffer () const
 Récupère le tampon de sommets. Plus de détails...
 
void SetUV (Castor::Point4d const &val)
 Définit Les UV de l'incrustation. Plus de détails...
 
Castor::Point4d const & GetUV () const
 Récupère Les UV de l'incrustation. Plus de détails...
 

Fonctions membres protégées

virtual void DoRender (OverlayRendererSPtr p_renderer)=0
 Dessine l'incrustation. Plus de détails...
 
virtual void DoUpdate (OverlayRendererSPtr p_renderer)=0
 Met à jour le tampon de sommets. Plus de détails...
 

Attributs protégés

Overlay * m_pOverlay
 L'incrustation. Plus de détails...
 
Castor::Point2d m_ptPosition
 La position relative (au parent ou à l'écran) Plus de détails...
 
Castor::Point2d m_ptSize
 La taille relative (à l'écran ou au parent) Plus de détails...
 
Castor::Position m_position
 La position relative (à l'écran ou au parent), en pixels. Plus de détails...
 
Castor::Size m_size
 La taille absolue en pixels. Plus de détails...
 
bool m_bVisible
 La visibilité Plus de détails...
 
MaterialWPtr m_pMaterial
 Le matériau utilisé par l'incrustation. Plus de détails...
 
int m_iCurrentZIndex
 Le Z index de l'overlay. Plus de détails...
 
Castor::String m_strMatName
 Le nom du matériau. Plus de détails...
 
eOVERLAY_TYPE m_eType
 Le type de l'incrustation. Plus de détails...
 
OverlayRendererWPtr m_pRenderer
 Le renderer d'incrustation. Plus de détails...
 
std::vector
< OverlayCategory::Vertex > 		m_arrayVtx
 Les données du tampon de sommets. Plus de détails...
 
bool m_changed
 Dit que l'incrustation a changé et doit être mise à jour. Plus de détails...
 
Castor::Point4d m_uv
 Les UV du panneau. Plus de détails...
 

Description détaillée

Contient les membres spécifiques à une catégorie d'incrustation.

Auteur
Sylvain DOREMUS
Date
09/02/2010
Version
0.1

Documentation des constructeurs et destructeur

Castor3D::OverlayCategory::OverlayCategory ( eOVERLAY_TYPE  p_eType)

Constructeur.

Paramètres
[in]p_eTypeLe type de l'incrustation
virtual Castor3D::OverlayCategory::~OverlayCategory ( )
virtual

Destructeur.

Documentation des fonctions membres

virtual void Castor3D::OverlayCategory::DoRender ( OverlayRendererSPtr  p_renderer)
protectedpure virtual

Dessine l'incrustation.

Paramètres
[in]p_rendererLe renderer utilisé pour dessiner cette incrustation

Implémenté dans Castor3D::BorderPanelOverlay, Castor3D::TextOverlay, et Castor3D::PanelOverlay.

virtual void Castor3D::OverlayCategory::DoUpdate ( OverlayRendererSPtr  p_renderer)
protectedpure virtual

Met à jour le tampon de sommets.

Paramètres
[in]p_rendererLe renderer utilisé pour dessiner cette incrustation

Implémenté dans Castor3D::BorderPanelOverlay, Castor3D::TextOverlay, et Castor3D::PanelOverlay.

Castor::Position Castor3D::OverlayCategory::GetAbsolutePosition ( Castor::Size const &  p_size) const

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

Paramètres
[in]p_sizeLa taille de l'écran
Renvoie
La position
Castor::Point2d Castor3D::OverlayCategory::GetAbsolutePosition ( ) const

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

Renvoie
La position
Castor::Size Castor3D::OverlayCategory::GetAbsoluteSize ( Castor::Size const &  p_size) const

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

Paramètres
[in]p_sizeLa taille de l'écran
Renvoie
La taille
Castor::Point2d Castor3D::OverlayCategory::GetAbsoluteSize ( ) const

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

Renvoie
La taille
MaterialSPtr Castor3D::OverlayCategory::GetMaterial ( ) const
inline

Récupère le matériau.

Renvoie
La valeur

Références m_pMaterial.

Overlay const& Castor3D::OverlayCategory::GetOverlay ( ) const
inline

Récupère l'incrustation.

Renvoie
La valeur

Références m_pOverlay.

Overlay& Castor3D::OverlayCategory::GetOverlay ( )
inline

Récupère l'incrustation.

Renvoie
La valeur

Références m_pOverlay.

Castor::String const& Castor3D::OverlayCategory::GetOverlayName ( ) const

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

Renvoie
La valeur
Castor::Position const& Castor3D::OverlayCategory::GetPixelPosition ( ) const
inline

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

Renvoie
La valeur

Références m_position.

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

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

Renvoie
La valeur

Références m_position.

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

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

Renvoie
La valeur

Références m_size.

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

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

Renvoie
La valeur

Références m_size.

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

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

Renvoie
La valeur

Références m_ptPosition.

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

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

Renvoie
La valeur

Références m_ptPosition.

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

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

Renvoie
La valeur

Références m_ptSize.

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

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

Renvoie
La valeur

Références m_ptSize.

eOVERLAY_TYPE Castor3D::OverlayCategory::GetType ( ) const
inline

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

Renvoie
La valeur

Références m_eType.

Castor::Point4d const& Castor3D::OverlayCategory::GetUV ( ) const
inline

Récupère Les UV de l'incrustation.

Renvoie
La valeur (gauche, haut, droite, bas)

Références m_uv.

std::vector< OverlayCategory::Vertex > const& Castor3D::OverlayCategory::GetVertexBuffer ( ) const
inline

Récupère le tampon de sommets.

Renvoie
Le tampon

Références m_arrayVtx.

int Castor3D::OverlayCategory::GetZIndex ( ) const
inline

Récupère le Z index.

Renvoie
La valeur

Références m_iCurrentZIndex.

bool Castor3D::OverlayCategory::IsVisible ( ) const
inline

Récupère le statut de visibilité

Renvoie
La valeur

Références m_bVisible.

void Castor3D::OverlayCategory::Render ( )

Dessine l'incrustation.

virtual void Castor3D::OverlayCategory::SetMaterial ( MaterialSPtr  p_pMaterial)
virtual

Définit le matériau.

Paramètres
[in]p_pMaterialLa nouvelle valeur

Réimplémentée dans Castor3D::TextOverlay.

void Castor3D::OverlayCategory::SetOverlay ( Overlay *  val)
inline

Définit l'incrustation.

Paramètres
[in]valLa nouvelle valeur

Références m_pOverlay.

void Castor3D::OverlayCategory::SetPixelPosition ( Castor::Position const &  val)
inline

Définit la position de l'incrustation.

Paramètres
[in]valLa nouvelle valeur

Références m_position.

void Castor3D::OverlayCategory::SetPixelSize ( Castor::Size const &  val)
inline

Définit la taille de l'incrustation.

Paramètres
[in]valLa nouvelle valeur

Références m_size.

void Castor3D::OverlayCategory::SetPosition ( Castor::Point2d const &  p_ptPosition)
inline

Définit la position de l'incrustation.

Paramètres
[in]p_ptPositionLa nouvelle valeur

Références m_ptPosition.

void Castor3D::OverlayCategory::SetRenderer ( OverlayRendererSPtr  p_pRenderer)
inline

Définit le renderer d'incrustations.

Paramètres
[in]p_pRendererLa nouvelle valeur

Références m_pRenderer.

void Castor3D::OverlayCategory::SetSize ( Castor::Point2d const &  p_ptSize)
inline

Définit la taille de l'incrustation.

Paramètres
[in]p_pParentL'overlay parent
[in]p_ptSizeLa nouvelle valeur

Références m_ptSize.

void Castor3D::OverlayCategory::SetUV ( Castor::Point4d const &  val)
inline

Définit Les UV de l'incrustation.

Paramètres
[in]valLa nouvelle valeur (gauche, haut, droite, bas)

Références m_uv.

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

Définit le statut de visibilité

Paramètres
[in]valLa nouvelle valeur

Références m_bVisible.

void Castor3D::OverlayCategory::SetZIndex ( int  p_iZIndex)
inline

Définit le Z index.

Paramètres
[in]p_iZIndexLa nouvelle valeur

Références m_changed, et m_iCurrentZIndex.

virtual void Castor3D::OverlayCategory::UpdatePositionAndSize ( )
virtual

Met à jour la position et la tille de l'incrustation, en prenant en compte la taille en pixel et la position en pixel voulues.

Réimplémentée dans Castor3D::BorderPanelOverlay.

Documentation des données membres

std::vector< OverlayCategory::Vertex > Castor3D::OverlayCategory::m_arrayVtx
protected

Les données du tampon de sommets.

Référencé par GetVertexBuffer().

bool Castor3D::OverlayCategory::m_bVisible
protected

La visibilité

Référencé par IsVisible(), et SetVisible().

bool Castor3D::OverlayCategory::m_changed
protected

Dit que l'incrustation a changé et doit être mise à jour.

Référencé par SetZIndex().

eOVERLAY_TYPE Castor3D::OverlayCategory::m_eType
protected

Le type de l'incrustation.

Référencé par GetType().

int Castor3D::OverlayCategory::m_iCurrentZIndex
protected

Le Z index de l'overlay.

Référencé par GetZIndex(), et SetZIndex().

MaterialWPtr Castor3D::OverlayCategory::m_pMaterial
protected

Le matériau utilisé par l'incrustation.

Référencé par GetMaterial().

Castor::Position Castor3D::OverlayCategory::m_position
protected

La position relative (à l'écran ou au parent), en pixels.

Référencé par GetPixelPosition(), et SetPixelPosition().

Overlay* Castor3D::OverlayCategory::m_pOverlay
protected

L'incrustation.

Référencé par GetOverlay(), et SetOverlay().

OverlayRendererWPtr Castor3D::OverlayCategory::m_pRenderer
protected

Le renderer d'incrustation.

Référencé par SetRenderer().

Castor::Point2d Castor3D::OverlayCategory::m_ptPosition
protected

La position relative (au parent ou à l'écran)

Référencé par GetPosition(), et SetPosition().

Castor::Point2d Castor3D::OverlayCategory::m_ptSize
protected

La taille relative (à l'écran ou au parent)

Référencé par GetSize(), et SetSize().

Castor::Size Castor3D::OverlayCategory::m_size
protected

La taille absolue en pixels.

Référencé par GetPixelSize(), et SetPixelSize().

Castor::String Castor3D::OverlayCategory::m_strMatName
protected

Le nom du matériau.

Castor::Point4d Castor3D::OverlayCategory::m_uv
protected

Les UV du panneau.

Référencé par GetUV(), et SetUV().

La documentation de cette classe a été générée à partir du fichier suivant :
Généré le Mercredi 3 Décembre 2014 03:41:42 pour Castor3D par   doxygen 1.8.8