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	TextWriter
	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
	DECLARE_VECTOR (Vertex, Vertex)

C3D_API	OverlayCategory (OverlayType p_type)
	Constructeur. Plus de détails...

virtual C3D_API	~OverlayCategory ()
	Destructeur. Plus de détails...

virtual C3D_API std::unique_ptr< TextWriter >	CreateTextWriter (Castor::String const &p_tabs)=0
	Crée un OverlayCategory spécifique à la LightCategory. Plus de détails...

C3D_API void	Update ()
	Met à jour la position, taille... Plus de détails...

C3D_API void	Render ()
	Dessine l'incrustation. Plus de détails...

virtual C3D_API void	SetMaterial (MaterialSPtr p_material)
	Définit le matériau. Plus de détails...

C3D_API Castor::String const &	GetOverlayName () const
	Récupère le nom de l'incrustation. Plus de détails...

C3D_API Castor::Position	GetAbsolutePosition (Castor::Size const &p_size) const
	Récupère la position absolue de l'incrustation, en pixels. Plus de détails...

C3D_API Castor::Size	GetAbsoluteSize (Castor::Size const &p_size) const
	Récupère la taille absolue de l'incrustation, en pixels. Plus de détails...

C3D_API Castor::Point2d	GetAbsolutePosition () const
	Récupère la position absolue de l'incrustation. Plus de détails...

C3D_API Castor::Point2d	GetAbsoluteSize () const
	Récupère la taille absolue de l'incrustation. Plus de détails...

C3D_API bool	IsSizeChanged () const

C3D_API bool	IsPositionChanged () const

virtual C3D_API bool	IsChanged () const

void	SetPosition (Castor::Point2d const &p_position)
	Définit la position de l'incrustation. Plus de détails...

void	SetSize (Castor::Point2d const &p_size)
	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...

OverlayType	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	GetIndex () const
	Récupère l'indice. Plus de détails...

int	GetLevel () const
	Récupère le niveau. 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	SetOrder (int p_index, int p_level)
	Définit l'ordre de l'incrustation. 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
Castor::Point2d	DoGetTotalSize () const

virtual void	DoUpdatePosition ()
	Met à jour la position de l'incrustation, en prenant en compte la la position en pixel voulue. Plus de détails...

virtual void	DoUpdateSize ()
	Met à jour la taille de l'incrustation, en prenant en compte la taille en pixel voulue. Plus de détails...

virtual void	DoRender (OverlayRendererSPtr p_renderer)=0
	Dessine l'incrustation. Plus de détails...

virtual void	DoUpdate ()
	Met à jour la position, taille... Plus de détails...

virtual void	DoUpdateBuffer (Castor::Size const &p_size)=0
	Met à jour le tampon de sommets. Plus de détails...

Attributs protégés
Overlay *	m_pOverlay { nullptr }
	L'incrustation. Plus de détails...

Castor::Point2d	m_position
	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_pxPosition
	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_visible { true }
	La visibilité Plus de détails...

MaterialWPtr	m_pMaterial
	Le matériau utilisé par l'incrustation. Plus de détails...

int	m_index { 0 }
	L'index de l'overlay. Plus de détails...

int	m_level { 0 }
	Le niveau de l'overlay. Plus de détails...

Castor::String	m_strMatName
	Le nom du matériau. Plus de détails...

OverlayType	m_type
	Le type de l'incrustation. Plus de détails...

bool	m_sizeChanged { true }
	Dit si les dimensions de cette incrustation ont changé. Plus de détails...

bool	m_positionChanged { true }
	Dit si la position de cette incrustation a changé. Plus de détails...

Castor::Point4d	m_uv { 0.0, 0.0, 1.0, 1.0 }
	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

◆ OverlayCategory()

C3D_API Castor3D::OverlayCategory::OverlayCategory ( OverlayType p_type )

explicit

Constructeur.

Paramètres

[in] p_type Le type de l'incrustation

Référencé par Castor3D::OverlayCategory::TextWriter::WriteInto().

Voici le graphe des appelants de cette fonction :

◆ ~OverlayCategory()

virtual C3D_API Castor3D::OverlayCategory::~OverlayCategory ( )

virtual

Destructeur.

Référencé par Castor3D::OverlayCategory::TextWriter::WriteInto().

Voici le graphe des appelants de cette fonction :

Documentation des fonctions membres

◆ CreateTextWriter()

virtual C3D_API std::unique_ptr< TextWriter > Castor3D::OverlayCategory::CreateTextWriter ( Castor::String const & p_tabs )

