interface IPixelPyramid in Tinman.Terrain.Pyramids

Base interface for classes that represent a tile pyramid of color buffers (see ColorBuffer).

interface	IPixelPyramid	extends	IPyramid<ColorBuffer>
		base of	IPixelPyramidDraw
			IPixelPyramidShape
			PixelPyramid

Attributes

CanUpdate

Does this map allow updates to its content (i.e. sample data and/or metadata)?

property	CanUpdate { get }
type	bool
value		true if the map content can be updated, false if not.
inherited	IMapEntity.CanUpdate

Flags

Additional behaviour flags of the pyramid.

property	Flags { get }
type	PyramidFlags
value		The pyramid flags.
inherited	IPyramidBase.Flags

FullSize

The size of the bottom-most pyramid level.

property	FullSize { get }
type	int32
value	[pow2]	The pyramid size (width and height), in samples.
inherited	IPyramidBase.FullSize

Georef

Returns georeferencing information.

property	Georef { get }
type	Raster
value		The georeferencing object or null if no georeferencing is available.
inherited	IGeorefInfo.Georef

Levels

The number of pyramid levels.

property	Levels { get }
type	int32
value	[>=1]	The number of pyramid levels.
inherited	IPyramidBase.Levels

LifecycleState

Returns the lifecycle state of this object.

property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	ILifecycleState.LifecycleState

Map

Returns a MapInfo value that describes the used map raster.

property	Map { get }
type	MapInfo
value		The map info value.
inherited	IMapInfo.Map

OnUpdated

Event for listening to updates made to this pixel pyramid.

property	OnUpdated { get }
type	IEventGeneric<PyramidEventArgs>
value	[not-null]	The event object.
inherited	IPyramidBase.OnUpdated

Remarks:

This event will be fired by the thread that performs the map update.

TilePad

The pad width of this cube pyramid.

property	TilePad { get }
type	int32
value	[>=0]	The pad width.
inherited	IPyramidBase.TilePad

Remarks:

Tile padding is used to avoid color bleeding that will occur when texture samples are filtered at the edge of a pyramid tile (assuming tiles are stored in some kind of texture atlas). The tile pad width gives the number of safety pixels at the that are borrowed from neighbouring pyramid tiles:

      8x8 tile, with a pad of 2:

    0   1   2   3   4   5   6   7
  +---+---+---+---+---+---+---+---+
0 |###|###|###|###|###|###|###|###|
  +---+---+---+---+---+---+---+---+
1 |###|###|###|###|###|###|###|###|
  +---+--(X)--+---+---+--(X)--+---+
2 |###|###|   |   |   |   |###|###|
  +---+---+---+---+---+---+---+---+
3 |###|###|   |   |   |   |###|###|
  +---+---+---+---+---+---+---+---+
4 |###|###|   |   |   |   |###|###|
  +---+---+---+---+---+---+---+---+
5 |###|###|   |   |   |   |###|###|
  +---+--(X)--+---+---+--(X)--+---+
6 |###|###|###|###|###|###|###|###|
  +---+---+---+---+---+---+---+---+
7 |###|###|###|###|###|###|###|###|
  +---+---+---+---+---+---+---+---+

The point coordinates marked with (X) will be mapped to the corner vertices of each terrain mesh sector. Only the effective region of a padded tile (i.e. the square surrounded by (X)) contains actual data. The padded pixels are sampled from neighbouring source tiles and carry redundant information.

TileSize

The size of a single map tile, in pixels.

property	TileSize { get }
type	int32
value	[pow2]	The tile size.
inherited	IPyramidBase.TileSize

Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
inherited	IDisposable.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.

Cache

Wraps this pixel pyramid in a memory cache.

[OwnerReturn, OwnerThis]
method	Cache ()
type	IPixelPyramid
returns		[not-null]	The cached map pyramid.

Remarks:

The built-in pixel pyramid operations already make use of the Cache method where applicable, so client code usually does not need to call it.

If the Cache method has already been called on this object, the method silently returns this.

See also:

PyramidsUtil.CacheMemory

---

Wraps this pixel pyramid in a file cache.

[OwnerReturn, OwnerThis]
method	Cache (PyramidFileCache cache, int32 pyramidId)
type	IPixelPyramid
params	cache	[not-null]	The cache to use.
	pyramidId	[0..1023]	Persistent unique identifier of the pixel pyramid being cached.
returns		[not-null]	The cached map pyramid.

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]
method	Dispose ()
inherited	IDisposable.Dispose

Remarks:

The Dispose method silently returns if the object has already been disposed.

Flush

Flushes all cached data.

method	Flush ()
inherited	IFlushable.Flush

Remarks:

Performing a flush may result in I/O work. Depending on the semantics of the implementing class, this work may need to be wrapped in special Begin / End method calls. See the documentation of the implementing classes for details.

In case this object represents a read-only resource, calling the Flush method has no effect.

GetTileData

Returns the data content of the given map tile.

[ThreadSafe]
method	GetTileData (PyramidCoords coords, TData data, int32 dataX = 0, int32 dataY = 0)
type	TileDataResult
params	coords		The pyramid tile coords.
	data	[not-null]	The output buffer to use.
	dataX	[>=0]	X-coordinate of top-left corner of output rectangle.
	dataY	[>=0]	Y-coordinate of top-left corner of output rectangle.
returns			The result code.
inherited	IPyramid.GetTileData

---

Returns the image pixels of the given map tile.

