MappingUtil

Description

static class Tinman.Terrain.Mapping.MappingUtil

Helper class for this module.

Public / Constants

MaxSize

public constant MaxSize → (1073741824:int32)

Maximum map raster size.

See also: MapInfo

MinSize

public constant MinSize → (256:int32)

Minimum map raster size.

See also: MapInfo

Public / Methods

ComputeShiftToMaxSize

[Pure]
public static method ComputeShiftToMaxSize → (1)

size ⁱⁿ : int32: [pow2]
The raster size of the map.
returns → int32: The number of bits to shift.

Computes the number of bits to shift in order to scale the coordinates of a map raster of the given size ⁱⁿ to a map raster of MaxSize.

See also: HeightmapsUtil.ComputeShiftToMaxSize

ComputeSize

[Pure]
public static method ComputeSize → (3)

width ⁱⁿ : int32: The raster width.
height ^opt : int32 = 0: The raster height.
minSize ^opt : int32 = MappingUtil.MinSize: The minimum size.
returns → int32: The raster size.

Computes the internal raster size for the given raster width and height.

Midpoint

_3 overloads

[Pure]
public static method Midpoint¹ → (2)

a ⁱⁿ : Vec2I: First point.
b ⁱⁿ : Vec2I: Second point.
returns → Vec2I: The midpoint.

Computes the map coordinates of the point that lies halfway between a ⁱⁿ and b ⁱⁿ.

See also: MappingUtil.MaxSize

[Pure]
public static method Midpoint² → (2)

a ⁱⁿ : Vec3I: First point.
b ⁱⁿ : Vec3I: Second point.
returns → Vec3I: The midpoint.

Computes the map coordinates of the point that lies halfway between a ⁱⁿ and b ⁱⁿ.

See also: MappingUtil.MaxSize

[Pure]
public static method Midpoint³ → (2)

a ⁱⁿ : int32: First coordinate.
b ⁱⁿ : int32: Second coordinate.
returns → int32: The midpoint coordinate.

Computes the map coordinate that lies halfway between a ⁱⁿ and b ⁱⁿ.

See also: MappingUtil.MaxSize

Valid

[Pure]
public static method Valid → (3)

type ⁱⁿ : MapType: The map type.
width ⁱⁿ : int32: The map width.
height ⁱⁿ : int32: The map height.
returns → bool: true if the combination is valid, false if not.

Checks if the given combination of map type, width and height is valid.

Wrap

[Pure]
public static method Wrap → (3)

coords ⁱⁿ : Vec2D: The map coordinates.
wrapX ⁱⁿ : MapWrap: Wrapping along X-axis.
wrapY ⁱⁿ : MapWrap: Wrapping along Y-axis.
returns → Vec2D: The wrapped coordinates or Vec3D.Undefined if coords ⁱⁿ are out of the valid map bounds.

Performs wrapping on the given map coordinates.