TINMAN 3D / REALTIME TERRAIN
Software Development Kit - User Manual

class CanvasFactoryPixelPyramid in Tinman.Terrain.Tools

An ICanvasFactory for visualizing IPixelPyramid objects.

sealed class CanvasFactoryPixelPyramid extends CanvasFactory

Configuration

ToConfig

Returns the configuration value that describes this object.

public override method ToConfig ()
type ConfigValue
returns [not-null] The configuration value.
implements CanvasFactory.ToConfig

Remarks:

All configurable objects need to implement this interface. For simple types, it is preferable to delegate to ToValue.

The returned value may be of type Invalid, which means that this object in its current state cannot be described with the configuration API.

Before returning the resulting configuration value, Cache must be called on it, passing this IConfigurable object as parameter.

Public / Attributes

BlockSize

Size of a canvas block.

public property BlockSize { get set }
type int32
value [>0] The block size, in canvas raster samples.
inherited CanvasFactory.BlockSize

Remarks:

For PixelIsPoint semantics, the block size is a power of two plus one. For PixelIsArea semantics, the block size is a power of two.

See also:

Canvas.BlockCoverage

ColorError

Background color to use for pyramid tiles resulting from Error.

public property ColorError { get set }
type int64
value The background color to use.

Remarks:

Set to 0 to produce the same tile data as for Empty.

Defaults to Red.

ColorVoid

Background color to use for pyramid tiles resulting from Void.

public property ColorVoid { get set }
type int64
value The background color to use.

Remarks:

Set to 0 to produce the same tile data as for Empty.

Defaults to Magenta.

Georef

Returns georeferencing information.

public override property Georef { get }
type Raster
value The georeferencing object or null if no georeferencing is available.
implements CanvasFactory.Georef

LifecycleState

Returns the lifecycle state of this object.

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

Map

Returns a MapInfo value that describes the used map raster.

public override property Map { get }
type MapInfo
value The map info value.
implements CanvasFactory.Map

PixelPyramid

The pixel pyramid to use.

public property PixelPyramid { get }
type IPixelPyramid
value [not-null] The pixel pyramid instance.

SampleLayers

Returns the layers that are defined in the samples returned by GetSample.

public virtual property SampleLayers { get }
type HeightmapLayer
value The sample layers.
inherited CanvasFactory.SampleLayers

SampleRange

Returns the vertical range for the samples returned by GetSample.

public virtual property SampleRange { get }
type VerticalRange
value The sample range, in Metre.
inherited CanvasFactory.SampleRange

Public / Constructors

CanvasFactoryPixelPyramid

Creates a new instance of CanvasFactoryPixelPyramid.

public constructor CanvasFactoryPixelPyramid ([Owner] IPixelPyramid pixelPyramid)
params pixelPyramid [not-null] The pixel pyramid to use.

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.

CreateCanvas

Creates a new instance of Canvas.

[OwnerReturn]
public override method CreateCanvas ([Owner] ICanvasContent content)
type Canvas
params content [not-null] The canvas content object to use.
returns [not-null] The canvas object.
implements CanvasFactory.CreateCanvas

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.

GetSample

Returns a sample that describes the data that is stored at the given location.

[ThreadSafe]
public override method GetSample (CubemapFaceCoordsI coords)
type HeightmapSample
params coords The cubemap face coordinates.
returns An HeightmapSample value that describes the stored data.
overrides CanvasFactory.GetSample