BoxN

References
public struct BoxN : IDimensional, IEquatable<BoxN>, IComparable<BoxN>
Represents an immutable n-dimensional rectangle.

Constructors

BoxN

#
public BoxN(params BoxN[] boxes)
Create a box from a set of boxes.
Parameters:
boxes (params BoxN[])Boxes.

BoxN

#
public BoxN(params PointN[] points)
Create a box from a set of points.
Parameters:
points (params PointN[])Points.

Properties

Centre

#
public PointN Centre { get; }
Gets the centre of the box.

Description

#
public string Description { get; }
Gets a description of this object type.
Implements: Description

Dimensionality

#
public int Dimensionality { get; }
Gets the dimensionality of this object instance.
Implements: Dimensionality

IsInfinite

#
public bool IsInfinite { get; }
Gets whether this box is infinite. An infinite box must contain at least one infinite coordinate.

IsSingleton

#
public bool IsSingleton { get; }
Gets whether this box occupies only a single point in space. Infinite and None boxes can never be singletons.

IsUnset

#
public bool IsUnset { get; }
Gets whether this box is unset. A box which contains at least one NaN value is considered unset.

LongestEdge

#
public double LongestEdge { get; }
Gets the length of the shortest edge of this box.

Max

#
public PointN Max { get; }
Gets the maximum point.

Min

#
public PointN Min { get; }
Gets the minimum point.

ShortestEdge

#
public double ShortestEdge { get; }
Gets the length of the shortest edge of this box.

Volume

#
public double Volume { get; }
Gets the volume of this box.

Methods

ClosestPointIn

#
public PointN ClosestPointIn(PointN point)
Gets the point in the volume of this box which is closest to a point.
Parameters:
point (PointN)Point.
Returns: Point in this box closest to given point.

ClosestPointOn

#
public PointN ClosestPointOn(PointN point)
Gets the point on the boundary of this box which is closest to a point.
Parameters:
point (PointN)Point.
Returns: Point on this box closest to given point.

CompareTo

#
public int CompareTo(BoxN other)
Compare two PointNs for sort order.
Parameters:
other (BoxN)

Contains

#
public bool Contains(BoxN box)
Test whether this box contains another box. Note that two unset boxes are considered to contain each other.
Parameters:
box (BoxN)Box to test for.
Returns: True if point is on or in this box.

Contains

#
public bool Contains(PointN point)
Test whether this box contains a point.
Parameters:
point (PointN)Point to test for.
Returns: True if point is on or in this box.

CreateInfinite

#
public static BoxN CreateInfinite(int dimensionality)
Create an infinite box.
Parameters:
dimensionality (int)Dimensionality of box.

CreateOrigin

#
public static BoxN CreateOrigin(int dimensionality)
Create an empty box at the origin.
Parameters:
dimensionality (int)Dimensionality of box.
Returns: Origin box.

CreateUnit

#
public static BoxN CreateUnit(int dimensionality)
Create a unit box at the origin.
Parameters:
dimensionality (int)Dimensionality of box.
Returns: Unit box.

CreateUnset

#
public static BoxN CreateUnset(int dimensionality)
Create an unset box.
Parameters:
dimensionality (int)Dimensionality of box.

Equals

#
public bool Equals(BoxN other)
Compare two BoxNs for equality.
Parameters:
other (BoxN)

Equals

#
public override bool Equals(object obj)
Indicates whether this instance and a specified object are equal.
Parameters:
obj (object)The object to compare with the current instance.
Returns: true if obj and this instance are the same type and represent the same value; otherwise, false.
Overrides: ValueType.Equals

FurthestPointOn

#
public PointN FurthestPointOn(PointN point)
Gets the point on the boundary of this box which is furthest from another point.
Parameters:
point (PointN)Point.
Returns: Point on this box furthest from the given point.

GetHashCode

#
public override int GetHashCode()
Returns the hash code for this instance.
Returns: A 32-bit signed integer that is the hash code for this instance.
Overrides: ValueType.GetHashCode

Grow

#
public BoxN Grow(BoxN box)
Grow this box to include another box.
Parameters:
box (BoxN)Box to include.
Returns: Box which includes both this box and the supplied box.

Grow

#
public BoxN Grow(PointN point)
Grow this box to include a new point.
Parameters:
point (PointN)Point to include.
Returns: Box which includes both this box and the point.

Intersection

#
public static BoxN Intersection(BoxN a, BoxN b)
Compute the intersection of two boxes.
Parameters:
a (BoxN)First box.
b (BoxN)Second box.
Returns: Box which covers the area shared amongst both inputs, or an unset box.

Intersects

#
public bool Intersects(BoxN box)
Test whether this box intersects with another box. Boxes are considered to intersect even if one of them entirely contains the other.
Parameters:
box (BoxN)Other box.
Returns: True if both boxes intersect.

PointAt

#
public PointN PointAt(double[] parameters)
Evaluate the box at the specified parameters.
Parameters:
parameters (double[])Normalised parameters to evaluate.
Returns: Point at parameters.

RandomPointIn

#
public PointN RandomPointIn(Random random)
Create a random point inside this box.
Parameters:
random (Random)Random generator.
Returns: Random point in box.

Split

#
public void Split(int axis, double value, out BoxN left, out BoxN right)
split this box into two sub-boxes.
Parameters:
axis (int)Dimension index to split.
value (double)Value to split at.
left (out BoxN)Input hand box.
right (out BoxN)Right hand box.

ToString

#
public override string ToString()
Returns the fully qualified type name of this instance.
Overrides: ValueType.ToString

Union

#
public static BoxN Union(BoxN a, BoxN b)
Compute the union of two boxes.
Parameters:
a (BoxN)First box.
b (BoxN)Second box.
Returns: Box which covers the area covered by both inputs.