interface ICanvasFactory in Tinman.Terrain.Tools

Base interface for classes that create Canvas objects.

interface	ICanvasFactory	extends	ICanvasBlockSize
			IConfigurable
			IDisposable
			IGeorefInfo
		base of	CanvasFactory

Attributes

BlockSize

Size of a canvas block.

property	BlockSize { get }
type	int32
value	[>0]	The block size, in canvas raster samples.
inherited	ICanvasBlockSize.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

Georef

Returns georeferencing information.

property	Georef { get }
type	Raster
value		The georeferencing object or null if no georeferencing is available.
inherited	IGeorefInfo.Georef

LifecycleState

Returns the lifecycle state of this object.

property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	ILifecycleState.LifecycleState

Map

Returns a MapInfo value that describes the used map raster.

property	Map { get }
type	MapInfo
value		The map info value.
inherited	IMapInfo.Map

SampleLayers

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

property	SampleLayers { get }
type	HeightmapLayer
value		The sample layers.

SampleRange

Returns the vertical range for the samples returned by GetSample.

property	SampleRange { get }
type	VerticalRange
value		The sample range, in Metre.

Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
inherited	IDisposable.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]
method	CreateCanvas ([Owner] ICanvasContent content)
type	Canvas
params	content	[not-null]	The canvas content object to use.
returns		[not-null]	The canvas object.

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]
method	Dispose ()
inherited	IDisposable.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]
method	GetSample (CubemapFaceCoordsI coords)
type	HeightmapSample
params	coords		The cubemap face coordinates.
returns			An HeightmapSample value that describes the stored data.

ToConfig

Returns the configuration value that describes this object.

method	ToConfig ()
type	ConfigValue
returns		[not-null]	The configuration value.
inherited	IConfigurable.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.