IMapRegion

Description

interface Tinman.Terrain.Mapping.IMapRegion

Derived from

IMapInfo

Extended by

MapRegionBase abstract

Base interface for classes that represent arbitrary regions of a map.

A IMapRegion implementation stores a set of rectangles on the cubemap faces (see CubemapFaceRect); each such rectangle defines a subregion.

Public / Methods

Contains


public method Contains → (3)

faceX in : int32

The cubemap face X-coordinate.

faceY in : int32

The cubemap face Y-coordinate.

face opt : CubemapFace = CubemapFace.NegZ

The cubemap face.

returns → bool

true if the map region contains the given sample, false if not.

Does this map region contain the given map sample?

Contains​Rect


public method ContainsRect → (5)

faceX in : int32

The cubemap face X-coordinate of top-left corner of rectangle.

faceY in : int32

The cubemap face Y-coordinate of top-left corner of rectangle.

width in : int32

Width of rectangle.

height in : int32

Height of rectangle.

face opt : CubemapFace = CubemapFace.NegZ

The cubemap face.

returns → int32

-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.

Does this map region contain the given map sample rectangle?

Rectangles​Enumerate


public method RectanglesEnumerate → (1)

collector in : CollectorDelegate<CubemapFaceRect>

[not-null]
The object that collects the resulting cubemap face rectangles.

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

Public / Attributes

Height


public attribute Height → (get)

value : int32

[>0]
The map height, in samples.

The map height.

Type


public attribute Type → (get)

value : MapType

The map type.

The map type.

Width


public attribute Width → (get)

value : int32

[>0]
The map width, in samples.

The map width.

Extensions

Contains​Box

2 overloads


public static method ContainsBox1 → (1)

box in : Box2I

The map sample region.

returns → int32

-1 if the given box does not intersect with this map region (i.e. not contained), 0 if the given box intersects with this map region but is not fully enclosed (i.e. partially contained) and 1 if the given box is fully enclosed by this map region.

Does this map region contain the given map sample regions?


public static method ContainsBox2 → (1)

box in : Box3I

The map sample region.

returns → int32

-1 if the given box does not intersect with this map region (i.e. not contained), 0 if the given box intersects with this map region but is not fully enclosed (i.e. partially contained) and 1 if the given box is fully enclosed by this map region.

Does this map region contain the given map sample regions?

Contains​Coords


public static method ContainsCoords → (1)

coords in : CubemapFaceCoordsI

The cubemap face coordinates.

returns → bool

true if the map region contains the given sample, false if not.

Does this map region contain the given map sample?

Count​Samples


public static method CountSamples → ()

returns → int64

The count of samples contained in all subregions.

Counts the map samples that are contained in this map region.

Project


public static method Project → (2)

projection in : IMapProjectionFactory

[not-null]
The map projection to use.

result in : MapRegion

[not-null]
The resulting map regions.

Projects the map regions stored in this object and stores the resulting regions in the given object.

GeorefException

If the raster specifications of this and result in are not supported by the given projection in factory.

Rectangles​Array


public static method RectanglesArray → ()

returns → CubemapFaceRect [ ]

The subregions.

Finds all subregions in this region.

Size


public static method Size → ()

returns → int32

The cubemap size, in samples.

Returns the cubemap size of this map region.

The cubemap size is the maximum of IMapRegion.Width and IMapRegion.Height.