Quantum.MeshUnmanagedTrianglesRef Struct Reference

A lightweight reference to a mesh in unmanaged memory. More...

Public Member Functions
	MeshUnmanagedTrianglesRef ()
	Creates an empty MeshUnmanagedTrianglesRef. More...
	MeshUnmanagedTrianglesRef (UnmanagedTriangleArray triangles, Int32 first, Int32 capacity, Int32 usedCount, bool isEditing=false)
	Creates a new instance of MeshUnmanagedTrianglesRef. More...
	MeshUnmanagedTrianglesRef (UnmanagedTriangleArray triangles, Int32 first, Int32 usedCount)
	Obsolete. Use overload that takes 'capacity' parameter instead. See MeshUnmanagedTrianglesRef. More...
TriangleCCW *	GetFreeTriangles (out int freeCount)
	Gets a buffer of unused triangles on this mesh collider. More...
TriangleCCW *	GetTriangles (out Int32 usedCount)
	Gets a pointer to the first triangle of the mesh and the number of used triangles. Mesh triangles are allocated in a contiguous buffer starting from the first triangle. More...
TriangleCCW *	GetTriangles (out Int32 usedCount, out Int32 capacity)
	Gets a pointer to the first triangle of the mesh, the number of used triangles and the capacity of the buffer. More...
bool	TryGetFreeTriangles (out TriangleCCW *freeTriangles, out int freeCount)
	Gets a buffer of unused triangles on this mesh collider. More...
bool	TryGetTriangles (out TriangleCCW *triangles, out Int32 usedCount)
bool	TryGetTriangles (out TriangleCCW *triangles, out Int32 usedCount, out Int32 capacity)
	Tries to get a buffer of the triangles on this mesh collider. More...

Static Public Member Functions
static MeshTriangleVerticesCcw	ToManagedTriangles (MeshUnmanagedTrianglesRef unmanagedRef)
	Converts a MeshUnmanagedTrianglesRef to a MeshTriangleVerticesCcw. This is useful when needing to convert from runtime triangle data to an editor/managed format. More...

Public Attributes
readonly Int32	Capacity
	The capacity of the buffer. More...
Int32	Count => UsedCount
	Obsolete. Use UsedCount instead. More...
readonly Int32	First
	The index of the first triangle of this mesh in the buffer. More...
readonly bool	IsEditing
	If the Mesh collider is currently being edited. More...
readonly UnmanagedTriangleArray	Triangles
	The unmanaged buffer containing all triangles. More...
readonly Int32	UsedCount
	The amount of triangles used. More...

Detailed Description

A lightweight reference to a mesh in unmanaged memory.

Constructor & Destructor Documentation

MeshUnmanagedTrianglesRef() [1/3]

Quantum.MeshUnmanagedTrianglesRef.MeshUnmanagedTrianglesRef ( UnmanagedTriangleArray  triangles, Int32  first, Int32  usedCount  )

inline

Obsolete. Use overload that takes 'capacity' parameter instead. See MeshUnmanagedTrianglesRef.

MeshUnmanagedTrianglesRef() [2/3]

Quantum.MeshUnmanagedTrianglesRef.MeshUnmanagedTrianglesRef ( UnmanagedTriangleArray  triangles, Int32  first, Int32  capacity, Int32  usedCount, bool  isEditing = false  )

inline

Creates a new instance of MeshUnmanagedTrianglesRef.

Parameters

triangles	The unmanaged buffer containing all triangles.
first	The index of the first triangle of this mesh in the buffer.
capacity	The capacity of the buffer.
usedCount	The amount of triangles used.
isEditing	If the mesh is being edited and therefore cannot be injected in the physics engine.

MeshUnmanagedTrianglesRef() [3/3]

Quantum.MeshUnmanagedTrianglesRef.MeshUnmanagedTrianglesRef ( )

inline

Creates an empty MeshUnmanagedTrianglesRef.

Member Function Documentation

GetTriangles() [1/2]

TriangleCCW* Quantum.MeshUnmanagedTrianglesRef.GetTriangles ( out Int32  usedCount )

inline

Gets a pointer to the first triangle of the mesh and the number of used triangles. Mesh triangles are allocated in a contiguous buffer starting from the first triangle.

Parameters

usedCount

the number of used triangles in the mesh.

Returns

A pointer to first triangle in the mesh.

GetTriangles() [2/2]

TriangleCCW* Quantum.MeshUnmanagedTrianglesRef.GetTriangles ( out Int32  usedCount, out Int32  capacity  )

inline

Gets a pointer to the first triangle of the mesh, the number of used triangles and the capacity of the buffer.

Parameters

usedCount	The number of used triangles in the mesh.
capacity	The capacity of the buffer allocated for the mesh.

Returns

A pointer to first triangle in the mesh.

TryGetTriangles()

bool Quantum.MeshUnmanagedTrianglesRef.TryGetTriangles ( out TriangleCCW *  triangles, out Int32  usedCount, out Int32  capacity  )

inline

Tries to get a buffer of the triangles on this mesh collider.

Parameters

triangles	A pointer to the first triangles in this mesh collider, if any. null otherwise.
usedCount	How many triangles are used.
capacity	The capacity of the buffer allocated for this mesh.

Returns

true if this mesh collider has triangles. false otherwise.

GetFreeTriangles()

TriangleCCW* Quantum.MeshUnmanagedTrianglesRef.GetFreeTriangles ( out int  freeCount )

inline

Gets a buffer of unused triangles on this mesh collider.

Parameters

freeCount

How many triangles are free.

Returns

A pointer to the first free triangles in this mesh collider, if any. null otherwise.

TryGetFreeTriangles()

bool Quantum.MeshUnmanagedTrianglesRef.TryGetFreeTriangles ( out TriangleCCW *  freeTriangles, out int  freeCount  )

inline

Gets a buffer of unused triangles on this mesh collider.

Parameters

freeTriangles	A pointer to the first free triangles in this mesh collider, if any. null otherwise.
freeCount	How many triangles are free.

Returns

true if this mesh collider has free triangles. false otherwise.

ToManagedTriangles()

static MeshTriangleVerticesCcw Quantum.MeshUnmanagedTrianglesRef.ToManagedTriangles ( MeshUnmanagedTrianglesRef  unmanagedRef )

inlinestatic

Converts a MeshUnmanagedTrianglesRef to a MeshTriangleVerticesCcw. This is useful when needing to convert from runtime triangle data to an editor/managed format.

Parameters

unmanagedRef

The unmanaged triangles reference to convert

Returns

A new MeshTriangleVerticesCcw containing the converted data

Member Data Documentation

Triangles

readonly UnmanagedTriangleArray Quantum.MeshUnmanagedTrianglesRef.Triangles

The unmanaged buffer containing all triangles.

First

readonly Int32 Quantum.MeshUnmanagedTrianglesRef.First

The index of the first triangle of this mesh in the buffer.

UsedCount

readonly Int32 Quantum.MeshUnmanagedTrianglesRef.UsedCount

The amount of triangles used.

Capacity

readonly Int32 Quantum.MeshUnmanagedTrianglesRef.Capacity

The capacity of the buffer.

IsEditing

readonly bool Quantum.MeshUnmanagedTrianglesRef.IsEditing

If the Mesh collider is currently being edited.

Mesh colliders cannot be enabled while being edited.

Count

Int32 Quantum.MeshUnmanagedTrianglesRef.Count => UsedCount

Obsolete. Use UsedCount instead.