Graphe d'héritage de Castor3D::BillboardBase:

Graphe de collaboration de Castor3D::BillboardBase:

Fonctions membres publiques
C3D_API	BillboardBase (Scene &p_scene, SceneNodeSPtr p_node, VertexBufferSPtr p_vertexBuffer)
	Constructeur. Plus de détails...

C3D_API	~BillboardBase ()
	Destructeur. Plus de détails...

C3D_API bool	Initialise (uint32_t p_count)
	Initialise les éléments GPU. Plus de détails...

C3D_API void	Cleanup ()
	Nettoie les elements GPU. Plus de détails...

C3D_API void	Draw (GeometryBuffers const &p_geometryBuffers)
	Dessine les billboards. Plus de détails...

C3D_API GeometryBuffersSPtr	GetGeometryBuffers (ShaderProgram const &p_program)
	Récupère un GeometryBuffers pour le programme donné. Plus de détails...

C3D_API void	SortByDistance (Castor::Point3r const &p_cameraPosition)
	Trie les points des plus éloignés aux plus proches de la caméra. Plus de détails...

C3D_API void	Update ()
	Met à jour le tampon de sommets. Plus de détails...

C3D_API ProgramFlags	GetProgramFlags () const

void	SetMaterial (MaterialSPtr p_value)
	Definit le materiau. Plus de détails...

MaterialSPtr	GetMaterial () const

void	SetDimensions (Castor::Size const &p_value)
	Definit les dimensios des billboards. Plus de détails...

Castor::Size const &	GetDimensions () const

void	SetCenterOffset (uint32_t p_value)
	Definit le décalage de l'attribut du centre dans le tampon de sommets. Plus de détails...

void	SetCount (uint32_t p_value)
	Definit le nombre de billboards. Plus de détails...

uint32_t	GetCount () const

bool	IsInitialised () const

VertexBuffer const &	GetVertexBuffer () const

VertexBuffer &	GetVertexBuffer ()

Scene const &	GetParentScene () const

Scene &	GetParentScene ()

SceneNodeSPtr	GetNode () const

void	SetNode (SceneNodeSPtr p_value)

BillboardType	GetBillboardType () const

void	SetBillboardType (BillboardType p_value)

BillboardSize	GetBillboardSize () const

void	SetBillboardSize (BillboardSize p_value)

Fonctions membres publiques hérités de Castor3D::RenderedObject
bool	IsVisible () const

void	SetVisible (bool p_value)
	Définit le statut de visibilité. Plus de détails...

bool	IsShadowCaster () const

void	SetShadowCaster (bool p_value)
	Définit le statut de projection d'ombres. Plus de détails...

bool	IsShadowReceiver () const

void	SetShadowReceiver (bool p_value)
	Définit le statut de réception d'ombres. Plus de détails...

Attributs protégés
Scene &	m_scene

SceneNodeSPtr	m_node

MaterialWPtr	m_material

Castor::Size	m_dimensions

Castor::Point3r	m_cameraPosition

VertexBufferSPtr	m_vertexBuffer

VertexBufferSPtr	m_quad

std::vector< GeometryBuffersSPtr >	m_geometryBuffers

bool	m_needUpdate { true }

bool	m_initialised { false }

uint32_t	m_count { 0u }

uint32_t	m_centerOffset { 0u }

BillboardType	m_billboardType { BillboardType::eCylindrical }

BillboardSize	m_billboardSize { BillboardSize::eDynamic }

Description détaillée

Liste de billboards.

Auteur: Sylvain DOREMUS

Version: 0.9.0

Date: 23/10/2016

Remarques: Tous les billboards de cette liste ont la meme texture

Documentation des constructeurs et destructeur

◆ BillboardBase()

C3D_API Castor3D::BillboardBase::BillboardBase	(	Scene &	p_scene,
		SceneNodeSPtr	p_node,
		VertexBufferSPtr	p_vertexBuffer
	)

Constructeur.

Paramètres

[in]	p_scene	La scène parente.
[in]	p_node	Le noeud de scène parent.
[in]	p_vertexBuffer	Le tampon de sommets.

◆ ~BillboardBase()

C3D_API Castor3D::BillboardBase::~BillboardBase ( )

Destructeur.

Documentation des fonctions membres

◆ Cleanup()

C3D_API void Castor3D::BillboardBase::Cleanup ( )

Nettoie les elements GPU.

◆ Draw()

C3D_API void Castor3D::BillboardBase::Draw ( GeometryBuffers const & p_geometryBuffers )

