[This is preliminary documentation and is subject to change.]
Defines a 3D bounding box, in integer cartesian coordinates.
Coordinates are always inclusive, so note that even a bounding box with coinciding vertices is a 1x1x1 cube,
and has non-zero volume and non-zero dimensions.
Namespace: fCraftAssembly: fCraft (in fCraft.dll) Version: 0.6.3.2 (0.6.3.2)
Syntax
| C# |
public sealed class BoundingBox : IEquatable<BoundingBox>
Members
| All Members | Constructors | Fields | Properties | Methods |
| Member | Description | |
|---|---|---|
| BoundingBox(XElement) | Initializes a new instance of the BoundingBox class | |
| BoundingBox(Vector3I, Vector3I) | Constructs a bounding box using two vectors as opposite corners. | |
| BoundingBox(Vector3I, Int32, Int32, Int32) | Constructs a bounding box at a given origin, with given dimensions. | |
| BoundingBox(Int32, Int32, Int32, Int32, Int32, Int32) | Constructs a bounding box between two given coordinates. | |
| Contains(BoundingBox) | Checks if another bounding box is wholly contained inside this one. | |
| Contains(Vector3I) | Checks if a given point is inside this bounding box. | |
| Contains(Int32, Int32, Int32) | Checks if a given point is inside this bounding box. | |
| Dimensions | Gets a vector of the box's dimensions: (width,length,height) - that's (x,y,z).
Guaranteed to be non-zero in every direction. | |
| Empty | Empty BoundingBox (1x1x1). | |
| Equals(Object) | (Inherited from Object.) | |
| Equals(BoundingBox) | ||
| Finalize()()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) | |
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
| GetIntersection(BoundingBox) | Returns a BoundingBox object that describes the space shared between this and another box. | |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) | |
| Height | Width of the bounding box (ZMax - ZMin + 1). Notch's Y. Inclusive, and always at least 1. | |
| Insersects(BoundingBox) | Checks whether this bounding box intersects/touches another one. | |
| Length | Width of the bounding box (YMax - YMin + 1). Notch's Z. Inclusive, and always at least 1. | |
| MaxVertex | Returns the vertex farthest from the origin, opposite MinVertex. | |
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
| MinVertex | Returns the vertex closest to the coordinate origin, opposite MaxVertex. | |
| Serialize()()()() | ||
| Serialize(String) | ||
| ToString()()()() | (Overrides Object..::..ToString()()()().) | |
| Volume | Returns volume of this bounding box. Guaranteed to be at least 1. | |
| Width | Width of the bounding box (XMax - XMin + 1). Inclusive, and always at least 1. | |
| XMax | ||
| XMin | ||
| XmlRootElementName | ||
| YMax | ||
| YMin | ||
| ZMax | ||
| ZMin |