SceneData

Description

abstract class Tinman.Engine.Scenes.Data.SceneData

Derived from

Disposable abstract
ISceneData
IDisposableGeneric<SceneData>

Abstract base class for ISceneData implementations.

To open or create a scene database, the following factories may be used:

Alternatively, a SceneDataFormat instance may be used to open a database with a specific format via SceneDataFormat.Dataset.

Public / Constructors

New

3 overloads

[OwnerReturn]
public static method New1 → (4)

data in : string

[not-null]
The scene dataset.

mode opt : DatasetMode = DatasetMode.Open

The dataset mode to use.

flags opt : SceneDataFlags = SceneDataFlags.All

The scene data flags to use.

format opt : SceneDataFormat = null

The dataset format. If null, SceneDataFormat.Any is used.

returns → ISceneData

The created ISceneData object.

Creates a ISceneData object for the given dataset.

IOException

If an I/O error has occurred.

GeorefException

If the scene data contains unsupported geo-referencing metadata.

ValidatingException

If a validation error has occurred on the returned scene data.

See also

SceneDataFormat.Dataset

[OwnerReturn]
public static method New2 → (4)

data in : Path

[not-null]
The scene dataset.

mode opt : DatasetMode = DatasetMode.Open

The dataset mode to use.

flags opt : SceneDataFlags = SceneDataFlags.All

The scene data flags to use.

format opt : SceneDataFormat = null

The dataset format. If null, SceneDataFormat.Any is used.

returns → ISceneData

The created ISceneData object.

Creates a ISceneData object for the given dataset.

IOException

If an I/O error has occurred.

GeorefException

If the scene data contains unsupported geo-referencing metadata.

ValidatingException

If a validation error has occurred on the returned scene data.

See also

SceneDataFormat.Dataset

[OwnerReturn]
public static method New3 → (4)

data in : IFileData

[not-null]
The scene dataset.

mode opt : DatasetMode = DatasetMode.Open

The dataset mode to use.

flags opt : SceneDataFlags = SceneDataFlags.All

The scene data flags to use.

format opt : SceneDataFormat = null

The dataset format. If null, SceneDataFormat.Any is used.

returns → ISceneData

The created ISceneData object.

Creates a ISceneData object for the given dataset.

IOException

If an I/O error has occurred.

GeorefException

If the scene data contains unsupported geo-referencing metadata.

ValidatingException

If a validation error has occurred on data in or the returned scene data.

See also

SceneDataFormat.Dataset

Protected / Methods

Throw​If​Read​Only

protected method ThrowIfReadOnly → (1)

source in : string

The error source tag.

Throws an exception if in read-only mode.

IOException

If in read-only mode.

See also

SceneData.PathInfo

Protected / Attributes

Path​Info

protected virtual attribute PathInfo → (get)

value : Path

The path or null.

Returns the Path object to use for error reporting.

See also

SceneData.ThrowIfReadOnly