class MapRegionBase in Tinman.Terrain.Mapping

Abstract base class for IMapRegion implementations.

abstract class	MapRegionBase	implements	IMapRegion
		base of	MapRegion

Public / Attributes

Height

The map height.

public property	Height { get }
type	int32
value	[>0]	The map height, in samples.
implements	IMapRegion.Height

Map

Returns a MapInfo value that describes the used map raster.

public abstract property	Map { get }
type	MapInfo
value		The map info value.
implements	IMapInfo.Map

Type

The map type.

public property	Type { get }
type	MapType
value		The map type.
implements	IMapRegion.Type

Width

The map width.

public property	Width { get }
type	int32
value	[>0]	The map width, in samples.
implements	IMapRegion.Width

Public / Methods

Contains

Does this map region contain the given map sample?

public abstract method	Contains (int32 faceX, int32 faceY, CubemapFace face = CubemapFace.NegZ)
type	bool
params	faceX		The cubemap face X-coordinate.
	faceY		The cubemap face Y-coordinate.
	face		The cubemap face. Defaults to NegZ.
returns			true if the map region contains the given sample, false if not.
implements	IMapRegion.Contains

ContainsRect

Does this map region contain the given map sample rectangle?

public abstract method	ContainsRect (int32 faceX, int32 faceY, int32 width, int32 height, CubemapFace face = CubemapFace.NegZ)
type	int32
params	faceX		The cubemap face X-coordinate of top-left corner of rectangle.
	faceY		The cubemap face Y-coordinate of top-left corner of rectangle..
	width		Width of rectangle.
	height		Height of rectangle.
	face		The cubemap face. Defaults to NegZ.
returns			-1 if the given rectangle does not intersect with this map region (i.e. not contained). 0 if the given rectangle intersects with this map region but is not fully enclosed (i.e. partially contained). 1 if the given rectangle is fully enclosed by this map region.
implements	IMapRegion.ContainsRect

RectanglesEnumerate

Enumerates all cubemap face rectangles that belong to this map region.

public method	RectanglesEnumerate (CollectorDelegate<CubemapFaceRect> collector)
params	collector	[not-null]	The object that collects the resulting cubemap face rectangles.
implements	IMapRegion.RectanglesEnumerate

Protected / Methods

DoRectanglesEnumerate

protected abstract method	DoRectanglesEnumerate (CollectorDelegate<CubemapFaceRect> callback)
params	callback

Initialize

Initializes type and size of this map region object.

protected method	Initialize (MapType type, int32 width, int32 height)
params	type		The map type.
	width	[>0]	The map width, in samples.
	height	[>0]	The map height, in samples.