pure virtual

Crée un OverlayCategory spécifique à la LightCategory.

Paramètres

[in] p_tabs Le niveau d'intentation actuel.

Renvoie: Le TextLoader.

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

Référencé par Castor3D::OverlayCategory::TextWriter::WriteInto().

Voici le graphe des appelants de cette fonction :

◆ DECLARE_VECTOR()

Castor3D::OverlayCategory::DECLARE_VECTOR	(	Vertex	,
		Vertex
	)

◆ DoGetTotalSize()

Castor::Point2d Castor3D::OverlayCategory::DoGetTotalSize ( ) const

protected

Renvoie: La taille de l'écran ou du parent.

Référencé par GetUV().

Voici le graphe des appelants de cette fonction :

◆ DoRender()

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

protectedpure virtual

Dessine l'incrustation.

Paramètres

[in] p_renderer Le renderer utilisé pour dessiner cette incrustation

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

Référencé par GetUV().

Voici le graphe des appelants de cette fonction :

◆ DoUpdate()

virtual void Castor3D::OverlayCategory::DoUpdate ( )

inlineprotectedvirtual

Met à jour la position, taille...

Références DoUpdateBuffer().

Voici le graphe d'appel pour cette fonction :

◆ DoUpdateBuffer()

virtual void Castor3D::OverlayCategory::DoUpdateBuffer ( Castor::Size const & p_size )

protectedpure virtual

Met à jour le tampon de sommets.

Paramètres

[in] p_size Les dimensions de la cible de rendu.

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

Référencé par DoUpdate().

Voici le graphe des appelants de cette fonction :

◆ DoUpdatePosition()

virtual void Castor3D::OverlayCategory::DoUpdatePosition ( )

protectedvirtual

Met à jour la position de l'incrustation, en prenant en compte la la position en pixel voulue.

Référencé par GetUV().

Voici le graphe des appelants de cette fonction :

◆ DoUpdateSize()

virtual void Castor3D::OverlayCategory::DoUpdateSize ( )

protectedvirtual

Met à jour la taille de l'incrustation, en prenant en compte la taille en pixel voulue.

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

Référencé par GetUV().

Voici le graphe des appelants de cette fonction :

◆ GetAbsolutePosition() [1/2]

C3D_API 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_size La taille de l'écran

Renvoie: La position

◆ GetAbsolutePosition() [2/2]

C3D_API Castor::Point2d Castor3D::OverlayCategory::GetAbsolutePosition ( ) const

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

Renvoie: La position

Référencé par Castor3D::OverlayCategory::TextWriter::WriteInto().

Voici le graphe des appelants de cette fonction :

◆ GetAbsoluteSize() [1/2]

C3D_API 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_size La taille de l'écran

Renvoie: La taille

◆ GetAbsoluteSize() [2/2]

C3D_API Castor::Point2d Castor3D::OverlayCategory::GetAbsoluteSize ( ) const

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

Renvoie: La taille

Référencé par Castor3D::OverlayCategory::TextWriter::WriteInto().

Voici le graphe des appelants de cette fonction :

◆ GetIndex()

int Castor3D::OverlayCategory::GetIndex ( ) const

inline

Récupère l'indice.

Renvoie: La valeur

Références m_index.

◆ GetLevel()

int Castor3D::OverlayCategory::GetLevel ( ) const

inline

Récupère le niveau.

Renvoie: La valeur

Références m_level.

◆ GetMaterial()

MaterialSPtr Castor3D::OverlayCategory::GetMaterial ( ) const

inline

Récupère le matériau.

Renvoie: La valeur

Références m_pMaterial.

◆ GetOverlay() [1/2]

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

inline

Récupère l'incrustation.

Renvoie: La valeur

Références m_pOverlay.

◆ GetOverlay() [2/2]

Overlay& Castor3D::OverlayCategory::GetOverlay ( )

inline

Récupère l'incrustation.

Renvoie: La valeur

Références m_pOverlay.

◆ GetOverlayName()

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

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

Renvoie: La valeur

Référencé par Castor3D::OverlayCategory::TextWriter::WriteInto().

Voici le graphe des appelants de cette fonction :

◆ GetPixelPosition() [1/2]

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

inline

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

Renvoie: La valeur

Références m_pxPosition.

◆ GetPixelPosition() [2/2]

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

inline

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

Renvoie: La valeur

Références m_pxPosition.

