Castor3D 0.13.0
Multiplatform 3D engine
Fonctions membres publiques | Fonctions membres publiques statiques | Fonctions membres protégées | Attributs protégés | Liste de tous les membres
Référence de la classe castor3d::BorderPanelOverlay

#include <BorderPanelOverlay.hpp>

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

Fonctions membres publiques

C3D_API BorderPanelOverlay ()
 Constructeur. Plus de détails...
 
C3D_API void accept (OverlayVisitor &visitor) const override
 Dessine l'incrustation. Plus de détails...
 
C3D_API void setBorderMaterial (MaterialRPtr material)
 Définit le matériau des bords. Plus de détails...
 
C3D_API castor::Rectangle getAbsoluteBorderSize (castor::Size const &size) const
 Récupère la taille absolue des bordures de l'incrustation. Plus de détails...
 
C3D_API castor::Point4d getAbsoluteBorderSize () const
 Récupère la taille absolue des bordures de l'incrustation. Plus de détails...
 
C3D_API bool isChanged () const override
 
OverlayCategory::VertexArray const & getPanelVertex () const
 Récupère le tampon de sommets du panneau. Plus de détails...
 
double getLeftBorderSize () const
 Récupère l'épaisseur du bord gauche. Plus de détails...
 
double getTopBorderSize () const
 Récupère l'épaisseur du bord haut. Plus de détails...
 
double getRightBorderSize () const
 Récupère l'épaisseur du bord droit. Plus de détails...
 
double getBottomBorderSize () const
 Récupère l'épaisseur du bord bas. Plus de détails...
 
castor::Point4d const & getBorderSize () const
 Récupère les épaisseurs des bords. Plus de détails...
 
castor::Point4d & getBorderSize ()
 Récupère les épaisseurs des bords. Plus de détails...
 
MaterialRPtr getBorderMaterial () const
 Récupère le matériau des bords. Plus de détails...
 
void setLeftBorderSize (double size)
 Définit l'épaisseur du bord gauche. Plus de détails...
 
void setTopBorderSize (double size)
 Définit l'épaisseur du bord haut. Plus de détails...
 
void setRightBorderSize (double size)
 Définit l'épaisseur du bord droit. Plus de détails...
 
void setBottomBorderSize (double size)
 Définit l'épaisseur du bord bas. Plus de détails...
 
void setBorderSize (castor::Point4d const &size)
 Définit l'épaisseur des bords. Plus de détails...
 
int getLeftBorderPixelSize () const
 Récupère l'épaisseur du bord gauche. Plus de détails...
 
int getTopBorderPixelSize () const
 Récupère l'épaisseur du bord haut. Plus de détails...
 
int getRightBorderPixelSize () const
 Récupère l'épaisseur du bord droit. Plus de détails...
 
int getBottomBorderPixelSize () const
 Récupère l'épaisseur du bord bas. Plus de détails...
 
castor::Rectangle const & getBorderPixelSize () const
 Récupère les épaisseurs des bords. Plus de détails...
 
castor::Rectangle & getBorderPixelSize ()
 Récupère les épaisseurs des bords. Plus de détails...
 
void setLeftBorderPixelSize (int size)
 Définit l'épaisseur du bord gauche. Plus de détails...
 
void setTopBorderPixelSize (int size)
 Définit l'épaisseur du bord haut. Plus de détails...
 
void setRightBorderPixelSize (int size)
 Définit l'épaisseur du bord droit. Plus de détails...
 
void setBottomBorderPixelSize (int size)
 Définit l'épaisseur du bord bas. Plus de détails...
 
void setBorderPixelSize (castor::Rectangle const &size)
 Définit l'épaisseur des bords. Plus de détails...
 
BorderPosition getBorderPosition () const
 Récupère la position de la bordure. Plus de détails...
 
void setBorderPosition (BorderPosition position)
 Définit la position de la bordure. Plus de détails...
 
OverlayCategory::VertexArray const & getBorderVertex () const
 Récupère le tampon de sommets de la bordure. Plus de détails...
 
