TINMAN 3D / REALTIME TERRAIN
Software Development Kit - User Manual

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 [0..Capacity-1] The vertex to copy from.
  to [0..Capacity-1] The vertex to copy to.
implements IVertexCopy.CopyVertexData

Copies vertex data from this store (source) to the given target store.

public method CopyVertexData (int32 sourceIndex, IVertexCopy target, int32 targetIndex, int32 count)
params sourceIndex [0..Capacity-count] Index of first vertex to read from the source vertex store.
  target [not-null] The vertex array to copy to.
  targetIndex [0..target.Capacity-count] Index of first vertex to write into the target vertex store.
  count [>=0] The number of vertices to copy.
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)
type IVertexArray
params semantic [not-null] The semantic.
returns [not-null] The vertex data container.

Exceptions:

GetVertexArray_Float32

Returns the vertex data array for the given semantic.

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

Exceptions:

GetVertexArray_Float64

Returns the vertex data array for the given semantic.

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

Exceptions:

GetVertexArray_Int32

Returns the vertex data array for the given semantic.

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

Exceptions:

GetVertexArray_Int64

Returns the vertex data array for the given semantic.

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

Exceptions:

GetVertexArrayNull

Returns the vertex data container for the given semantic.

public method GetVertexArrayNull (Semantic semantic)
type IVertexArray
params semantic [not-null] The semantic.
returns The vertex data container or null if no container exists for the given semantic.

GetVertexArrayNull_Float32

Returns the vertex data array for the given semantic.

public method GetVertexArrayNull_Float32 (Semantic semantic)
type float32[]
params semantic [not-null] The semantic.
returns The vertex data container or null if no compatible container exists for the given semantic.

GetVertexArrayNull_Float64

Returns the vertex data array for the given semantic.

public method GetVertexArrayNull_Float64 (Semantic semantic)
type float64[]
params semantic [not-null] The semantic.
returns The vertex data container or null if no compatible container exists for the given semantic.

GetVertexArrayNull_Int32

Returns the vertex data array for the given semantic.

public method GetVertexArrayNull_Int32 (Semantic semantic)
type int32[]
params semantic [not-null] The semantic.
returns The vertex data container or null if no compatible container exists for the given semantic.

GetVertexArrayNull_Int64

Returns the vertex data array for the given semantic.

public method GetVertexArrayNull_Int64 (Semantic semantic)
type int64[]
params semantic [not-null] The semantic.
returns The vertex data container or null if no compatible container exists for the given semantic.

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.