Dessine les billboards.

Paramètres

[in] p_geometryBuffers Les tampons de géométrie utilisés pour dessiner ces billboards.

◆ GetBillboardSize()

BillboardSize Castor3D::BillboardBase::GetBillboardSize ( ) const

inline

Renvoie: Le type des dimensions de billboard.

Références m_billboardSize.

◆ GetBillboardType()

BillboardType Castor3D::BillboardBase::GetBillboardType ( ) const

inline

Renvoie: Le type de billboard.

Références m_billboardType.

◆ GetCount()

uint32_t Castor3D::BillboardBase::GetCount ( ) const

inline

Renvoie: Le nombre de billboards.

Références m_count.

◆ GetDimensions()

Castor::Size const& Castor3D::BillboardBase::GetDimensions ( ) const

inline

Renvoie: Les dimensions des billboards.

Références m_dimensions.

◆ GetGeometryBuffers()

C3D_API GeometryBuffersSPtr Castor3D::BillboardBase::GetGeometryBuffers ( ShaderProgram const & p_program )

Récupère un GeometryBuffers pour le programme donné.

Paramètres

[in] p_program Le programme.

◆ GetMaterial()

MaterialSPtr Castor3D::BillboardBase::GetMaterial ( ) const

inline

Renvoie: Le materiau.

Références m_material.

◆ GetNode()

SceneNodeSPtr Castor3D::BillboardBase::GetNode ( ) const

inline

Renvoie: Le noeud de scène parent.

Références m_node.

◆ GetParentScene() [1/2]

Scene const& Castor3D::BillboardBase::GetParentScene ( ) const

inline

Renvoie: La scène parente.

Références m_scene.

◆ GetParentScene() [2/2]

Scene& Castor3D::BillboardBase::GetParentScene ( )

inline

Renvoie: La scène parente.

Références m_scene.

◆ GetProgramFlags()

C3D_API ProgramFlags Castor3D::BillboardBase::GetProgramFlags ( ) const

Renvoie: Les indicateurs de programme.

◆ GetVertexBuffer() [1/2]

VertexBuffer const& Castor3D::BillboardBase::GetVertexBuffer ( ) const

inline

Renvoie: Le tampon de sommets.

Références m_vertexBuffer.

◆ GetVertexBuffer() [2/2]

VertexBuffer& Castor3D::BillboardBase::GetVertexBuffer ( )

inline

Renvoie: Le tampon de sommets.

Références m_vertexBuffer.

◆ Initialise()

C3D_API bool Castor3D::BillboardBase::Initialise ( uint32_t p_count )

Initialise les éléments GPU.

Paramètres

[in] p_count Le nombre d'éléments.

Renvoie: true si tout s'est bien passé.

◆ IsInitialised()

bool Castor3D::BillboardBase::IsInitialised ( ) const

inline

Renvoie: Le statut d'initialisation.

Références m_initialised.

◆ SetBillboardSize()

void Castor3D::BillboardBase::SetBillboardSize ( BillboardSize p_value )

inline

Renvoie: Définit le type des dimensions de billboard.

Paramètres

[in] p_value La nouvelle valeur.

Références m_billboardSize.

◆ SetBillboardType()

void Castor3D::BillboardBase::SetBillboardType ( BillboardType p_value )

inline

Renvoie: Définit le type de billboard.

Paramètres

[in] p_value La nouvelle valeur.

Références m_billboardType.

◆ SetCenterOffset()

void Castor3D::BillboardBase::SetCenterOffset ( uint32_t p_value )

inline

Definit le décalage de l'attribut du centre dans le tampon de sommets.

Paramètres

[in] p_value La nouvelle valeur.

Références m_centerOffset.

◆ SetCount()

void Castor3D::BillboardBase::SetCount ( uint32_t p_value )

inline

Definit le nombre de billboards.

Paramètres

[in] p_value La nouvelle valeur.

Références m_count.

◆ SetDimensions()

void Castor3D::BillboardBase::SetDimensions ( Castor::Size const & p_value )

inline

Definit les dimensios des billboards.

Paramètres

[in] p_value La nouvelle valeur

Références m_dimensions.

◆ SetMaterial()

void Castor3D::BillboardBase::SetMaterial ( MaterialSPtr p_value )

inline

Definit le materiau.

Paramètres

[in] p_value La nouvelle valeur

Références m_material.

◆ SetNode()

void Castor3D::BillboardBase::SetNode ( SceneNodeSPtr p_value )

inline

Renvoie: Le noeud de scène parent.

