interface ITerrainTransform in Tinman.AddOns.Components

Base interface for classes that represent a transformation between terrain-space and model-space.

interface	ITerrainTransform	extends	IMeshBound
			IVersioned
		base of	TerrainTransform

Attributes

HasMesh

Has this object been bound to an IMesh object?

property	HasMesh { get }
type	bool
value		true if this object is currently bound to an IMesh, false if not.
inherited	IMeshBound.HasMesh

Mesh

The CLOD mesh this object is currently bound to.

property	Mesh { get }
type	IMesh
value		The CLOD mesh or null.
inherited	IMeshBound.Mesh

ToModel

Returns the transformation matrix from terrain-space to model-space, (re-)computing it if necessary.

property	ToModel { get }
type	Mat4D
value		The transformation matrix.

ToTerrain

Returns the transformation matrix from model-space to terrain-space, (re-)computing it if necessary.

property	ToTerrain { get }
type	Mat4D
value		The transformation matrix.

Version

Returns the current version of object.

property	Version { get }
type	int32
value		The current version number.
inherited	IVersioned.Version

Remarks:

For each modification, the version is incremented by at least one.

Methods

Append

Appends the given transform to this one.

method	Append (ITerrainTransform other)
type	ITerrainTransform
params	other	[not-null]	The other terrain transform.
returns		[not-null]	The resulting terrain transform.

Remarks:

The concatenated transforms are applied as follows:

• V' = other.ToTerrain * this.ToTerrain * V
• V = this.ToModel * other.ToModel * V'

where V is a point in model-space and V' is a point in terrain-space.

MeshBind

Binds this object to the given IMesh.

method	MeshBind (IMesh mesh)
params	mesh		The mesh object.
inherited	IMeshBound.MeshBind

MeshUnbind

Unbinds this object from its current IMesh.

method	MeshUnbind ()
inherited	IMeshBound.MeshUnbind