class TerrainTransformLocal in Tinman.AddOns.Components

The TerrainTransformLocal class transform from terrain-space to a local coordinate system.

sealed class

TerrainTransformLocal

extends

TerrainTransform

Remarks

The axes of the local coordinate system are defined as follows:

• X+
  Aligned with terrain east-vector at the given coordinates.
  For RightHanded: east = cross(north, up),
  For LeftHanded: east = cross(up, north).
• Y+
  Aligned with terrain up-vector at the given coordinates.
• Z+
  Perpendicular to east-vector and up-vector, so that dot(Z+, north) > 0.

See also:

IGeometry.ComputeNorth

Public / Attributes

Elevation

Terrain-space elevation of the origin of the local coordinate system.

public property	Elevation { get set }
type	float64
value		Terrain-space elevation of coordinate system origin.

Remarks:

Defaults to 0.

HasMesh

Has this object been bound to an IMesh object?

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

Heightmap

Heightmap coordinates of the origin of the local coordinate system.

public property	Heightmap { get set }
type	Vec3D
value		Heightmap coordinates of coordinate system origin (relative to MaxSize).

Remarks:

Defaults to Zero.

Mesh

The CLOD mesh this object is currently bound to.

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

Scale

Scale factor from model units to terrain units.

public property	Scale { get set }
type	float64
value		The scale factor.

Remarks:

Defaults to 1.

ToModel

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

public override property	ToModel { get }
type	Mat4D
value		The transformation matrix.
implements	TerrainTransform.ToModel

ToTerrain

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

public override property	ToTerrain { get }
type	Mat4D
value		The transformation matrix.
implements	TerrainTransform.ToTerrain

Version

Returns the current version of object.

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

Remarks:

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

Public / Constructors

TerrainTransformLocal

Creates a new instance of TerrainTransformLocal.

public constructor

TerrainTransformLocal ()

Public / Methods

Append

Appends the given transform to this one.

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

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.

public override method	MeshBind (IMesh mesh)
params	mesh		The mesh object.
overrides	TerrainTransform.MeshBind

MeshUnbind

Unbinds this object from its current IMesh.

public virtual method	MeshUnbind ()
inherited	TerrainTransform.MeshUnbind