 | |
Bounding | |
Represents an axis-aligned bounding box in three dimensional space.
Inheritance HierarchyNamespace: Ab4d.SharpEngine.Common
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 2.0.8956+4c7684e186ca1be74e7a284fbe739d9a1b843d3c
SyntaxC#
public struct BoundingBox : IEquatable<BoundingBox>, IFormattable
The BoundingBox type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BoundingBox | Initializes a new undefined BoundingBox struct. |
| BoundingBox(Vector3, Vector3) | Initializes a new BoundingBox struct. Both Minimum and Maximum set to float.NaN values. |
Properties| Name | Description | |
|---|---|---|
 | IsUndefined | Returns true when the Minimum and Maximum properties are not defined (are set to float.NaN). |
| IsZeroSize | Returns true when the size of this BoundingBox is zero. |
| SizeX | Gets size in the X direction |
| SizeY | Gets size in the Y direction |
| SizeZ | Gets size in the Z direction |
 | Undefined | Gets an undefined BoundingBox with both Minimum and Maximum set to float.NaN values. |
Methods| Name | Description | |
|---|---|---|
| Add(BoundingBox) | Adds another BoundingBox to this BoundingBox |
| Add(Vector3) | Adds one Vector3 to this bounds |
| Contains(BoundingBox) | Returns true when the specified BoundingBox is withing this BoundingBox, including its edges. |
| Contains(Vector3) | Returns true when the specified Vector3 is withing this BoundingBox, including its edges. |
| Contains(Double, Double, Double) | Returns true when specified point is within this BoundingBox, including its edges. |
| Equals(BoundingBox) | Determines whether the specified Vector4 is equal to this instance. |
| Equals(BoundingBox) | Determines whether the specified Vector4 is equal to this instance. |
| Equals(Object) |
Determines whether the specified Object is equal to this instance.
(Overrides ValueTypeEquals(Object)) |
| FromPoints(Span) | |
| FromPoints(Vector3) | Constructs a BoundingBox that fully contains the given points. |
| FromPoints(Vector3, Vector3) | Constructs a BoundingBox that fully contains the given two points. |
| FromSphere | Constructs a BoundingBox that fully contains the 3D sphere that is specified by the centerPosition and radius. |
| FromVertices | Constructs a BoundingBox that fully contains the given vertices. |
| GetCenterPosition | Returns center position of this BoundingBox. |
| GetCorners | Retrieves the eight corners of the bounding box. It is recommended to use the GetCorners(Vector3) that takes a Vector3 array to prevent allocation of new Vector3 array. |
| GetCorners(Span) | |
| GetCorners(Vector3) | Retrieves the eight corners of the bounding box and write them to the specified array of Vector3 that needs to have at least 8 elements. |
| GetDiagonalLength | Returns the length of the BoundingBox diagonal that is the same as distance from Minimum to Maximum positions. |
| GetHashCode |
Returns a hash code for this instance.
(Overrides ValueTypeGetHashCode) |
| GetSize | Returns Vector3 that represents size of the BoundingBox |
| IntersectsWith | Returns a value that indicates whether the specified BoundingBox intersects with this BoundingBox. |
| Merge(BoundingBox, BoundingBox) | Constructs a BoundingBox that is as large as the total combined area of the two specified boxes. |
| Merge(BoundingBox, BoundingBox, BoundingBox) | Obsolete. Constructs a BoundingBox that is as large as the total combined area of the two specified boxes. |
| ScaleAndTranslate(Matrix4x4) | Returns a new BoundingBox that is created by scaling and translating this BoundingBox with the specified matrix (the current BoundingBox value is not changed). To apply a generic matrix transformation use [!:TransformAllCorners(Matrix4x4)] method. |
| ScaleAndTranslate(Matrix4x4, Vector3, Vector3) | Obsolete. Sets the out minimum and maximum Vector3D with transforming the current BoundingBox's minimum and maximum value with the specified matrix (the current BoundingBox value is not changed). |
| ToString |
Returns a String that represents this instance.
(Overrides ValueTypeToString) |
| ToString(IFormatProvider) | Returns a String that represents this instance. |
| ToString(String) | Returns a String that represents this instance. |
| ToString(String, IFormatProvider) | Returns a String that represents this instance. |
| Transform(Matrix4x4) | Transforms this BoundingBox with the specified matrix. |
| Transform(Transform) | Transforms the current BoundingBox with the specified transformation |
| Transform(Matrix4x4, BoundingBox) | Transforms the current BoundingBox by the specified matrix and writes the transformed BoundingBox to the specified transformedBoundingBox. |
| Transform(Transform, BoundingBox) | Transforms the current BoundingBox by the specified transformation and writes the transformed BoundingBox to the specified transformedBoundingBox. |
| Transform(Matrix4x4, Vector3, Vector3) | Obsolete. Transforms the current BoundingBox with the specified matrix and writes the transformed minimum and maximum positions to the specified parameters. |
| Transform(Transform, Vector3, Vector3) | Transforms the current BoundingBox with the specified matrix and writes the transformed minimum and maximum positions to the specified parameters. |
| TransformAllCorners(Matrix4x4) | Returns a new BoundingBox that is created by transforming this BoundingBox bounds with the specified matrix (the current BoundingBox value is not changed). When the transformation matrix contains only translation and scale, you can use an optimized [!:ScaleAndTranslate(Matrix4x4)] method. |
| TransformAllCorners(Matrix4x4, Vector3, Vector3) | Obsolete. Sets the out minimum and maximum Vector3D with transforming the current bounds with the specified matrix (the current BoundingBox value is not changed). |
| Translate(Vector3) | Returns a new BoundingBox that is created by translating this BoundingBox with the specified translateVector (the current BoundingBox value is not changed). |
| Translate(Vector3, Vector3, Vector3) | Obsolete. Sets the out minimum and maximum Vector3D with translating the current bounds with the specified translateVector (the current BoundingBox value is not changed). |
Operators| Name | Description | |
|---|---|---|
 | Equality(BoundingBox, BoundingBox) | Tests for equality between two objects. |
| Inequality(BoundingBox, BoundingBox) | Tests for inequality between two objects. |
Fields
Extension Methods| Name | Description | |
|---|---|---|
 | ToRect3D |
Converts BoundingBox to WPF Rect3D
(Defined by Extensions) |
See Also