Box2D

Description

struct Tinman.Terrain.Util.Box2D

A two-dimensional bounding box with 64-bit floating-point precision.

The coordinates refer to infinitesimal points (pixel-is-point semantic).

Public / Constants

Empty

public static readonly attribute Empty → (Box2D)

An empty bounding box at the coordinate origin.

See also: Box2D.IsEmpty

Inverse

public static readonly attribute Inverse → (Box2D)

An inverse bounding box that can be used as the initial value for computing bounds via subsequent calls to Grow.

See also: Box2D.IsInverse

Max

public static readonly attribute Max → (Box2D)

The largest possible box.

Note that the dimension of this box cannot be represented with regular 64-bit floating point numbers and will instead be positive infinity.

Public / Methods

CheckIntersection

_3 overloads

[Pure]
public method CheckIntersection¹ → (1)

box ⁱⁿ : Box2D: The other bounding box.
returns → int32: -1 if the bounding boxes do not overlap, 1 if box ⁱⁿ fully contains this bounding box and 0 if both bounding boxes overlap.

Checks the intersection between this bounding box and the given one.

[Pure]
public method CheckIntersection² → (2)

a ⁱⁿ : Vec2D: First point of line segment.
b ⁱⁿ : Vec2D: Second point of line segment.
returns → int32: -1 no intersection.
0 intersection and one line segment point is inside of this box.
1 intersection and both line segment points are inside of this box.
2 intersection and both line segment points are outside of this box.

Checks the intersection between this bounding box and the given line segment.

[Pure]
public method CheckIntersection³ → (4)

ax ⁱⁿ : float64: X-coordinate of first point of line segment.
ay ⁱⁿ : float64: Y-coordinate of first point of line segment.
bx ⁱⁿ : float64: X-coordinate of second point of line segment.
by ⁱⁿ : float64: Y-coordinate of second point of line segment.
returns → int32: -1 no intersection.
0 intersection and only one line segment point is inside of this box.
1 intersection and both line segment points are inside of this box.
2 intersection and both line segment points are outside of this box.

Checks the intersection between this bounding box and the given line segment.

CheckIntersectionEdges

[Pure]
public method CheckIntersectionEdges → (4)

ax ⁱⁿ : float64: X-coordinate of first point of line segment.
ay ⁱⁿ : float64: Y-coordinate of first point of line segment.
bx ⁱⁿ : float64: X-coordinate of second point of line segment.
by ⁱⁿ : float64: Y-coordinate of second point of line segment.
returns → bool: true if the line segment intersects with any edge of the given box,
false if there is no intersection.

Checks the intersection between the edges of this bounding box and the given line segment.

Clamp

_2 overloads

[Pure]
public method Clamp¹ → (2)

x ⁱⁿ : float64: X-coordinate of point.
y ⁱⁿ : float64: Y-coordinate of point.
returns → Vec2D: The clamped point.

Clamps the given point to this box.

[Pure]
public method Clamp² → (1)

v ⁱⁿ : Vec2D: The point coordinates.
returns → Vec2D: The clamped point.

Clamps the given point to this box.

ComputeOverlap

[Pure]
public method ComputeOverlap → (1)

box ⁱⁿ : Box2D: Second bounding box.
returns → float64: The amount of overlap (i.e. the volume of the intersection).

Computes the overlap of this bounding box and the given one.

Contains

_3 overloads

[Pure]
public method Contains¹ → (1)

xyz ⁱⁿ : Vec2D: The point coordinates.
returns → bool: true if this box contains the point, false if not.

Checks if this box contains the given point.

[Pure]
public method Contains² → (2)

x ⁱⁿ : float64: The point X-coordinate.
y ⁱⁿ : float64: The point Y-coordinate.
returns → bool: true if this box contains the point, false if not.

Checks if this box contains the given point.

[Pure]
public method Contains³ → (1)

box ⁱⁿ : Box2D: The other box.
returns → bool: true if this box fully contains the given box, false if not.

Checks if this box contains the given box.

Disjoint

[Pure]
public method Disjoint → (1)

box ⁱⁿ : Box2D: The other box.
returns → bool: true if this box and the given box are disjoint, false if not.

Checks if this box and the given box are disjoint (i.e. do not intersect).

EqualsAlmost

[Pure]
public method EqualsAlmost → (1)

other ⁱⁿ : Box2D: The other box
returns → bool: true if both boxes are similar, false if they are not.

Checks if this box and the given one are similar but necessarily equal.

See also: Maths.Similar²

FromPoints

_2 overloads

[Pure]
public static method FromPoints¹ → (4)

x1 ⁱⁿ : float64: X-coordinate of first corner point.
y1 ⁱⁿ : float64: Y-coordinate of first corner point.
x2 ⁱⁿ : float64: X-coordinate of second corner point.
y2 ⁱⁿ : float64: Y-coordinate of second corner point.
returns → Box2D: The bounding box.

Creates a new instance of Box2D from the given corner points.

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

a ⁱⁿ : Vec2D: First corner point.
b ⁱⁿ : Vec2D: Second corner point.
returns → Box2D: The bounding box.

Creates a new instance of Box2D from the given corner points.

FromRect

[Pure]
public static method FromRect → (4)