[ThreadSafe]
method	GetTileData (CubemapFace face, int32 level, int32 x, int32 y, TData data, int32 dataX = 0, int32 dataY = 0)
type	TileDataResult
params	face		Cubemap face of map tile. Set to NegZ for unprojected map pyramids. Defaults to NegZ.
	level	[>=0]	The pyramid level.
	x		Cubemap face X-coordinate of map tile in level.
	y		Cubemap face Y-coordinate of map tile in level.
	data	[not-null]	The output buffer to use.
	dataX	[>=0]	X-coordinate of top-left corner of output rectangle.
	dataY	[>=0]	Y-coordinate of top-left corner of output rectangle.
returns			The result code.
inherited	IPyramid.GetTileData

HasTileData

Returns if there is any data content for the given map tile.

[ThreadSafe]
method	HasTileData (PyramidCoords coords)
type	bool
params	coords		The pyramid tile coords.
returns			true if data for the given map tile exists, false if not.
inherited	IPyramidBase.HasTileData

---

Returns if there is any data content for the given map tile (i.e. Ok or Empty).

[ThreadSafe]
method	HasTileData (CubemapFace face, int32 level, int32 x, int32 y)
type	bool
params	face		Cubemap face of map tile. Set to NegZ for unprojected map pyramids. Defaults to NegZ.
	level	[>=0]	The pyramid level.
	x		Cubemap face X-coordinate of map tile in level.
	y		Cubemap face Y-coordinate of map tile in level.
returns			true if data for the given map tile exists, false if not.
inherited	IPyramidBase.HasTileData

ToConfig

Returns the configuration value that describes this object.

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

ToFullSize

Changes the level count resp. full size of this pixel pyramid.

[OwnerReturn, OwnerThis]
method	ToFullSize (int32 fullSize)
type	IPixelPyramid
params	fullSize	[pow2]	The new full size (i.e. size of bottommost level).
returns		[not-null]	The resulting pixel pyramid.

See also:

IPyramidBase.FullSize

ToTilePad

Changes the tile padding of this pixel pyramid.

[OwnerReturn, OwnerThis]
method	ToTilePad (int32 tilePad)
type	IPixelPyramid
params	tilePad	[>=0]	The new tile padding value.
returns		[not-null]	The resulting pixel pyramid.

See also:

IPyramidBase.TilePad

ToTileSize

Changes the tile size of this pixel pyramid.

[OwnerReturn, OwnerThis]
method	ToTileSize (int32 tileSize)
type	IPixelPyramid
params	tileSize	[pow2]	The new tile size.
returns		[not-null]	The resulting pixel pyramid.

See also:

IPyramidBase.TileSize

UpdateGeoref

Updates georeferencing data of this heightmap.

[ThreadSafe]
method	UpdateGeoref (Raster georef)
params	georef		The new georeferencing data or null.
inherited	IMapEntity.UpdateGeoref

See also:

IMapEntity.CanUpdate

Extensions

Combine

Combines this pyramid (first) with the given one (second), according to the given color and combine operation (see ColorOp, CombineOp).

[OwnerReturn, OwnerThis]
method	Combine ([Owner] IPixelPyramid other, ColorOp colorOp = ColorOp.Blend, CombineOp combineOp = CombineOp.Union)
type	IPixelPyramid
params	other	[not-null]	The other pixel pyramid (second).
	colorOp		The color operation to apply. Defaults to Blend.
	combineOp		The combine operation to apply. Defaults to Union.
returns		[not-null]	The resulting pixel pyramid.

Draw

Performs some user-defined drawing on the pyramid tile.

[OwnerReturn, OwnerThis]
method	Draw (DrawDelegate draw = null, object userData = null)
type	IPixelPyramidDraw
params	draw		The draw delegate method (see Draw). Defaults to null.
	userData		Optional user data object (see UserData). Defaults to null.
returns		[not-null]	The resulting pixel pyramid.

EncodePixels

Returns an encoded version of this pyramid to use for texturing.

[OwnerReturn, OwnerThis]
method	EncodePixels (TextureFormat format)
type	ITexelPyramid
params	format	[not-null]	The texture format to use for encoding.
returns		[not-null]	The encoded texture pyramid.

ToImage

Reads a rectangular region of a single level of this pyramid as an image.

method	ToImage (int32 level, CubemapFaceRect rect)
type	IImage
params	level	[>=0]	The pyramid level.
	rect		The rectangular region.
returns		[not-null]	The created IImageReader object.

Unproject

Unprojects this map pyramid into a plain cubemap pyramid.

[OwnerReturn, OwnerThis]
method	Unproject (int32 tileSize = 256, int32 pad = 0, bool allowMinify = true, bool allowMagnify = true, bool allowPartial = true, int32 levels = 0)
type	IPixelPyramid
params	tileSize	[pow2]	The unprojected tile size, in pixels. Defaults to 256.
	pad	[>=0]	The padding width, in pixels (see TilePad). Defaults to 0.
	allowMinify		Allow unprojected tiles to be minified during projection? Defaults to true.
	allowMagnify		Allow unprojected tiles to be magnified during projection? Defaults to true.
	allowPartial		Allow unprojected tiles to contain partial data (i.e. one or more missing input map tiles)? Defaults to true.
	levels	[>=0]	Number of cube pyramid levels. If 0 the maximum level count will be inferred from this map pyramid and the given tile size. Defaults to 0.
returns		[not-null]	The unprojected map pyramid.