class VertexArrays in Tinman.Terrain.Vertices

A collection of CPU vertex arrays.

sealed class	VertexArrays	extends	CapacityBase
		implements	IMemoryConsumption
			IVertexCopy

Public / Attributes

Capacity

Returns the capacity of this object.

public property	Capacity { get }
type	int32
value	[>=0]	The capacity, in elements.
inherited	CapacityBase.Capacity

MemoryConsumption

Returns the estimated memory consumption of this object.

public property	MemoryConsumption { get }
type	int64
value	[>=0]	The estimated memory consumption, in bytes.
implements	IMemoryConsumption.MemoryConsumption

Public / Constructors

VertexArrays

Creates a new instance of VertexArrays.

public constructor	VertexArrays (int32 capacity)
params	capacity	[>0]	The capacity of each vertex data container in this collection, in vertices.

Public / Methods

CopyVertexData

Copies vertex data from one vertex to another.

public method	CopyVertexData (int32 from, int32 to)
params	from		The vertex to copy from.
	to		The vertex to copy to.
implements	IVertexCopy.CopyVertexData

CreateVertexArray

Creates a new vertex data container for the given semantic, if necessary.

public method	CreateVertexArray (Semantic semantic)
type	IVertexArray
params	semantic	[not-null]	The semantic.
returns		[not-null]	The vertex data container.

GetVertexArray

Returns the vertex data container for the given semantic.

public method	GetVertexArray (Semantic semantic, bool required)
type	IVertexArray
params	semantic	[not-null]	The semantic.
	required		true if the vertex data container is required (i.e. the return value must not be null). false if the vertex data container is optional.
returns			The vertex data container or null if no container exists for the given semantic and required is false.

Exceptions:

• TinmanException:
  If no container exists for the given semantic and required is true.

GetVertexArrayFloat32

Returns the vertex data array for the given semantic.

public method	GetVertexArrayFloat32 (Semantic semantic, bool required)
type	float32[]
params	semantic	[not-null]	The semantic.
	required		true if the vertex data container is required (i.e. the return value must not be null). false if the vertex data container is optional.
returns			The vertex data container or null if no container exists for the given semantic and required is false.

Exceptions:

• TinmanException:
  If no container exists for the given semantic and required is true.

GetVertexArrayFloat64

Returns the vertex data array for the given semantic.

public method	GetVertexArrayFloat64 (Semantic semantic, bool required)
type	float64[]
params	semantic	[not-null]	The semantic.
	required		true if the vertex data container is required (i.e. the return value must not be null). false if the vertex data container is optional.
returns			The vertex data container or null if no container exists for the given semantic and required is false.

Exceptions:

• TinmanException:
  If no container exists for the given semantic and required is true.

GetVertexArrayInt32

Returns the vertex data array for the given semantic.

public method	GetVertexArrayInt32 (Semantic semantic, bool required)
type	int32[]
params	semantic	[not-null]	The semantic.
	required		true if the vertex data container is required (i.e. the return value must not be null). false if the vertex data container is optional.
returns			The vertex data container or null if no container exists for the given semantic and required is false.

Exceptions:

• TinmanException:
  If no container exists for the given semantic and required is true.

GetVertexArrayInt64

Returns the vertex data array for the given semantic.

public method	GetVertexArrayInt64 (Semantic semantic, bool required)
type	int64[]
params	semantic	[not-null]	The semantic.
	required		true if the vertex data container is required (i.e. the return value must not be null). false if the vertex data container is optional.
returns			The vertex data container or null if no container exists for the given semantic and required is false.

Exceptions:

• TinmanException:
  If no container exists for the given semantic and required is true.

HasVertexArray

Does a vertex data array exist for the given semantic?

public method	HasVertexArray (Semantic semantic)
type	bool
params	semantic	[not-null]	The semantic.
returns			true if the vertex array exists, false if not.

SetVertexArray

Sets the vertex data container for the given semantic.

public method	SetVertexArray (Semantic semantic, IVertexArray vertexData)
params	semantic	[not-null]	The semantic.
	vertexData		The vertex data container or null.