◆ GetPixelSize() [1/2]

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

inline

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

Renvoie: La valeur

Références m_size.

◆ GetPixelSize() [2/2]

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

inline

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

Renvoie: La valeur

Références m_size.

◆ GetPosition() [1/2]

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

inline

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

Renvoie: La valeur

Références m_position.

◆ GetPosition() [2/2]

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

inline

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

Renvoie: La valeur

Références m_position.

◆ GetSize() [1/2]

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

inline

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

Renvoie: La valeur

Références m_ptSize.

◆ GetSize() [2/2]

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

inline

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

Renvoie: La valeur

Références m_ptSize.

◆ GetType()

OverlayType Castor3D::OverlayCategory::GetType ( ) const

inline

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

Renvoie: La valeur

Références m_type.

◆ GetUV()

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 DoGetTotalSize(), DoRender(), DoUpdatePosition(), DoUpdateSize(), et m_uv.

Voici le graphe d'appel pour cette fonction :

◆ IsChanged()

virtual C3D_API bool Castor3D::OverlayCategory::IsChanged ( ) const

inlinevirtual

Renvoie: true si cette incrustation a changé.

Réimplémentée dans Castor3D::TextOverlay, et Castor3D::BorderPanelOverlay.

◆ IsPositionChanged()

C3D_API bool Castor3D::OverlayCategory::IsPositionChanged ( ) const

Renvoie: true si la position de cette incrustation ou d'un de ses parents a changé.

Référencé par Castor3D::OverlayCategory::TextWriter::WriteInto().

Voici le graphe des appelants de cette fonction :

◆ IsSizeChanged()

C3D_API bool Castor3D::OverlayCategory::IsSizeChanged ( ) const

Renvoie: true si les dimensions de cette incrustation ou d'un de ses parents ont changé.

Référencé par Castor3D::OverlayCategory::TextWriter::WriteInto().

Voici le graphe des appelants de cette fonction :

◆ IsVisible()

bool Castor3D::OverlayCategory::IsVisible ( ) const

inline

Récupère le statut de visibilité

Renvoie: La valeur

Références m_visible.

◆ Render()

C3D_API void Castor3D::OverlayCategory::Render ( )

Dessine l'incrustation.

Référencé par Castor3D::OverlayCategory::TextWriter::WriteInto().

Voici le graphe des appelants de cette fonction :

◆ SetMaterial()

virtual C3D_API void Castor3D::OverlayCategory::SetMaterial ( MaterialSPtr p_material )

virtual

Définit le matériau.

Paramètres

[in] p_material La nouvelle valeur

Référencé par Castor3D::OverlayCategory::TextWriter::WriteInto().

Voici le graphe des appelants de cette fonction :

◆ SetOrder()

void Castor3D::OverlayCategory::SetOrder	(	int	p_index,
		int	p_level
	)

inline

Définit l'ordre de l'incrustation.

Paramètres

[in]	p_index	Le nouvel indice
[in]	p_level	Le nouveau niveau

Références m_index, et m_level.

◆ SetOverlay()

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

inline

Définit l'incrustation.

Paramètres

[in] val La nouvelle valeur

Références m_pOverlay.

◆ SetPixelPosition()

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

inline

Définit la position de l'incrustation.

Paramètres

[in] val La nouvelle valeur

Références m_positionChanged, et m_pxPosition.

◆ SetPixelSize()

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

inline

Définit la taille de l'incrustation.

Paramètres

[in] val La nouvelle valeur

Références m_size, et m_sizeChanged.

◆ SetPosition()

void Castor3D::OverlayCategory::SetPosition ( Castor::Point2d const & p_position )

inline

Définit la position de l'incrustation.

Paramètres

[in] p_position La nouvelle valeur

Références m_position, et m_positionChanged.

◆ SetSize()

void Castor3D::OverlayCategory::SetSize ( Castor::Point2d const & p_size )

inline

Définit la taille de l'incrustation.

Paramètres

[in] p_size La nouvelle valeur

Références m_ptSize, et m_sizeChanged.

◆ SetUV()

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

inline

Définit Les UV de l'incrustation.

Paramètres

[in] val La nouvelle valeur (gauche, haut, droite, bas)

Références m_uv.

◆ SetVisible()

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

inline

Définit le statut de visibilité

Paramètres

[in] val La nouvelle valeur

Références m_visible.

◆ Update()

C3D_API void Castor3D::OverlayCategory::Update ( )

Met à jour la position, taille...

