Mesh Class Reference

Contains vertex array-based geometry. More...

#include <Mesh.hpp>

Inheritance diagram for Mesh:

Collaboration diagram for Mesh:

Public Member Functions
BRK_API	Mesh (MeshFormat format, uint32 verticesCount, const Ref< Data > &vertexData, const Ref< Data > &attributeData, const Ref< Data > &skinningData)
	Creates mesh from raw vertex data. More...
BRK_API	Mesh (MeshFormat format, uint32 verticesCount, const MeshArrays &meshArrays)
	Creates mesh from arrays of attributes. More...
BRK_API	~Mesh () override=default
BRK_API void	SetName (StringName name)
BRK_API void	SetAabb (const Aabbf &aabb)
BRK_API void	AddMaterial (Ref< Material > material)
BRK_API void	AddSubMesh (const StringName &name, RHIPrimitivesType primitivesType, const Aabbf &aabb, uint32 baseVertex, RHIIndexType indexType, uint32 indicesCount, const Ref< Data > &indexData)
	Add new indexed sub-mesh to the mesh. More...
BRK_API void	SetSubMeshMaterial (const StringName &name, uint32 index)
	Set sub-mesh material. More...
BRK_API Ref< const SubMesh >	FindSubMesh (const StringName &name) const
BRK_API const StringName &	GetName () const
BRK_API const MeshFormat &	GetFormat () const
BRK_API const Aabbf &	GetAabb () const
BRK_API const std::vector< Ref< Material > > &	GetMaterials () const
BRK_API const std::vector< Ref< SubMesh > > &	GetSubMeshes () const
BRK_API const std::unordered_map< StringName, uint32 > &	GetSubMeshLookUp () const
BRK_API uint32	GetVerticesCount () const
BRK_API const Ref< RHIVertexBuffer > &	GetVertexData () const
BRK_API const Ref< RHIVertexBuffer > &	GetAttributeData () const
BRK_API const Ref< RHIVertexBuffer > &	GetSkinningData () const
BRK_API const Ref< RHIVertexDeclaration > &	GetDeclaration () const
BRK_API bool	HasVertexData () const
BRK_API bool	HasAttributeData () const
BRK_API bool	HasSkinningData () const
Public Member Functions inherited from RefCnt
virtual	~RefCnt ()
bool	IsUnique () const
std::int32_t	GetRefs () const
std::int32_t	AddRef () const
std::int32_t	RelRef () const

Additional Inherited Members
Protected Member Functions inherited from RefCnt
virtual void	Destroy () const

Detailed Description

Contains vertex array-based geometry.

Mesh is a type of rendering resource that contains vertex array-based geometry, divided into a set of sub-meshes. Each sub-mesh has separate list of index data, can use separate material and primitives type for rendering.

See also

Material

MeshFormat

MeshFormats

MeshAttribute

Constructor & Destructor Documentation

Mesh() [1/2]

BRK_NS_BEGIN Mesh::Mesh	(	MeshFormat	format,
		uint32	verticesCount,
		const Ref< Data > &	vertexData,
		const Ref< Data > &	attributeData,
		const Ref< Data > &	skinningData
	)

Creates mesh from raw vertex data.

Parameters

format	Format of the vertex data
verticesCount	Number of vertices in the mesh
vertexData	Packed vertex data
attributeData	Packed attribute data
skinningData	Packed skinning data

Mesh() [2/2]

Mesh::Mesh	(	MeshFormat	format,
		uint32	verticesCount,
		const MeshArrays &	meshArrays
	)

Creates mesh from arrays of attributes.

Automatically packs data accordingly to mesh format.

Parameters

format	Format of the vertex data
verticesCount	Number of vertices in the mesh
meshArrays	Structure with pointers to attributes

~Mesh()

BRK_API Mesh::~Mesh ( )

overridedefault

Member Function Documentation

AddMaterial()

void Mesh::AddMaterial

(

Ref< Material >

material

)

Adds new material to the mesh

AddSubMesh()

void Mesh::AddSubMesh	(	const StringName &	name,
		RHIPrimitivesType	primitivesType,
		const Aabbf &	aabb,
		uint32	baseVertex,
		RHIIndexType	indexType,
		uint32	indicesCount,
		const Ref< Data > &	indexData
	)

Add new indexed sub-mesh to the mesh.

Parameters

name	Unique name of the sub-mesh
primitivesType	Type of sub-mesh primitives
aabb	Bounding box of sub-mesh
baseVertex	base vertex index
indexType	Type of indices
indicesCount	Number of indices
indexData	Index data

FindSubMesh()

Ref< const SubMesh > Mesh::FindSubMesh

(

const StringName &

name

)

const

Returns

Sub-mesh found by name; null if not found

GetAabb()

BRK_API const Aabbf& Mesh::GetAabb ( ) const

inline

Returns

Bounding box of mesh

GetAttributeData()

BRK_API const Ref<RHIVertexBuffer>& Mesh::GetAttributeData ( ) const

inline

color,uv's data of the mesh

GetDeclaration()

BRK_API const Ref<RHIVertexDeclaration>& Mesh::GetDeclaration ( ) const

inline

Vertex declaration for rendering with full data

GetFormat()

BRK_API const MeshFormat& Mesh::GetFormat ( ) const

inline

Returns

Format of the mesh

GetMaterials()

BRK_API const std::vector<Ref<Material> >& Mesh::GetMaterials ( ) const

inline

Returns

List of materials used by the mesh

GetName()

BRK_API const StringName& Mesh::GetName ( ) const

inline

Returns

Name of the mesh

GetSkinningData()

BRK_API const Ref<RHIVertexBuffer>& Mesh::GetSkinningData ( ) const

inline

bones, weights data of the mesh

GetSubMeshes()

BRK_API const std::vector<Ref<SubMesh> >& Mesh::GetSubMeshes ( ) const

inline

Returns

List of sub-meshes

GetSubMeshLookUp()

BRK_API const std::unordered_map<StringName, uint32>& Mesh::GetSubMeshLookUp ( ) const

inline

Returns

Name to id resoling

GetVertexData()

BRK_API const Ref<RHIVertexBuffer>& Mesh::GetVertexData ( ) const

inline

pos,norm,tan data of the mesh

GetVerticesCount()

BRK_API uint32 Mesh::GetVerticesCount ( ) const

inline

Number of vertices in the mesh

HasAttributeData()

BRK_API bool Mesh::HasAttributeData ( ) const

inline

HasSkinningData()

BRK_API bool Mesh::HasSkinningData ( ) const

inline

HasVertexData()

BRK_API bool Mesh::HasVertexData ( ) const

inline

SetAabb()

void Mesh::SetAabb

(

const Aabbf &

aabb

)

Set mesh bounding box

SetName()

void Mesh::SetName

(

StringName

name

)

Set name of the mesh

SetSubMeshMaterial()

void Mesh::SetSubMeshMaterial	(	const StringName &	name,
		uint32	index
	)

Set sub-mesh material.

Parameters

name	Name of the sub-mesh
index	Index of the material in the mesh materials list

---

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

• code/runtime/render/mesh/Mesh.hpp
• code/runtime/render/mesh/Mesh.cpp