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

class GdalImageFormat in Tinman.AddOns.GDAL

An image format implementation that uses the GDAL (http://www.gdal.org) and PROJ.4 (http://proj4.org) libraries.

sealed class GdalImageFormat extends ImageFormat

Public / Attributes

Description

Long description of this file format.

public override property Description { get }
type string
value [not-null] The description string.
overrides FileFormat.Description

Mime

The machine-readable type of this file format.

public property Mime { get }
type string
value The machine-readable media type or null if none.
inherited FileFormat.Mime

Remarks:

For details on Media Types (aka. MIME-type), please refer to this webpage:
https://www.iana.org/assignments/media-types/media-types.xhtml

Name

The file format name.

public property Name { get }
type string
value [not-null] The file format name.
inherited FileFormat.Name

Next

Returns the next file format.

[ThreadSafe]
public property Next { get }
type IFileFormat
value The next file format or null.
inherited FileFormat.Next

Remarks:

The first file format can be obtained from implementing classes. This property can be used to cycle all available file formats of the same type.

Prefix

Lengths of the binary file data prefix that identifies this file format.

public virtual property Prefix { get }
type int32
value [>=0] The file data prefix length, in bytes. If 0, there is no identifying prefix.
inherited FileFormat.Prefix

Type

The human-readable type of this file format (e.g. images, shapes, 3D models).

public property Type { get }
type string
value [not-null] The human-readable type name.
inherited FileFormat.Type

Public / Constants

Instance

Uses GDAL for reading image data and georeferences; uses Tinman 3D for coordinate projection.

public static readonly field Instance
type ImageFormat

InstanceProj

Uses GDAL for reading image data and georeferences; uses PROJ.4 for coordinate projection.

public static readonly field InstanceProj
type ImageFormat

Public / Methods

CanRead

Can this file format object be used to read the given data?

public method CanRead (ByteBuffer data)
type bool
params data [not-null] The data to check. Must have at least Prefix remaining bytes, otherwise this method will always return false. The buffer will not be modified by this method.
returns true if the given data is prefixed with the identifying byte sequence of this file format,
false if the prefix is not present.
inherited FileFormat.CanRead

See also:

IFileFormat.Prefix

Can this file format object be used to read the given path?

public override method CanRead (string suffix, bool directory = false)
type bool
params suffix [not-null] The lower-case pathname suffix (without '.'). Will be empty if the path does not have a pathname suffix.
  directory Does the path refer to a directory (true) or to a file (false)? Defaults to false.
returns true if this file format can be used, false if not.
overrides FileFormat.CanRead

CanReadFind

Returns the first file format in the chain (see Next) that can read the given data.

public method CanReadFind (ByteBuffer data)
type IFileFormat
params data [not-null] The data to check. Must have at least Prefix remaining bytes, otherwise this method will always return false. The buffer will not be modified by this method.
returns The found file format or null.
inherited FileFormat.CanReadFind

Returns the first file format in the chain (see Next) that can read the given path.

public virtual method CanReadFind (string suffix, bool directory = false)
type IFileFormat
params suffix [not-null] The lower-case pathname suffix (without '.'). Will be empty if the path does not have a pathname suffix.
  directory Does the path refer to a directory (true) or to a file (false)? Defaults to false.
returns The found file format or null.
inherited FileFormat.CanReadFind

CanWrite

Can this file format object be used to write the given path?

public virtual method CanWrite (string suffix)
type bool
params suffix [not-null] The lower-case pathname suffix (without '.'). Will be empty if the path does not have a pathname suffix.
returns true if this file format can be used, false if not.
inherited FileFormat.CanWrite

CanWriteFind

Returns the first file format in the chain (see Next) that can write the given path.

public virtual method CanWriteFind (string suffix)
type IFileFormat
params suffix [not-null] The lower-case pathname suffix (without '.'). Will be empty if the path does not have a pathname suffix.
returns The found file format or null.
inherited FileFormat.CanWriteFind

PleaseIncludeInBinaryThanks

This is a method that forces the compiler / linker to include this type in the resulting binary.

public virtual method PleaseIncludeInBinaryThanks ()
inherited FileFormat.PleaseIncludeInBinaryThanks

Remarks:

Calling this stub method makes sure that all lazy constructor calls have been made.

To initialize everything, an application needs to call this method on its root module(s) (see TinmanModule), followed by a call to Initialize.

Exceptions:

ReadImage

Reads the given image.

[OwnerReturn]
public method ReadImage (IFileData data, ReadImageFlags flags)
type IImageReader
params data [not-null] The image data provider.
  flags The image reading flags.
returns [not-null] The validated IImageReader for reading the image data (see Validate).
inherited ImageFormat.ReadImage

Exceptions:

ReadTexture

Tries to read the given image data as a texture.

[OwnerReturn]
public virtual method ReadTexture (IFileData data, CubemapFace face)
type TexelBuffer
params data [not-null] The image data provider.
  face The cubemap face.
returns The read TexelBuffer or null if the given image data cannot be interpreted as a texture (pixels must be read separately and then encoded as texels).
inherited ImageFormat.ReadTexture

Exceptions:

ToString

[Pure]
public override sealed method ToString ()
type string
inherited FileFormat.ToString

WriteImage

Writes an image to the given file.

[OwnerReturn]
public virtual method WriteImage (Path file)
type IImageWriter
params file [not-null] The output image file.
returns [not-null] The image writer object to use.
inherited ImageFormat.WriteImage

Exceptions: