Référence de la classe castor3d::BorderPanelOverlay

#include <BorderPanelOverlay.hpp>

Graphe d'héritage de castor3d::BorderPanelOverlay:

Graphe de collaboration de castor3d::BorderPanelOverlay:

Types publics
enum class	ComputeBindingIdx { eCamera , eOverlays , eVertex }

Fonctions membres publiques
C3D_API	BorderPanelOverlay ()
	Constructeur.
C3D_API void	accept (OverlayVisitor &visitor) const override
	Dessine l'incrustation.
C3D_API uint32_t	getCount (bool borders) const
C3D_API void	setBorderMaterial (MaterialObs material)
	Définit le matériau des bords.
C3D_API castor::Point4ui	getAbsoluteBorderSize (castor::Size const &size) const
	Récupère la taille absolue des bordures de l'incrustation.
C3D_API castor::Point4d	getAbsoluteBorderSize () const
	Récupère la taille absolue des bordures de l'incrustation.
C3D_API castor::Point4ui	computePixelBorderSize () const
	Récupère la taille absolue des bordures de l'incrustation.
Accesseurs.
bool	isChanged () const noexcept override
double	getRelativeLeftBorderSize () const noexcept
double	getRelativeTopBorderSize () const noexcept
double	getRelativeRightBorderSize () const noexcept
double	getRelativeBottomBorderSize () const noexcept
castor::Point4d const &	getRelativeBorderSize () const noexcept
bool	hasPixelBorderSize () const noexcept
uint32_t	getPixelLeftBorderSize () const noexcept
uint32_t	getPixelTopBorderSize () const noexcept
uint32_t	getPixelRightBorderSize () const noexcept
uint32_t	getPixelBottomBorderSize () const noexcept
castor::Point4ui const &	getPixelBorderSize () const noexcept
MaterialObs	getBorderMaterial () const noexcept
BorderPosition	getBorderPosition () const noexcept
castor::Point4d const &	getBorderOuterUV () const noexcept
castor::Point4d const &	getBorderInnerUV () const noexcept
Mutateurs.
void	setRelativeLeftBorderSize (double size) noexcept
void	setRelativeTopBorderSize (double size) noexcept
void	setRelativeRightBorderSize (double size) noexcept
void	setRelativeBottomBorderSize (double size) noexcept
void	setRelativeBorderSize (castor::Point4d const &size) noexcept
void	setPixelLeftBorderSize (uint32_t size) noexcept
void	setPixelRightBorderSize (uint32_t size) noexcept
void	setPixelTopBorderSize (uint32_t size) noexcept
void	setPixelBottomBorderSize (uint32_t size) noexcept
void	setPixelBorderSize (castor::Point4ui const &size) noexcept
void	setBorderPosition (BorderPosition position) noexcept
void	setBorderOuterUV (castor::Point4d const &value) noexcept
void	setBorderInnerUV (castor::Point4d const &value) noexcept
Fonctions membres publiques hérités de castor3d::OverlayCategory
	CU_DeclareVector (Vertex, Vertex)
C3D_API	OverlayCategory (OverlayType type)
	Constructeur.
virtual C3D_API	~OverlayCategory ()
	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	accept (OverlayVisitor &renderer) const =0
	Dessine l'incrustation.
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.
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
Overlay &	getOverlay () 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
Overlay *	m_overlay { nullptr }
castor::Point2d	m_relPosition
castor::Point2d	m_relSize
std::optional< castor::Position >	m_pxPosition
std::optional< castor::Size >	m_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

enum class castor3d::BorderPanelOverlay::ComputeBindingIdx

strong

Valeurs énumérées
eCamera
eOverlays
eVertex

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.

computePixelBorderSize()

C3D_API castor::Point4ui castor3d::BorderPanelOverlay::computePixelBorderSize

(

)

const

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

Renvoie

La taille

create()

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

static

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

Renvoie

Un overlay

createProgram()

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

static

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

Renvoie

Le programme.

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::Point4ui castor3d::BorderPanelOverlay::getAbsoluteBorderSize

(

castor::Size const &

size

)

const

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

Paramètres

[in]

size

La taille de l'écran

Renvoie

La taille

getBorderInnerUV()

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

inlinenoexcept

getBorderMaterial()

MaterialObs castor3d::BorderPanelOverlay::getBorderMaterial ( ) const

inlinenoexcept

getBorderOuterUV()

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

inlinenoexcept

getBorderPosition()

BorderPosition castor3d::BorderPanelOverlay::getBorderPosition ( ) const

inlinenoexcept

getCount()

C3D_API uint32_t castor3d::BorderPanelOverlay::getCount

(

bool

borders

)

const

Paramètres

[in]

borders

true pour les bordures, false pour le centre.

Renvoie

Le nombre de sommets nécessaires pour cette incrustation.

getPixelBorderSize()

castor::Point4ui const & castor3d::BorderPanelOverlay::getPixelBorderSize ( ) const

inlinenoexcept

Références hasPixelBorderSize().

Référencé par getPixelBottomBorderSize(), getPixelLeftBorderSize(), getPixelRightBorderSize(), et getPixelTopBorderSize().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

getPixelBottomBorderSize()

uint32_t castor3d::BorderPanelOverlay::getPixelBottomBorderSize ( ) const

inlinenoexcept

Références getPixelBorderSize(), et hasPixelBorderSize().

Voici le graphe d'appel pour cette fonction :

getPixelLeftBorderSize()

uint32_t castor3d::BorderPanelOverlay::getPixelLeftBorderSize ( ) const

inlinenoexcept

Références getPixelBorderSize(), et hasPixelBorderSize().

Voici le graphe d'appel pour cette fonction :

getPixelRightBorderSize()

uint32_t castor3d::BorderPanelOverlay::getPixelRightBorderSize ( ) const

inlinenoexcept

Références getPixelBorderSize(), et hasPixelBorderSize().

Voici le graphe d'appel pour cette fonction :

getPixelTopBorderSize()

uint32_t castor3d::BorderPanelOverlay::getPixelTopBorderSize ( ) const

inlinenoexcept

Références getPixelBorderSize(), et hasPixelBorderSize().

Voici le graphe d'appel pour cette fonction :

getRelativeBorderSize()

castor::Point4d const & castor3d::BorderPanelOverlay::getRelativeBorderSize ( ) const

inlinenoexcept

getRelativeBottomBorderSize()

double castor3d::BorderPanelOverlay::getRelativeBottomBorderSize ( ) const

inlinenoexcept

getRelativeLeftBorderSize()

double castor3d::BorderPanelOverlay::getRelativeLeftBorderSize ( ) const

inlinenoexcept

getRelativeRightBorderSize()

double castor3d::BorderPanelOverlay::getRelativeRightBorderSize ( ) const

inlinenoexcept

getRelativeTopBorderSize()

double castor3d::BorderPanelOverlay::getRelativeTopBorderSize ( ) const

inlinenoexcept

hasPixelBorderSize()

bool castor3d::BorderPanelOverlay::hasPixelBorderSize ( ) const

inlinenoexcept

Référencé par getPixelBorderSize(), getPixelBottomBorderSize(), getPixelLeftBorderSize(), getPixelRightBorderSize(), et getPixelTopBorderSize().

Voici le graphe des appelants de cette fonction :

isChanged()

bool castor3d::BorderPanelOverlay::isChanged ( ) const

inlineoverridevirtualnoexcept

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

setBorderInnerUV()

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

inlinenoexcept

setBorderMaterial()

C3D_API void castor3d::BorderPanelOverlay::setBorderMaterial

(

MaterialObs

material

)

Définit le matériau des bords.

Paramètres

[in]

material

La nouvelle valeur

setBorderOuterUV()

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

inlinenoexcept

setBorderPosition()

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

inlinenoexcept

Références castor3d::OverlayCategory::m_sizeChanged.

setPixelBorderSize()

void castor3d::BorderPanelOverlay::setPixelBorderSize ( castor::Point4ui const &  size )

inlinenoexcept

Références castor3d::OverlayCategory::m_sizeChanged.

setPixelBottomBorderSize()

void castor3d::BorderPanelOverlay::setPixelBottomBorderSize ( uint32_t  size )

inlinenoexcept

Références castor3d::OverlayCategory::m_sizeChanged.

setPixelLeftBorderSize()

void castor3d::BorderPanelOverlay::setPixelLeftBorderSize ( uint32_t  size )

inlinenoexcept

Références castor3d::OverlayCategory::m_sizeChanged.

setPixelRightBorderSize()

void castor3d::BorderPanelOverlay::setPixelRightBorderSize ( uint32_t  size )

inlinenoexcept

Références castor3d::OverlayCategory::m_sizeChanged.

setPixelTopBorderSize()

void castor3d::BorderPanelOverlay::setPixelTopBorderSize ( uint32_t  size )

inlinenoexcept

Références castor3d::OverlayCategory::m_sizeChanged.

setRelativeBorderSize()

void castor3d::BorderPanelOverlay::setRelativeBorderSize ( castor::Point4d const &  size )

inlinenoexcept

Références castor3d::OverlayCategory::m_sizeChanged.

setRelativeBottomBorderSize()

void castor3d::BorderPanelOverlay::setRelativeBottomBorderSize ( double  size )

inlinenoexcept

Références castor3d::OverlayCategory::m_sizeChanged.

setRelativeLeftBorderSize()

void castor3d::BorderPanelOverlay::setRelativeLeftBorderSize ( double  size )

inlinenoexcept

Références castor3d::OverlayCategory::m_sizeChanged.

setRelativeRightBorderSize()

void castor3d::BorderPanelOverlay::setRelativeRightBorderSize ( double  size )

inlinenoexcept

Références castor3d::OverlayCategory::m_sizeChanged.

setRelativeTopBorderSize()

void castor3d::BorderPanelOverlay::setRelativeTopBorderSize ( double  size )

inlinenoexcept

Références castor3d::OverlayCategory::m_sizeChanged.

---

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

• Overlay/BorderPanelOverlay.hpp