class VertexUpdater in Tinman.Terrain.Kernel

Abstract base class for IVertexUpdater implementations.

abstract class	VertexUpdater	extends	Disposable
		implements	IVertexUpdater
		base of	VertexBufferUpdater
			VertexUpdaterList

Remarks

The default implementation of VertexUpdateAll simply delegates to VertexUpdate; subclasses can provide a more efficient implementation for this.

Public / Attributes

LifecycleState

Returns the lifecycle state of this object.

public virtual property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	Disposable.LifecycleState

Public / Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
public method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
inherited	Disposable.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.

public abstract method	Begin ()
implements	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]
public method	Dispose ()
inherited	Disposable.Dispose

Remarks:

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

End

Ends the current access to this object.

public abstract method	End ()
implements	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.

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

Validate

Validates this vertex updater.

public virtual 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).
implements	IVertexUpdater.Validate

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]
public abstract 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.
implements	IVertexUpdater.VertexUpdate

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]
public virtual method	VertexUpdateAll ()
implements	IVertexUpdater.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).

Protected / Attributes

vertexArrays

The vertex arrays.

protected field	vertexArrays
type	VertexArrays

Protected / Methods

DisposeManaged

Disposes the managed resources held by a concrete subclass. This method will be called at most once per subclass.

protected override method	DisposeManaged ()
overrides	Disposable.DisposeManaged

Remarks:

This method will only be called when a disposable object is explicitly destroyed by user code calling the Dispose method. It will not be called when the object is collected as garbage by the system.

Overriding methods must call the DisposeManaged method of their base class. The base call should be the last statement.

The DisposeManaged method is called before the DisposeUnmanaged method.

DisposeUnmanaged

Disposes the unmanaged resources held by a concrete subclass. This method will be called exactly once per subclass.

protected virtual method	DisposeUnmanaged ()
inherited	Disposable.DisposeUnmanaged

Remarks:

Overriding methods must call the DisposeUnmanaged method of their base class. The base call should be the last statement.

The DisposeUnmanaged method is called after the DisposeManaged method.