Référencé par Castor3D::OverlayCategory::TextWriter::WriteInto().

Voici le graphe des appelants de cette fonction :

Documentation des données membres

◆ m_index

int Castor3D::OverlayCategory::m_index { 0 }

protected

L'index de l'overlay.

Référencé par GetIndex(), et SetOrder().

◆ m_level

int Castor3D::OverlayCategory::m_level { 0 }

protected

Le niveau de l'overlay.

Référencé par GetLevel(), et SetOrder().

◆ m_pMaterial

MaterialWPtr Castor3D::OverlayCategory::m_pMaterial

protected

Le matériau utilisé par l'incrustation.

Référencé par GetMaterial().

◆ m_position

Castor::Point2d Castor3D::OverlayCategory::m_position

protected

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

Référencé par GetPosition(), Castor3D::TextOverlay::SetLineSpacingMode(), et SetPosition().

◆ m_positionChanged

bool Castor3D::OverlayCategory::m_positionChanged { true }

protected

Dit si la position de cette incrustation a changé.

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

◆ m_pOverlay

Overlay* Castor3D::OverlayCategory::m_pOverlay { nullptr }

protected

L'incrustation.

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

◆ m_ptSize

Castor::Point2d Castor3D::OverlayCategory::m_ptSize

protected

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

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

◆ m_pxPosition

Castor::Position Castor3D::OverlayCategory::m_pxPosition

protected

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

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

◆ m_size

Castor::Size Castor3D::OverlayCategory::m_size

protected

La taille absolue en pixels.

Référencé par GetPixelSize(), Castor3D::TextOverlay::SetLineSpacingMode(), et SetPixelSize().

◆ m_sizeChanged

bool Castor3D::OverlayCategory::m_sizeChanged { true }

protected

Dit si les dimensions de cette incrustation ont changé.

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

◆ m_strMatName

Castor::String Castor3D::OverlayCategory::m_strMatName

protected

Le nom du matériau.

◆ m_type

OverlayType Castor3D::OverlayCategory::m_type

protected

Le type de l'incrustation.

Référencé par GetType().

◆ m_uv

Castor::Point4d Castor3D::OverlayCategory::m_uv { 0.0, 0.0, 1.0, 1.0 }

protected

Les UV du panneau.

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

◆ m_visible

bool Castor3D::OverlayCategory::m_visible { true }

protected

La visibilité

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

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

Y:/software/perso/Castor3D/source/Core/Castor3D/Src/Overlay/OverlayCategory.hpp

Classes

Fonctions membres publiques

Fonctions membres protégées

Attributs protégés

Description détaillée

Documentation des constructeurs et destructeur

◆ OverlayCategory()

◆ ~OverlayCategory()

Documentation des fonctions membres

◆ CreateTextWriter()

◆ DECLARE_VECTOR()

◆ DoGetTotalSize()

◆ DoRender()

◆ DoUpdate()

◆ DoUpdateBuffer()

◆ DoUpdatePosition()

◆ DoUpdateSize()

◆ GetAbsolutePosition() [1/2]

◆ GetAbsolutePosition() [2/2]

◆ GetAbsoluteSize() [1/2]

◆ GetAbsoluteSize() [2/2]

◆ GetIndex()

◆ GetLevel()

◆ GetMaterial()

◆ GetOverlay() [1/2]

◆ GetOverlay() [2/2]

◆ GetOverlayName()

◆ GetPixelPosition() [1/2]

◆ GetPixelPosition() [2/2]

◆ GetPixelSize() [1/2]

◆ GetPixelSize() [2/2]

◆ GetPosition() [1/2]

◆ GetPosition() [2/2]

◆ GetSize() [1/2]

◆ GetSize() [2/2]

◆ GetType()

◆ GetUV()

◆ IsChanged()

◆ IsPositionChanged()

◆ IsSizeChanged()

◆ IsVisible()

◆ Render()

◆ SetMaterial()

◆ SetOrder()

◆ SetOverlay()

◆ SetPixelPosition()

◆ SetPixelSize()

◆ SetPosition()

◆ SetSize()

◆ SetUV()

◆ SetVisible()

◆ Update()

Documentation des données membres

◆ m_index

◆ m_level

◆ m_pMaterial

◆ m_position

◆ m_positionChanged

◆ m_pOverlay

◆ m_ptSize

◆ m_pxPosition

◆ m_size

◆ m_sizeChanged

◆ m_strMatName

◆ m_type

◆ m_uv

◆ m_visible