Castor3D 0.16.0
Multiplatform 3D engine
Types publics | Fonctions membres publiques | Fonctions membres publiques statiques | Liste de tous les membres
Référence de la classe castor3d::PanelOverlay

#include <PanelOverlay.hpp>

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

Types publics

enum class  ComputeBindingIdx { eCamera , eOverlays , eVertex }
 

Fonctions membres publiques

C3D_API PanelOverlay ()
 Constructeur.
 
C3D_API void accept (OverlayVisitor &visitor) const override
 Dessine l'incrustation.
 
C3D_API uint32_t getCount (bool) const
 
- Fonctions membres publiques hérités de castor3d::OverlayCategory
 CU_DeclareVector (Vertex, Vertex)
 
C3D_API OverlayCategory (OverlayType type)
 Constructeur.
 
virtual C3D_API ~OverlayCategory () noexcept=default
 Destructeur.
 
C3D_API void update (OverlayRenderer const &renderer)
 Met à jour la position, taille...
 
C3D_API void reset ()
 Marque cette catégorie comme propre.
 
virtual C3D_API void setMaterial (MaterialObs material)
 Définit le matériau.
 
C3D_API castor::String const & getOverlayName () const
 Récupère le nom de l'incrustation.
 
C3D_API castor::Position getAbsolutePosition (castor::Size const &size) const
 Récupère la position absolue de l'incrustation, en pixels.
 
C3D_API castor::Size getAbsoluteSize (castor::Size const &size) const
 Récupère la taille absolue de l'incrustation, en pixels.
 
C3D_API castor::Point2d getRenderRatio (castor::Size const &size) const
 
C3D_API castor::Point2d getAbsolutePosition () const
 Récupère la position absolue de l'incrustation.
 
C3D_API castor::Point2d getAbsoluteSize () const
 Récupère la taille absolue de l'incrustation.
 
C3D_API bool isSizeChanged () const
 
C3D_API bool isPositionChanged () const
 
C3D_API castor::Size computePixelSize () const
 Récupère la taille de l'incrustation.
 
C3D_API castor::Position computePixelPosition () const
 Récupère la position de l'incrustation.
 
C3D_API castor::Point4d computeScissorRect () const
 Met à jour le scissor pour cette incrustation.
 
virtual C3D_API bool isChanged () const noexcept
 
bool hasAnyChange () const noexcept
 
castor::Point4d const & getDisplayRect () const noexcept
 
castor::Point2d const & getRelativeSize () const noexcept
 
castor::Point2d const & getRelativePosition () const noexcept
 
OverlayType getType () const noexcept
 
bool isVisible () const noexcept
 
bool isDisplayable () const noexcept
 
MaterialObs getMaterial () const noexcept
 
uint32_t getIndex () const noexcept
 
uint32_t getLevel () const noexcept
 
Overlay const & getOverlay () const noexcept
 
OverlaygetOverlay () noexcept
 
castor::Point4d const & getUV () const noexcept
 
bool hasPixelPosition () const noexcept
 
bool hasPixelSize () const noexcept
 
castor::Position const & getPixelPosition () const noexcept
 
castor::Size const & getPixelSize () const noexcept
 
void setRelativePosition (castor::Point2d const &value) noexcept
 
void setRelativeSize (castor::Point2d const &value) noexcept
 
void setPixelPosition (castor::Position const &value) noexcept
 
void setPixelSize (castor::Size const &value) noexcept
 
void setOverlay (Overlay *value) noexcept
 
void setVisible (bool value) noexcept
 
void setOrder (uint32_t level, uint32_t index) noexcept
 
void setUV (castor::Point4d const &value) noexcept
 

Fonctions membres publiques statiques

static C3D_API OverlayCategoryUPtr create ()
 Fonction de création utilisée par la fabrique.
 
static C3D_API ashes::PipelineShaderStageCreateInfo createProgram (RenderDevice const &device)
 Crée le programme utilisé pour calculer les sommets de l'incrustation.
 

Membres hérités additionnels

- Fonctions membres protégées hérités de castor3d::OverlayCategory
C3D_API void updatePosition (OverlayRenderer const &renderer)
 Met à jour la position de l'incrustation, en prenant en compte la la position en pixel voulue.
 
C3D_API void updateSize (OverlayRenderer const &renderer)
 Met à jour la taille de l'incrustation, en prenant en compte la taille en pixel voulue.
 
C3D_API void updateClientArea ()
 Met à jour la taille de l'incrustation, en prenant en compte la taille en pixel voulue.
 
C3D_API castor::Point2d getParentSize () const
 
C3D_API bool isFullyCropped () const
 
- Attributs protégés hérités de castor3d::OverlayCategory
Overlaym_overlay { nullptr }
 
castor::Point2d m_relPosition
 
castor::Point2d m_relSize
 
std::optional< castor::Positionm_pxPosition
 
std::optional< castor::Sizem_pxSize
 
castor::Size m_computeSize
 
bool m_visible { true }
 
bool m_displayable { false }
 
MaterialObs m_material {}
 
uint32_t m_index { 0 }
 
uint32_t m_level { 0 }
 
OverlayType m_type
 
bool m_sizeChanged { true }
 
bool m_positionChanged { true }
 
castor::Point4d m_uv { 0.0, 0.0, 1.0, 1.0 }
 
castor::Point4d m_displayRect {}
 

Documentation des énumérations membres

◆ ComputeBindingIdx

Valeurs énumérées
eCamera 
eOverlays 
eVertex 

Documentation des constructeurs et destructeur

◆ PanelOverlay()

C3D_API castor3d::PanelOverlay::PanelOverlay ( )

Constructeur.

Documentation des fonctions membres

◆ accept()

C3D_API void castor3d::PanelOverlay::accept ( OverlayVisitor & visitor) const
overridevirtual

Dessine l'incrustation.

Implémente castor3d::OverlayCategory.

◆ create()

static C3D_API OverlayCategoryUPtr castor3d::PanelOverlay::create ( )
static

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

Renvoie
Un overlay

◆ createProgram()

static C3D_API ashes::PipelineShaderStageCreateInfo castor3d::PanelOverlay::createProgram ( RenderDevice const & device)
static

Crée le programme utilisé pour calculer les sommets de l'incrustation.

Renvoie
Le programme.

◆ getCount()

C3D_API uint32_t castor3d::PanelOverlay::getCount ( bool ) const
Renvoie
Le nombre de sommets nécessaires pour cette incrustation.

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