void setBorderOuterUV (castor::Point4d const &value)
 Définit Les UV de la partie extérieure de la bordure. Plus de détails...
 
castor::Point4d const & getBorderOuterUV () const
 Récupère Les UV de la partie extérieure de la bordure. Plus de détails...
 
void setBorderInnerUV (castor::Point4d const &value)
 Définit Les UV de la partie intérieure de la bordure. Plus de détails...
 
castor::Point4d const & getBorderInnerUV () const
 Récupère Les UV de la partie intérieure de la bordure. Plus de détails...
 
- Fonctions membres publiques hérités de castor3d::OverlayCategory
 CU_DeclareVector (Vertex, Vertex)
 
C3D_API OverlayCategory (OverlayType type)
 Constructeur. Plus de détails...
 
virtual C3D_API ~OverlayCategory ()
 Destructeur. Plus de détails...
 
C3D_API void update (OverlayRenderer const &renderer)
 Met à jour la position, taille... Plus de détails...
 
virtual C3D_API void accept (OverlayVisitor &renderer) const =0
 Dessine l'incrustation. Plus de détails...
 
virtual C3D_API void setMaterial (MaterialRPtr 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 &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 &size) const
 Récupère la taille absolue de l'incrustation, en pixels. Plus de détails...
 
C3D_API castor::Point2f getRenderRatio (castor::Size const &size) const
 
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 &position)
 Définit la position de l'incrustation. Plus de détails...
 
