PixelPyramidBuilder

Description

sealed class Tinman.Terrain.Pyramids.PixelPyramidBuilder

Derived from

IMapInfo

A builder for IPixelPyramid objects.

First, use these methods to configure the builder properties:

The, call one of these method to create a IPixelPyramid object:

Use IMapInfo.Map to obtain the MapInfo value that will be returned by the built IPixelPyramid, based on the current builder properties.

Public / Constructors

Constant

2 overloads


[OwnerReturn]
public method Constant1 → (1)

color in : int64

The uniform color value (see Colors).

returns → IPixelPyramid

The resulting pixel pyramid.

Creates a pixel pyramid of uniform color.


[OwnerReturn]
public method Constant2 → (2)

colorNegY in : int64

The uniform color value (see Colors) for CubemapFace.NegY. This is usually the North pole.

colorPosY in : int64

The uniform color value (see Colors) for CubemapFace.PosY. This is usually the South pole.

returns → IPixelPyramid

The resulting pixel pyramid.

Creates a pixel pyramid with separate uniform colors for the cubemap-Y faces.

Usually, this method is used to create a pixel pyramid that fills holes at the North and South poles (e.g. Mercator voids).

Dataset

3 overloads


[OwnerReturn]
public method Dataset1 → (3)

file in : string

[not-null]
The output file.

flags opt : PyramidFlags = PyramidFlags.Opaque

The pyramid flags.

wait opt : int32 = 0

[>=0]
Maximum time to wait for other threads to close the dataset, in milliseconds.

returns → IPixelPyramidDataset

The created IPixelPyramid object.

Creates a mutable pixel pyramid that is kept in the given *.PYR file.

Storage space is only allocated for pyramid tiles that contain data (see IPyramidBase.HasTileData2). So storage space consumption does not depend on the pyramid size, but on the quantity of data that has been fed into it.

IOException

If an I/O error has occurred.


[OwnerReturn]
public method Dataset2 → (3)

file in : Path

[not-null]
The output file.

flags opt : PyramidFlags = PyramidFlags.Opaque

The pyramid flags.

wait opt : int32 = 0

[>=0]
Maximum time to wait for other threads to close the dataset, in milliseconds.

returns → IPixelPyramidDataset

The created IPixelPyramid object.

Creates a mutable pixel pyramid that is kept in the given *.PYR file.

Storage space is only allocated for pyramid tiles that contain data (see IPyramidBase.HasTileData2). So storage space consumption does not depend on the pyramid size, but on the quantity of data that has been fed into it.

IOException

If an I/O error has occurred.


[OwnerReturn]
public method Dataset3 → (2)

file in : IFile own

[not-null]
The output file.

flags opt : PyramidFlags = PyramidFlags.Opaque

The pyramid flags.

returns → IPixelPyramidDataset

The created IPixelPyramid object.

Creates a mutable pixel pyramid that is kept in the given *.PYR file.

Storage space is only allocated for pyramid tiles that contain data (see IPyramidBase.HasTileData2). So storage space consumption does not depend on the pyramid size, but on the quantity of data that has been fed into it.

IOException

If an I/O error has occurred.

Memory


[OwnerReturn]
public method Memory → (1)

flags opt : PyramidFlags = PyramidFlags.None

The pyramid flags.

returns → IPixelPyramid

The created IPixelPyramid object.

Creates a mutable pixel pyramid dataset that is kept entirely in memory.

Memory is only allocated for tiles that contain data (see IPyramidBase.HasTileData2). So memory consumption does not depend on the pixel pyramid size, but on the quantity of data that has been fed into it.

Shapes


[OwnerReturn]
public method Shapes → ()

returns → IPixelPyramidShape

The pixel pyramid.

Creates a pixel pyramid that rasterizes vector shape layers.

This method calls GeorefDefault.

Public / Methods

Format​Hint


public method FormatHint → (1)

format in : PixelFormat

The pixel format hint.

returns → PixelPyramidBuilder

this

Specifies a pixel format hint to use for encoding / decoding of pixel data.

The pixel format hint is interpreted as follows:

The default value is PixelFormat.Default.

Full​Size


public method FullSize → (1)

fullSize in : int32

[pow2]
The full size.

returns → PixelPyramidBuilder

this

Specifies the full size of the pixel pyramid.

The default value is MappingUtil.MaxSize.

Georef


public method Georef → (1)

georef in : Raster

The geo-reference raster or null.

returns → PixelPyramidBuilder

this

Specifies the geo-reference for the pixel pyramid.

This method will also set the map type via Type, according to Raster.RasterType of georef in, if not null.

The cubemap size of the given raster transform (see IRasterTransform.Size of Raster.Transform of georef in) will be adjusted by this method and may thus have an arbitrary value.

The default value is null.

See also

IPyramidBase

Georef​Default


public method GeorefDefault → ()

returns → PixelPyramidBuilder

this

Specifies a default geo-reference for the pixel pyramid, if necessary.

If no geo-reference raster has been specified (i.e. HasGeoref returns false), a default raster will be chosen depending on the map type that has been chosen with Type:

To specify another geo-reference, use the Georef method, before calling this method.

Tile​Pad


public method TilePad → (1)

tilePad in : int32

[>=0]
The tile pad.

returns → PixelPyramidBuilder

this

Specifies the tile pad of the pixel pyramid.

The default value is 0.

Tile​Size


public method TileSize → (1)

tileSize in : int32

[pow2]
The tile size.

returns → PixelPyramidBuilder

this

Specifies the tile size of the pixel pyramid.

The default value is 256.

Type


public method Type → (1)

type in : MapType

The map type.

returns → PixelPyramidBuilder

this

Specifies the map type of the pixel pyramid.

Setting a map type in that is inconsistent with Raster.RasterType of the current geo-reference (see Georef) will clear the current geo-reference to null, i.e. HasGeoref will return false.

The default value is MapType.Cube.

See also

IMapInfo.Map

Public / Attributes

Has​Georef


public attribute HasGeoref → (get)

value : bool

true if a valid geo-reference raster has been specified,
false if there is no geo-reference raster.

Returns whether the builder has a valid geo-reference raster.