x ⁱⁿ : float64: X-coordinate of first corner point.
y ⁱⁿ : float64: Y-coordinate of first corner point.
width ⁱⁿ : float64: Width of rectangle.
height ⁱⁿ : float64: Height of rectangle.
returns → Box2D: The bounding box.

Creates a new instance of Box2D from the given rectangle.

Grow

_3 overloads

public method Grow¹ → (1)

box ⁱⁿ : Box2D: To other box.
returns → Box2D: The resulting box.

Enlarges the extends of this box so that it covers the given box.

public method Grow² → (1)

v ⁱⁿ : Vec2D: Coordinates of point to cover (can be NaN).
returns → Box2D: The resulting box.

Enlarges the extends of this box so that it covers the given point.

public method Grow³ → (2)

x ⁱⁿ : float64: X-coordinate of point to cover (can be NaN).
y ⁱⁿ : float64: Y-coordinate of point to cover (can be NaN).
returns → Box2D: The resulting box.

Enlarges the extends of this box so that it covers the given point.

Intersect

[Pure]
public method Intersect → (1)

box ⁱⁿ : Box2D: The bounding box.
returns → Box2D: The resulting bounding box.

Computes the intersection of the given bounding box and this one.

Pad

[Pure]
public method Pad → (1)

amount ⁱⁿ : float64: The amount to grow.
returns → Box2D: The resulting box

Uniformly pads (i.e. grows) this box by the given amount ⁱⁿ.

Scale

[Pure]
public method Scale → (1)

factor ⁱⁿ : float64: The scale factor.
returns → Box2D: The resulting bounding box.

Scales the coordinates of this bounding box.

Translate

_2 overloads

[Pure]
public method Translate¹ → (1)

v ⁱⁿ : Vec2D: The translation vector.
returns → Box2D: The translated bounding box.

Translates this bounding box.

[Pure]
public method Translate² → (2)

x ⁱⁿ : float64: Translation amount along X-axis.
y ⁱⁿ : float64: Translation amount along Y-axis.
returns → Box2D: The resulting bounding box.

Translates this bounding box.

Public / Attributes

Area

public attribute Area → (get)

value : float64: [>=0]
The bounding box volume.

Returns the volume of this bounding box.

The volume will always be 0 when IsEmpty returns true.

BottomLeft

public attribute BottomLeft → (get)

value : Vec2D: The bottom-left corner: X1 is stored in Vec2D.X, Y2 is stored in Vec2D.Y.

Returns the bottom-left corner of this box.

BottomRight

public attribute BottomRight → (get)

value : Vec2D: The bottom-right corner: X2 is stored in Vec2D.X, Y2 is stored in Vec2D.Y.

Returns the bottom-right corner of this box.

Center

public attribute Center → (get)

value : Vec2D: The coordinates of the box center.

Return the center of this box.

Height

public attribute Height → (get)

value : float64: [>=0]
The box height.

Returns the extends of this box along the Y-axis.

IsEmpty

public attribute IsEmpty → (get)

value : bool: true if this bounding box is empty, false if not.

Is this bounding box empty?

See also: Box2D.Empty

IsInverse

public attribute IsInverse → (get)

value : bool: true if this is the inverse bounding box, false if not.

Is this the inverse bounding box?

See also: Box2D.Inverse

Size

public attribute Size → (get)

value : Vec2D: The box size: The Width is stored in Vec2D.X, the Height in Vec2D.Y.

Returns the size of this box.

TopLeft

public attribute TopLeft → (get)

value : Vec2D: The top-left corner: X1 is stored in Vec2D.X, Y1 is stored in Vec2D.Y.

Returns the top-left corner of this box.

TopRight

public attribute TopRight → (get)

value : Vec2D: The top-right corner: X2 is stored in Vec2D.X, Y1 is stored in Vec2D.Y.

Returns the top-right corner of this box.

Width

public attribute Width → (get)

value : float64: [>=0]
The box width.

Returns the extends of this box along the X-axis.

X1

public readonly attribute X1 → (float64)

X-coordinate of minimum corner of bounding box.

X2

public readonly attribute X2 → (float64)

X-coordinate of maximum corner of bounding box.

Y1

public readonly attribute Y1 → (float64)

Y-coordinate of minimum corner of bounding box.

Y2

public readonly attribute Y2 → (float64)

Y-coordinate of maximum corner of bounding box.

Serialization

Serializer

public static readonly attribute Serializer → (ITypeSerializer<Box2D>)

The serialization helper object for values of Box2D.

Box2D

Description

Public / Constants

Empty

Inverse

Max

Public / Methods

Check​Intersection

Check​Intersection​Edges

Clamp

Compute​Overlap

Contains

Disjoint

Equals​Almost

From​Points

From​Rect

Grow

Intersect

Pad

Scale

Translate

Public / Attributes

Area

Bottom​Left

Bottom​Right

Center

Height

Is​Empty

Is​Inverse

Size

Top​Left

Top​Right

Width

X1

X2

Y1

Y2

Serialization

Serializer

CheckIntersection

CheckIntersectionEdges

ComputeOverlap

EqualsAlmost

FromPoints

FromRect

BottomLeft

BottomRight

IsEmpty

IsInverse

TopLeft

TopRight