Paramètres

[in] p_value La nouvelle valeur.

Références m_node.

◆ SortByDistance()

C3D_API void Castor3D::BillboardBase::SortByDistance ( Castor::Point3r const & p_cameraPosition )

Trie les points des plus éloignés aux plus proches de la caméra.

Paramètres

[in] p_cameraPosition La position de la caméra, relative au billboard.

◆ Update()

C3D_API void Castor3D::BillboardBase::Update ( )

Met à jour le tampon de sommets.

Documentation des données membres

◆ m_billboardSize

BillboardSize Castor3D::BillboardBase::m_billboardSize { BillboardSize::eDynamic }

protected

Le type de dimensions de billboard.

Référencé par GetBillboardSize(), et SetBillboardSize().

◆ m_billboardType

BillboardType Castor3D::BillboardBase::m_billboardType { BillboardType::eCylindrical }

protected

Le type de billboard.

Référencé par GetBillboardType(), et SetBillboardType().

◆ m_cameraPosition

Castor::Point3r Castor3D::BillboardBase::m_cameraPosition

protected

La position transformée de la caméra au dernier tri.

◆ m_centerOffset

uint32_t Castor3D::BillboardBase::m_centerOffset { 0u }

protected

Le décalage de l'attribut du centre dans le tampon de sommets..

Référencé par SetCenterOffset().

◆ m_count

uint32_t Castor3D::BillboardBase::m_count { 0u }

protected

Le nombre d'éléments.

Référencé par GetCount(), et SetCount().

◆ m_dimensions

Castor::Size Castor3D::BillboardBase::m_dimensions

protected

Les dimensions des billboards.

Référencé par GetDimensions(), et SetDimensions().

◆ m_geometryBuffers

std::vector< GeometryBuffersSPtr > Castor3D::BillboardBase::m_geometryBuffers

protected

Les GeometryBuffers avec lesquel ce billboards list est compatible.

◆ m_initialised

bool Castor3D::BillboardBase::m_initialised { false }

protected

Dit si le billboard est initialisé.

Référencé par IsInitialised().

◆ m_material

MaterialWPtr Castor3D::BillboardBase::m_material

protected

Le matériau.

Référencé par GetMaterial(), et SetMaterial().

◆ m_needUpdate

bool Castor3D::BillboardBase::m_needUpdate { true }

protected

Dit que les positions ont change et doivent etre renvoyees au GPU.

Référencé par Castor3D::BillboardList::SetAt().

◆ m_node

SceneNodeSPtr Castor3D::BillboardBase::m_node

protected

Le noeud de scène parent.

Référencé par GetNode(), et SetNode().

◆ m_quad

VertexBufferSPtr Castor3D::BillboardBase::m_quad

protected

Le tampon de sommets contenant le quad instancié.

◆ m_scene

Scene& Castor3D::BillboardBase::m_scene

protected

La scène parente.

Référencé par GetParentScene().

◆ m_vertexBuffer

VertexBufferSPtr Castor3D::BillboardBase::m_vertexBuffer

protected

Le tampon de sommets.

Référencé par GetVertexBuffer().

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

Y:/software/perso/Castor3D/source/Core/Castor3D/Src/Scene/BillboardList.hpp

Fonctions membres publiques

Attributs protégés

Description détaillée

Documentation des constructeurs et destructeur

◆ BillboardBase()

◆ ~BillboardBase()

Documentation des fonctions membres

◆ Cleanup()

◆ Draw()

◆ GetBillboardSize()

◆ GetBillboardType()

◆ GetCount()

◆ GetDimensions()

◆ GetGeometryBuffers()

◆ GetMaterial()

◆ GetNode()

◆ GetParentScene() [1/2]

◆ GetParentScene() [2/2]

◆ GetProgramFlags()

◆ GetVertexBuffer() [1/2]

◆ GetVertexBuffer() [2/2]

◆ Initialise()

◆ IsInitialised()

◆ SetBillboardSize()

◆ SetBillboardType()

◆ SetCenterOffset()

◆ SetCount()

◆ SetDimensions()

◆ SetMaterial()

◆ SetNode()

◆ SortByDistance()

◆ Update()

Documentation des données membres

◆ m_billboardSize

◆ m_billboardType

◆ m_cameraPosition

◆ m_centerOffset

◆ m_count

◆ m_dimensions

◆ m_geometryBuffers

◆ m_initialised

◆ m_material

◆ m_needUpdate

◆ m_node

◆ m_quad

◆ m_scene

◆ m_vertexBuffer