MeshResource Messages

Defines the set of messages used to construct mesh objects. More...

Classes
struct	tes::MeshCreateMessage
	MeshResource creation message. More...
struct	tes::MeshRedefineMessage
	MeshResource redefinition message. More...
struct	tes::MeshDestroyMessage
	MeshResource destruction message. More...
struct	tes::MeshComponentMessage
	Message structure for adding vertices, colours, indices, or UVs. More...
struct	tes::Material
	Not ready for use. More...
struct	tes::MeshFinaliseMessage
	Message to finalise a mesh, ready for use. More...

Enumerations
enum	tes::MeshBuildFlags { tes::MbfCalculateNormals = (1<<0) }
	The set of valid flags used in finalise messages. More...
enum	tes::MeshMessageType {   MmtInvalid, MmtDestroy, MmtCreate, tes::MmtVertex,   tes::MmtIndex, tes::MmtVertexColour, tes::MmtNormal, tes::MmtUv,   tes::MmtSetMaterial, tes::MmtRedefine, tes::MmtFinalise }
	Defines the messageIDs for mesh message routing. More...
enum	tes::DrawType { DtPoints, DtLines, DtTriangles, tes::DtVoxels }
	Defines the primitives for a mesh. More...

Detailed Description

Defines the set of messages used to construct mesh objects.

A mesh object is defined via a series of messages. This allows meshes to be defined over a number of updates, limiting per frame communications.

MeshResource instantiation supports the following messages:

• Create : instantiates a new, empty mesh object and the draw type.
• Destroy : destroys an existing mesh object.
• Vertex : adds vertices to a mesh object.
• Vertex colour : adds vertex colours.
• Index : Defines the vertex indices. Usage depends on draw type.
• Normal : adds normals.
• UV : Adds UV coordinates.
• Set material : Sets the material for the mesh object.
• Finalise : Finalises the mesh object.

Within a PacketHeader, the mesh message is arranged as follows:

• PacketHeader header
• uint16 Message type = MtMesh
• uint16 MeshMessageType

A valid mesh definition requires at least the following messages: Create, Vertex, Index, Finalise. Additional vertex streams, normals, etc can be added with the complete set of messages.

Each mesh definition specifies one of the following draw modes or primitive types:

• DtPoints
• DtLines
• DtLineLoop
• DtLineStrip
• DtTriangles
• DtTriangleStrip
• DtTriangleFan

A mesh object defined through the MeshHandler doe snot support any child or sub-objects. These sorts of relationships are defined in the mesh renderer.

Message Formats

Message	Data Type	Semantics
Create	uint32	Unique mesh ID
	uint32	Vertex count
	uint32	Index count
	uint8	Draw type
	uint32	MeshResource tint
	float32[3]	Position part of the mesh transform
	float32[4]	Quaternion rotation for mesh transform
	float32[3]	Scale factor part of mesh transform
Destroy	uint32	MeshResource ID
Finalise	uint32	MeshResource ID
Component	uint32	MeshResource ID
	uint32	Offset of the first data item
	uint32	Reserved (e.g., stream index support)
	uint16	Count
	element*	Array of count elements. Type varies.
Material	uint32	MeshResource ID
	uint32	Material ID

The Component message above refers to of the data content messages. The offset specicifies the first index of the incomping data, which allows the data streams to be sent in blocks. The element type matches the component type as follows:

Component Message	Element type
Vertex	32-bit float triples
Vertex colour	32-bit uint
Index	32-bit uint
Normal	32-bit float triples
UV	32-bit float pairs

By default, one of the following materials are chosen:

• Lit with vertex colour if normals are specified or calculated.
• Unlit with vertex colour otherwise. Vertex colours are initialised to white.

Enumeration Type Documentation

DrawType

enum tes::DrawType

Defines the primitives for a mesh.

Enumerator
DtVoxels	Geometry shader based voxels. Vertices define the voxel centres, the normals define half extents.

MeshBuildFlags

enum tes::MeshBuildFlags

The set of valid flags used in finalise messages.

Enumerator
MbfCalculateNormals	Calculate normals. Overwrites normals if present.

MeshMessageType

enum tes::MeshMessageType

Defines the messageIDs for mesh message routing.

Enumerator
MmtVertex	Add vertices.
MmtIndex	Add indices.
MmtVertexColour	Add vertex colours.
MmtNormal	Add normals.
MmtUv	Add UV coordinates.
MmtSetMaterial	Define the material for this mesh. Extension. NYI.
MmtRedefine	Redefine the core aspects of the mesh. This invalidates the mesh requiring re-finalisation, but allows the creation parameters to be redefined. Component messages (vertex, index, colour, etc) can also be changed after this message, but before a second MmtFinalise.
MmtFinalise	Finalise and build the mesh.