interface IVertexUpdater in Tinman.Terrain.Kernel

Base interface for classes that process vertex data updates.

interface	IVertexUpdater	extends	IBeginEnd
			IDisposable
			IVertexArraysDependent
		base of	VertexUpdater

Remarks

Vertex updates are performed inside of MeshUpdate. This is the sequence of method calls for vertex updates:

1. Validate (returns true)
2. Begin
3. VertexUpdateAll, to refresh all vertices after an invalid state.
4. VertexUpdate, to bulk update all modified vertices.
   
5. End

Attributes

LifecycleState

Returns the lifecycle state of this object.

property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	ILifecycleState.LifecycleState

Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
inherited	IDisposable.AcquireTry

Remarks:

The object will not be actually disposed by calls to Dispose when there is at least one strong reference left. Code that calls the AcquireTry method is responsible for calling the Dispose method accordingly.

This method is not intended to be used in performance-critical code. It should only be used to high-level resource management.

Begin

Begins an access to this object.

method	Begin ()
inherited	IBeginEnd.Begin

Remarks:

See the documentation of the class which implements this interface for details on the operations that must be wrapped in Begin and End calls.

See also:

BeginEnd

Dispose

Releases all resources held by this object if there are no more strong references to it, decrements the reference counter by one otherwise.

[Dispose, OwnerThis, ThreadSafe]
method	Dispose ()
inherited	IDisposable.Dispose

Remarks:

The Dispose method silently returns if the object has already been disposed.

End

Ends the current access to this object.

method	End ()
inherited	IBeginEnd.End

Remarks:

See the documentation of the class which implements this interface for details on the operations that must be wrapped in Begin and End calls.

See also:

BeginEnd

SetVertexArrays

Sets the vertex data containers from which this vertex converter shall read vertex data.

method	SetVertexArrays (VertexArrays vertexArrays)
params	vertexArrays	[not-null]	The vertex data collection.
inherited	IVertexArraysDependent.SetVertexArrays

Validate

Validates this vertex updater.

method	Validate ()
type	bool
returns			true if the vertex updater is valid and can consume vertex data updates, false if it is invalid (vertex updates must be discarded).

Remarks:

When a vertex updater becomes invalid, a full vertex update will become necessary once the update is valid again.

VertexUpdate

Updates data for the given vertices.

[BeginEnd]
method	VertexUpdate (int32[] vertices, int32 count)
params	vertices	[not-null]	An array that holds the vertex indices.
	count	[>0]	Total number of indices to read from vertices.

Remarks:

A typical implementation will read vertex data from the VertexArrays object, construct some application-specific vertex value and store that value in some kind of vertex buffer (e.g. for rendering).

VertexUpdateAll

Updates data for all vertices.

[BeginEnd]
method	VertexUpdateAll ()

Remarks:

A typical implementation will read vertex data from the VertexArrays object, construct some application-specific vertex value and store that value in some kind of vertex buffer (e.g. for rendering).