class HeightmapCollection in Tinman.Terrain.Heightmaps

sealed class

HeightmapCollection

extends

DatasetCollection<IHeightmapDataset>

Public / Attributes

LifecycleState

Returns the lifecycle state of this object.

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

Public / Constructors

Open

Opens an existing dataset in read-only mode, adding it to the collection.

[OwnerReturn, ThreadSafe]
public method	Open (string filePath, DatasetFileCacheDelegate cache = null)
type	T
params	filePath	[not-null]	Path to the dataset file.
	cache		Optional dataset file cache delegate to use. Defaults to null.
returns		[not-null]	The opened IHeightmap object.
inherited	DatasetCollection.Open

---

Opens an existing dataset in read-only mode, adding it to the collection.

[OwnerReturn, ThreadSafe]
public method	Open (Path filePath, DatasetFileCacheDelegate cache = null)
type	T
params	filePath	[not-null]	Path to the dataset file.
	cache		Optional dataset file cache delegate to use. Defaults to null.
returns		[not-null]	The opened IHeightmap object.
inherited	DatasetCollection.Open

---

Opens an existing dataset, adding it to the collection.

[OwnerReturn, ThreadSafe]
public method	Open ([Owner] IFile file, DatasetFileCacheDelegate cache = null)
type	T
params	file	[not-null]	The dataset file.
	cache		Optional dataset file cache delegate to use. Defaults to null.
returns		[not-null]	The opened IHeightmap object.
inherited	DatasetCollection.Open

---

Opens an existing dataset, adding it to the collection.

[OwnerReturn, ThreadSafe]
public method	Open (string filePath, bool readOnly, DatasetFileCacheDelegate cache = null)
type	T
params	filePath	[not-null]	Path to the dataset file.
	readOnly		Open dataset in read-only mode?
	cache		Optional dataset file cache delegate to use. Defaults to null.
returns		[not-null]	The opened IHeightmap object.
inherited	DatasetCollection.Open

---

Opens an existing dataset, adding it to the collection.

[OwnerReturn, ThreadSafe]
public method	Open (Path filePath, bool readOnly, DatasetFileCacheDelegate cache = null)
type	T
params	filePath	[not-null]	Path to the dataset file.
	readOnly		Open dataset in read-only mode?
	cache		Optional dataset file cache delegate to use. Defaults to null.
returns		[not-null]	The opened IHeightmap object.
inherited	DatasetCollection.Open

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.

Add

Adds a dataset to this collection.

[BeginEnd, ThreadSafe]
public method	Add (T dataset)
params	dataset	[not-null]	The dataset to add.
inherited	DatasetCollection.Add

Begin

Begins an access to this object.

public method	Begin ()
inherited	DatasetCollection.Begin

Remarks:

See the documentation of the class which implements this interface for details on the operations that must be wrapped in Begin and End calls.

See also:

BeginEnd

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.

End

Ends the current access to this object.

public method	End ()
inherited	DatasetCollection.End

Remarks:

See the documentation of the class which implements this interface for details on the operations that must be wrapped in Begin and End calls.

See also:

BeginEnd

Lookup

Tries to find an opened dataset by its GUID.

[OwnerReturn]
public method	Lookup (GUID guid)
type	T
params	guid		The GUID to look for.
returns			The corresponding dataset or null if not found.
inherited	DatasetCollection.Lookup

Remove

Removes a dataset from this collection.

[BeginEnd, ThreadSafe]
public method	Remove (T dataset)
params	dataset	[not-null]	The dataset to remove.
inherited	DatasetCollection.Remove