class CanvasFactory in Tinman.Terrain.Tools

Abstract base class for ICanvasFactory implementations.

abstract class	CanvasFactory	extends	Disposable
		implements	ICanvasFactory
		base of	CanvasFactoryHeightmap
			CanvasFactoryPixelPyramid

Configuration

Config

The configurator object for this type.

public static property	Config { get }
type	IConfigurator<ICanvasFactory>
value	[not-null]	The configurator object.

ToConfig

Returns the configuration value that describes this object.

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

Public / Attributes

BlockSize

Size of a canvas block.

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

public abstract property	Georef { get }
type	Raster
value		The georeferencing object or null if no georeferencing is available.
implements	IGeorefInfo.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 abstract property	Map { get }
type	MapInfo
value		The map info value.
implements	IMapInfo.Map

SampleLayers

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

public virtual property	SampleLayers { get }
type	HeightmapLayer
value		The sample layers.
implements	ICanvasFactory.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.
implements	ICanvasFactory.SampleRange

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 abstract method	CreateCanvas ([Owner] ICanvasContent content)
type	Canvas
params	content	[not-null]	The canvas content object to use.
returns		[not-null]	The canvas object.
implements	ICanvasFactory.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 virtual method	GetSample (CubemapFaceCoordsI coords)
type	HeightmapSample
params	coords		The cubemap face coordinates.
returns			An HeightmapSample value that describes the stored data.
implements	ICanvasFactory.GetSample

Protected / Constructors

CanvasFactory

Creates a new instance of CanvasFactory.

protected constructor

CanvasFactory ()

Protected / Methods

DisposeManaged

Disposes the managed resources held by a concrete subclass. This method will be called at most once per subclass.

protected virtual method	DisposeManaged ()
inherited	Disposable.DisposeManaged

Remarks:

This method will only be called when a disposable object is explicitly destroyed by user code calling the Dispose method. It will not be called when the object is collected as garbage by the system.

Overriding methods must call the DisposeManaged method of their base class. The base call should be the last statement.

The DisposeManaged method is called before the DisposeUnmanaged method.

DisposeUnmanaged

Disposes the unmanaged resources held by a concrete subclass. This method will be called exactly once per subclass.

protected virtual method	DisposeUnmanaged ()
inherited	Disposable.DisposeUnmanaged

Remarks:

Overriding methods must call the DisposeUnmanaged method of their base class. The base call should be the last statement.

The DisposeUnmanaged method is called after the DisposeManaged method.