class HeightmapProjector in Tinman.Terrain.Heightmaps

The HeightmapProjector class can be used to perform map projections between heightmaps.

sealed class

HeightmapProjector

extends

Disposable

Public / Attributes

Input

The input heightmap.

public property	Input { get }
type	IHeightmap
value	[not-null]	The input heightmap (rectangular).

LifecycleState

Returns the lifecycle state of this object.

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

Output

The output heightmap.

public property	Output { get }
type	IHeightmap
value	[not-null]	The output heightmap (cubemap).

Projection

The used map projection.

public property	Projection { get }
type	IMapProjection
value	[not-null]	The map projection that transforms from output to input.

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.

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.

Project

Computes all samples in the given region of the output heightmap by projecting them to the input heightmap.

[ThreadSafe]
public method	Project (CubemapFaceRect region)
params	region		The region to compute in the output heightmap.

---

Computes all samples in the given region of the output heightmap by projecting them to the input heightmap.

[ThreadSafe]
public method	Project (int32 x, int32 y, int32 width, int32 height, CubemapFace face = CubemapFace.NegZ)
params	x	[<=Output.Width-width]	X-coordinate of top-left sample of heightmap range, in cubemap face coordinates.
	y	[<=Output.Height-height]	Y-coordinate of top-left sample of heightmap range, in cubemap face coordinates.
	width	[>=0]	Width of heightmap range.
	height	[>=0]	Height of heightmap range.
	face		The cubemap face. Defaults to NegZ.