Inheritance diagram for vcl::DrawableMeshBGFX< MeshType >:

[legend]

Public Types
enum class	SurfaceProgramsType { UBER , SPLIT , UBER_WITH_STATIC_IF }

Public Member Functions
Box3d	boundingBox () const override
	This member function is used to find a good camera position to render object. It should return the the bounding box of the object. Return a null bounding box if the object shouldn't influence the position of the camera.

std::shared_ptr< DrawableObject >	clone () &&override
	This member function is used to create a new DrawableObject that is a moved from the current one. This object will be destroyed after the call of this function. Each derived class must implement this member function, that returns a shared pointer pointing to the moved object. For more details about this paradigm, check polimorphism clone in modern c++: https://www.fluentcpp.com/2017/09/08/make-polymorphic-copy-modern-cpp/.

std::shared_ptr< DrawableObject >	clone () const &override
	This member function is used to create a new copy of the DrawableObject. Each derived class must implement this member function, that returns a shared pointer pointing to a copy of the current one. for more details about this paradigm, check polimorphism clone in modern c++: https://www.fluentcpp.com/2017/09/08/make-polymorphic-copy-modern-cpp/.

void	draw (uint viewId) const override
	This member function must draw the object. It will be called at every frame.

	DrawableMeshBGFX (const DrawableMeshBGFX &drawableMesh)

	DrawableMeshBGFX (const MeshType &mesh)

	DrawableMeshBGFX (DrawableMeshBGFX &&drawableMesh)

	DrawableMeshBGFX (MeshType &&mesh)

void	drawId (uint viewId, uint id) const override
	This member function should draw the object. It will be called on request when the renderer needs to draw the ID of the object.

uint	edgeNumber () const override

uint	faceNumber () const override

void	init () override
	This member function is called after the initialization of the Context. It must initialize and bind data to the GPU like buffers and textures.

const std::string &	name () const override
	Returns the name of the object.

std::string &	name () override
	Returns a reference of the name of the object, that allows to modify it.

DrawableMeshBGFX &	operator= (DrawableMeshBGFX drawableMesh)

void	setRenderSettings (const MeshRenderSettings &rs) override

void	setSurfaceProgramType (SurfaceProgramsType type)

void	setVisibility (bool vis) override
	This member function is used to set the visibility of the object.

void	swap (DrawableMeshBGFX &other)

std::vector< std::string >	textures () const override

vcl::Matrix44d	transformMatrix () const override

void	updateBuffers (MRI::BuffersBitSet buffersToUpdate=MRI::BUFFERS_ALL) override

uint	vertexNumber () const override

Public Member Functions inherited from vcl::AbstractDrawableMesh
	AbstractDrawableMesh (const AbstractDrawableMesh &other)=default

template<MeshConcept MeshType>
	AbstractDrawableMesh (const MeshType &m)

bool	isVisible () const
	This member function is used to check if the object is visible.

const MeshRenderSettings &	renderSettings () const

Public Member Functions inherited from vcl::DrawableObject
	DrawableObject ()=default
	Empty constructor.

std::string &	info ()
	Returns a reference of the info of the object, that allows to modify it.

const std::string &	info () const
	Returns the info of the object.

Protected Member Functions
void	bindUniforms () const

bgfx::ProgramHandle	surfaceProgramSelector () const

Protected Member Functions inherited from vcl::AbstractDrawableMesh
void	swap (AbstractDrawableMesh &other)

Protected Member Functions inherited from vcl::DrawableObject
void	swap (DrawableObject &other)
	Utility swap function that allows to swap the content of two DrawableObject instances.

Protected Attributes
MeshRenderBuffers< MeshType >	mMRB

Protected Attributes inherited from vcl::AbstractDrawableMesh
MeshRenderSettings	mMRS

Private Types
using	MRI = MeshRenderInfo

Private Attributes
Box3d	mBoundingBox

Uniform	mIdUniform = Uniform("u_meshId", bgfx::UniformType::Vec4)

MeshRenderSettingsUniforms	mMeshRenderSettingsUniforms

SurfaceProgramsType	mSurfaceProgramType = SurfaceProgramsType::UBER

Friends
void	swap (DrawableMeshBGFX &a, DrawableMeshBGFX &b)

Member Function Documentation

◆ boundingBox()

template<MeshConcept MeshType>

Box3d vcl::DrawableMeshBGFX< MeshType >::boundingBox ( ) const

inlineoverridevirtual

This member function is used to find a good camera position to render object. It should return the the bounding box of the object. Return a null bounding box if the object shouldn't influence the position of the camera.

Returns: The bounding box of the object.

Implements vcl::DrawableObject.

◆ clone() [1/2]

template<MeshConcept MeshType>

std::shared_ptr< DrawableObject > vcl::DrawableMeshBGFX< MeshType >::clone ( ) &&

inlineoverridevirtual

This member function is used to create a new DrawableObject that is a moved from the current one. This object will be destroyed after the call of this function. Each derived class must implement this member function, that returns a shared pointer pointing to the moved object. For more details about this paradigm, check polimorphism clone in modern c++: https://www.fluentcpp.com/2017/09/08/make-polymorphic-copy-modern-cpp/.

Generally, if your class that inherits from DrawableObject is called MyObject, the clone member function should be implemented as follows:

std::shared_ptr<DrawableObject> MyObject::clone() &&
{
   return std::make_shared<MyObject>(std::move(*this));
}

Returns: A shared pointers that points to a new DrawableObject that is a moved from the current one.

Implements vcl::DrawableObject.

◆ clone() [2/2]

template<MeshConcept MeshType>

std::shared_ptr< DrawableObject > vcl::DrawableMeshBGFX< MeshType >::clone ( ) const &

inlineoverridevirtual

This member function is used to create a new copy of the DrawableObject. Each derived class must implement this member function, that returns a shared pointer pointing to a copy of the current one. for more details about this paradigm, check polimorphism clone in modern c++: https://www.fluentcpp.com/2017/09/08/make-polymorphic-copy-modern-cpp/.

Generally, if your class that inherits from DrawableObject is called MyObject, the clone member function should be implemented as follows:

std::shared_ptr<DrawableObject> MyObject::clone() const&
{
   return std::make_shared<MyObject>(*this);
}

Returns: A shared pointers that points to a new DrawableObject that is a copy of the current one.

Implements vcl::DrawableObject.

◆ draw()

template<MeshConcept MeshType>

void vcl::DrawableMeshBGFX< MeshType >::draw ( uint viewId ) const

inlineoverridevirtual

This member function must draw the object. It will be called at every frame.

Parameters

viewId The ID of the view to draw. It may be used depending on the rendering engine.

Implements vcl::DrawableObject.

◆ drawId()

template<MeshConcept MeshType>

void vcl::DrawableMeshBGFX< MeshType >::drawId	(	uint	viewId,
		uint	id
	)		const

inlineoverridevirtual

This member function should draw the object. It will be called on request when the renderer needs to draw the ID of the object.

Parameters

viewId	The ID of the view to draw. It may be used depending on the rendering engine.
id	The ID of the object.

Reimplemented from vcl::DrawableObject.

◆ edgeNumber()

template<MeshConcept MeshType>

uint vcl::DrawableMeshBGFX< MeshType >::edgeNumber ( ) const

inlineoverridevirtual

Implements vcl::AbstractDrawableMesh.

◆ faceNumber()

template<MeshConcept MeshType>

uint vcl::DrawableMeshBGFX< MeshType >::faceNumber ( ) const

inlineoverridevirtual

Implements vcl::AbstractDrawableMesh.

◆ init()

template<MeshConcept MeshType>

void vcl::DrawableMeshBGFX< MeshType >::init ( )

inlineoverridevirtual

This member function is called after the initialization of the Context. It must initialize and bind data to the GPU like buffers and textures.

Reimplemented from vcl::DrawableObject.

◆ name() [1/2]

template<MeshConcept MeshType>

const std::string & vcl::DrawableMeshBGFX< MeshType >::name ( ) const

inlineoverridevirtual

Returns the name of the object.

Returns: The name of the object.

Reimplemented from vcl::DrawableObject.

◆ name() [2/2]

template<MeshConcept MeshType>

std::string & vcl::DrawableMeshBGFX< MeshType >::name ( )

inlineoverridevirtual

Returns a reference of the name of the object, that allows to modify it.

Parameters

[in] name The name of the object.

Reimplemented from vcl::DrawableObject.

◆ setRenderSettings()

template<MeshConcept MeshType>

void vcl::DrawableMeshBGFX< MeshType >::setRenderSettings ( const MeshRenderSettings & rs )

inlineoverridevirtual

Reimplemented from vcl::AbstractDrawableMesh.

◆ setVisibility()

template<MeshConcept MeshType>

void vcl::DrawableMeshBGFX< MeshType >::setVisibility ( bool vis )

inlineoverridevirtual

This member function is used to set the visibility of the object.

Parameters

[in] vis true if the object should be visible;

Reimplemented from vcl::AbstractDrawableMesh.

◆ textures()

template<MeshConcept MeshType>

std::vector< std::string > vcl::DrawableMeshBGFX< MeshType >::textures ( ) const

inlineoverridevirtual

Reimplemented from vcl::AbstractDrawableMesh.

◆ transformMatrix()

template<MeshConcept MeshType>

vcl::Matrix44d vcl::DrawableMeshBGFX< MeshType >::transformMatrix ( ) const

inlineoverridevirtual

Implements vcl::AbstractDrawableMesh.

◆ updateBuffers()

template<MeshConcept MeshType>

void vcl::DrawableMeshBGFX< MeshType >::updateBuffers ( MRI::BuffersBitSet buffersToUpdate = MRI::BUFFERS_ALL )

inlineoverridevirtual

Implements vcl::AbstractDrawableMesh.

◆ vertexNumber()

template<MeshConcept MeshType>

uint vcl::DrawableMeshBGFX< MeshType >::vertexNumber ( ) const

inlineoverridevirtual

Implements vcl::AbstractDrawableMesh.

The documentation for this class was generated from the following file:

vclib/render/include/vclib/bgfx/drawable/drawable_mesh.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Attributes

Friends

Member Function Documentation

◆ boundingBox()

◆ clone() [1/2]

◆ clone() [2/2]

◆ draw()

◆ drawId()

◆ edgeNumber()

◆ faceNumber()

◆ init()

◆ name() [1/2]

◆ name() [2/2]

◆ setRenderSettings()

◆ setVisibility()

◆ textures()

◆ transformMatrix()

◆ updateBuffers()

◆ vertexNumber()