void setSize (castor::Point2d const &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...
 
MaterialRPtr 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...
 
OverlaygetOverlay ()
 Récupère l'incrustation. Plus de détails...
 
void setOverlay (Overlay *value)
 Définit l'incrustation. Plus de détails...
 
void setVisible (bool value)
 Définit le statut de visibilité Plus de détails...
 
void setPixelPosition (castor::Position const &value)
 Définit la position de l'incrustation. Plus de détails...
 
void setPixelSize (castor::Size const &value)
 Définit la taille de l'incrustation. Plus de détails...
 
void setOrder (int index, int level)
 Définit l'ordre de l'incrustation. Plus de détails...
 
void setUV (castor::Point4d const &value)
 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 publiques statiques

static C3D_API OverlayCategorySPtr create ()
 Fonction de création utilisée par la fabrique. Plus de détails...
 

Fonctions membres protégées

C3D_API void doUpdateBuffer (castor::Size const &size) override
 Met à jour le tampon de sommets. Plus de détails...
 
C3D_API void doUpdateSize (OverlayRenderer const &renderer) override
 Met à jour la taille de l'incrustation, en prenant en compte la taille en pixel voulue. Plus de détails...
 
- Fonctions membres protégées hérités de castor3d::OverlayCategory
castor::Point2d doGetTotalSize (OverlayRenderer const &renderer) const
 
virtual void doUpdatePosition (OverlayRenderer const &renderer)
 Met à jour la position de l'incrustation, en prenant en compte la la position en pixel voulue. Plus de détails...
 
virtual void doUpdateSize (OverlayRenderer const &renderer)
 Met à jour la taille de l'incrustation, en prenant en compte la taille en pixel voulue. Plus de détails...
 
virtual void doUpdate (OverlayRenderer const &renderer)
 Met à jour la position, taille... Plus de détails...
 
virtual void doUpdateBuffer (castor::Size const &size)=0
 Met à jour le tampon de sommets. Plus de détails...
 

Attributs protégés

MaterialRPtr m_pBorderMaterial
 
castor::Point4d m_ptBorderSize
 
castor::Rectangle m_borderSize
 
castor::String m_strBorderMatName
 
BorderPosition m_borderPosition { BorderPosition::eInternal }
 
VertexArray m_arrayVtx
 
OverlayCategory::VertexArray m_arrayVtxBorder
 
castor::Point4d m_borderOuterUv
 
castor::Point4d m_borderInnerUv
 
bool m_borderChanged
 
- Attributs protégés hérités de castor3d::OverlayCategory
Overlaym_pOverlay { nullptr }
 
castor::Point2d m_position
 
castor::Point2d m_ptSize
 
castor::Position m_pxPosition
 
castor::Size m_size
 
castor::Size m_computeSize
 
bool m_visible { true }
 
MaterialRPtr m_pMaterial
 
int m_index { 0 }
 
int m_level { 0 }
 
castor::String m_strMatName
 
OverlayType m_type
 
bool m_sizeChanged { true }
 
bool m_positionChanged { true }
 
castor::Point4d m_uv { 0.0, 0.0, 1.0, 1.0 }
 

Documentation des constructeurs et destructeur

◆ BorderPanelOverlay()

C3D_API castor3d::BorderPanelOverlay::BorderPanelOverlay ( )

Constructeur.

Documentation des fonctions membres

◆ accept()

C3D_API void castor3d::BorderPanelOverlay::accept ( OverlayVisitor visitor) const
overridevirtual

Dessine l'incrustation.

Implémente castor3d::OverlayCategory.

◆ create()

static C3D_API OverlayCategorySPtr castor3d::BorderPanelOverlay::create ( )
static

Fonction de création utilisée par la fabrique.

Renvoie
Un overlay

◆ doUpdateBuffer()

C3D_API void castor3d::BorderPanelOverlay::doUpdateBuffer ( castor::Size const &  size)
overrideprotectedvirtual

Met à jour le tampon de sommets.

Paramètres
[in]sizeLes dimensions de la cible de rendu.

Implémente castor3d::OverlayCategory.

◆ doUpdateSize()

C3D_API void castor3d::BorderPanelOverlay::doUpdateSize ( OverlayRenderer const &  renderer)
overrideprotectedvirtual

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

Réimplémentée à partir de castor3d::OverlayCategory.

◆ getAbsoluteBorderSize() [1/2]

C3D_API castor::Point4d castor3d::BorderPanelOverlay::getAbsoluteBorderSize ( ) const

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

Renvoie
La taille

◆ getAbsoluteBorderSize() [2/2]

C3D_API castor::Rectangle castor3d::BorderPanelOverlay::getAbsoluteBorderSize ( castor::Size const &  size) const

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

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

◆ getBorderInnerUV()

castor::Point4d const & castor3d::BorderPanelOverlay::getBorderInnerUV ( ) const
inline

Récupère Les UV de la partie intérieure de la bordure.

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

Références m_borderInnerUv.

◆ getBorderMaterial()

MaterialRPtr castor3d::BorderPanelOverlay::getBorderMaterial ( ) const
inline

Récupère le matériau des bords.

Renvoie
La valeur

Références m_pBorderMaterial.

◆ getBorderOuterUV()

castor::Point4d const & castor3d::BorderPanelOverlay::getBorderOuterUV ( ) const
inline

Récupère Les UV de la partie extérieure de la bordure.

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

Références m_borderOuterUv.

◆ getBorderPixelSize() [1/2]

castor::Rectangle & castor3d::BorderPanelOverlay::getBorderPixelSize ( )
inline

Récupère les épaisseurs des bords.

Renvoie
La valeur

Références m_borderChanged, et m_borderSize.

◆ getBorderPixelSize() [2/2]

castor::Rectangle const & castor3d::BorderPanelOverlay::getBorderPixelSize ( ) const
inline

Récupère les épaisseurs des bords.

Renvoie
La valeur

Références m_borderSize.

◆ getBorderPosition()

BorderPosition castor3d::BorderPanelOverlay::getBorderPosition ( ) const
inline

Récupère la position de la bordure.

Renvoie
La valeur

Références m_borderPosition.

◆ getBorderSize() [1/2]

castor::Point4d & castor3d::BorderPanelOverlay::getBorderSize ( )
inline

Récupère les épaisseurs des bords.

Renvoie
La valeur

Références m_borderChanged, et m_ptBorderSize.

◆ getBorderSize() [2/2]

castor::Point4d const & castor3d::BorderPanelOverlay::getBorderSize ( ) const
inline

Récupère les épaisseurs des bords.

Renvoie
La valeur

Références m_ptBorderSize.

◆ getBorderVertex()

OverlayCategory::VertexArray const & castor3d::BorderPanelOverlay::getBorderVertex ( ) const
inline

Récupère le tampon de sommets de la bordure.

Renvoie
Le tampon

Références m_arrayVtxBorder.

◆ getBottomBorderPixelSize()

int castor3d::BorderPanelOverlay::getBottomBorderPixelSize ( ) const
inline

Récupère l'épaisseur du bord bas.

Renvoie
La valeur

Références m_borderSize.

◆ getBottomBorderSize()

double castor3d::BorderPanelOverlay::getBottomBorderSize ( ) const
inline

Récupère l'épaisseur du bord bas.

Renvoie
La valeur

Références m_ptBorderSize.

◆ getLeftBorderPixelSize()

int castor3d::BorderPanelOverlay::getLeftBorderPixelSize ( ) const
inline

Récupère l'épaisseur du bord gauche.

Renvoie
La valeur

Références m_borderSize.

◆ getLeftBorderSize()

double castor3d::BorderPanelOverlay::getLeftBorderSize ( ) const
inline

Récupère l'épaisseur du bord gauche.

Renvoie
La valeur

Références m_ptBorderSize.

◆ getPanelVertex()

OverlayCategory::VertexArray const & castor3d::BorderPanelOverlay::getPanelVertex ( ) const
inline

Récupère le tampon de sommets du panneau.

Renvoie
Le tampon

Références m_arrayVtx.

◆ getRightBorderPixelSize()

int castor3d::BorderPanelOverlay::getRightBorderPixelSize ( ) const
inline

Récupère l'épaisseur du bord droit.

Renvoie
La valeur

Références m_borderSize.

◆ getRightBorderSize()

double castor3d::BorderPanelOverlay::getRightBorderSize ( ) const
inline

Récupère l'épaisseur du bord droit.

Renvoie
La valeur

Références m_ptBorderSize.

◆ getTopBorderPixelSize()

int castor3d::BorderPanelOverlay::getTopBorderPixelSize ( ) const
inline

Récupère l'épaisseur du bord haut.

Renvoie
La valeur

Références m_borderSize.

◆ getTopBorderSize()

double castor3d::BorderPanelOverlay::getTopBorderSize ( ) const
inline

Récupère l'épaisseur du bord haut.

Renvoie
La valeur

Références m_ptBorderSize.

◆ isChanged()

C3D_API bool castor3d::BorderPanelOverlay::isChanged ( ) const
inlineoverridevirtual
Renvoie
true si cette incrustation a changé.

Réimplémentée à partir de castor3d::OverlayCategory.

Références m_borderChanged.

◆ setBorderInnerUV()

void castor3d::BorderPanelOverlay::setBorderInnerUV ( castor::Point4d const &  value)
inline

Définit Les UV de la partie intérieure de la bordure.

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

Références m_borderInnerUv.

◆ setBorderMaterial()

C3D_API void castor3d::BorderPanelOverlay::setBorderMaterial ( MaterialRPtr  material)

Définit le matériau des bords.

Paramètres
[in]materialLa nouvelle valeur

◆ setBorderOuterUV()

void castor3d::BorderPanelOverlay::setBorderOuterUV ( castor::Point4d const &  value)
inline

Définit Les UV de la partie extérieure de la bordure.

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

Références m_borderOuterUv.

◆ setBorderPixelSize()

void castor3d::BorderPanelOverlay::setBorderPixelSize ( castor::Rectangle const &  size)
inline

Définit l'épaisseur des bords.

Paramètres
[in]sizeLa nouvelle valeur

Références m_borderChanged, et m_borderSize.

◆ setBorderPosition()

void castor3d::BorderPanelOverlay::setBorderPosition ( BorderPosition  position)
inline

Définit la position de la bordure.

Paramètres
[in]positionLa nouvelle valeur

Références m_borderPosition.

◆ setBorderSize()

void castor3d::BorderPanelOverlay::setBorderSize ( castor::Point4d const &  size)
inline

Définit l'épaisseur des bords.

Paramètres
[in]sizeLa nouvelle valeur

Références m_borderChanged, et m_ptBorderSize.

◆ setBottomBorderPixelSize()

void castor3d::BorderPanelOverlay::setBottomBorderPixelSize ( int  size)
inline

Définit l'épaisseur du bord bas.

Paramètres
[in]sizeLa nouvelle valeur

Références m_borderChanged, et m_borderSize.

◆ setBottomBorderSize()

void castor3d::BorderPanelOverlay::setBottomBorderSize ( double  size)
inline

Définit l'épaisseur du bord bas.

Paramètres
[in]sizeLa nouvelle valeur

Références m_borderChanged, et m_ptBorderSize.

◆ setLeftBorderPixelSize()

void castor3d::BorderPanelOverlay::setLeftBorderPixelSize ( int  size)
inline

Définit l'épaisseur du bord gauche.

Paramètres
[in]sizeLa nouvelle valeur

Références m_borderChanged, et m_borderSize.

◆ setLeftBorderSize()

void castor3d::BorderPanelOverlay::setLeftBorderSize ( double  size)
inline

Définit l'épaisseur du bord gauche.

Paramètres
[in]sizeLa nouvelle valeur

Références m_borderChanged, et m_ptBorderSize.

◆ setRightBorderPixelSize()

void castor3d::BorderPanelOverlay::setRightBorderPixelSize ( int  size)
inline

Définit l'épaisseur du bord droit.

Paramètres
[in]sizeLa nouvelle valeur

Références m_borderChanged, et m_borderSize.

◆ setRightBorderSize()

void castor3d::BorderPanelOverlay::setRightBorderSize ( double  size)
inline

Définit l'épaisseur du bord droit.

Paramètres
[in]sizeLa nouvelle valeur

Références m_borderChanged, et m_ptBorderSize.

◆ setTopBorderPixelSize()

void castor3d::BorderPanelOverlay::setTopBorderPixelSize ( int  size)
inline

Définit l'épaisseur du bord haut.

Paramètres
[in]sizeLa nouvelle valeur

Références m_borderChanged, et m_borderSize.

◆ setTopBorderSize()

void castor3d::BorderPanelOverlay::setTopBorderSize ( double  size)
inline

Définit l'épaisseur du bord haut.

Paramètres
[in]sizeLa nouvelle valeur

Références m_borderChanged, et m_ptBorderSize.

Documentation des données membres

◆ m_arrayVtx

VertexArray castor3d::BorderPanelOverlay::m_arrayVtx
protected

Les données du tampon de sommets.

Référencé par getPanelVertex().

◆ m_arrayVtxBorder

OverlayCategory::VertexArray castor3d::BorderPanelOverlay::m_arrayVtxBorder
protected

Les données du tampon de sommets pour la bordure.

Référencé par getBorderVertex().

◆ m_borderChanged

bool castor3d::BorderPanelOverlay::m_borderChanged
protected

◆ m_borderInnerUv

castor::Point4d castor3d::BorderPanelOverlay::m_borderInnerUv
protected

Les UV de la partie intérieure de la bordure.

Référencé par getBorderInnerUV(), et setBorderInnerUV().

◆ m_borderOuterUv

castor::Point4d castor3d::BorderPanelOverlay::m_borderOuterUv
protected

Les UV de la partie extérieure de la bordure.

Référencé par getBorderOuterUV(), et setBorderOuterUV().

◆ m_borderPosition

BorderPosition castor3d::BorderPanelOverlay::m_borderPosition { BorderPosition::eInternal }
protected

Le nom du matériau des bords.

Référencé par getBorderPosition(), et setBorderPosition().

◆ m_borderSize

castor::Rectangle castor3d::BorderPanelOverlay::m_borderSize
protected

◆ m_pBorderMaterial

MaterialRPtr castor3d::BorderPanelOverlay::m_pBorderMaterial
protected

Le matériau des bords.

Référencé par getBorderMaterial().

◆ m_ptBorderSize

castor::Point4d castor3d::BorderPanelOverlay::m_ptBorderSize
protected

◆ m_strBorderMatName

castor::String castor3d::BorderPanelOverlay::m_strBorderMatName
protected

Le nom du matériau des bords.


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