BBox (Euclid)

BBox Type

Namespace: Euclid
Assembly: Euclid.dll
Base Type: ValueType
Kind: Struct

A struct of 6 floats representing an immutable 3D bounding box. This implementation guarantees the box to always be valid. That means the Min X, Y, and Z values are always smaller or equal to the respective Max values. The X, Y, and Z axes are also called Width, Depth, and Height3D.

   Z-Axis       Y-Axis
   ^           /
   |   7      /        6 MaxPt
   |   +---------------+
   |  /|    /         /|
   | / |   /         / |
 4 |/  |  /       5 /  |
   +---------------+   |
   |   |/          |   |
   |   +-----------|---+
   |  / 3          |  / 2
   | /             | /
   |/              |/
   +---------------+----> X-Axis
   0 MinPt         1

Record fields

Record Field	Description
`MaxX` Full Usage: `MaxX` Field type: `float`	The fields holding the maximum X value of this 3D bounding box. Field type: `float`
`MaxY` Full Usage: `MaxY` Field type: `float`	The fields holding the maximum Y value of this 3D bounding box. Field type: `float`
`MaxZ` Full Usage: `MaxZ` Field type: `float`	The fields holding the maximum Z value of this 3D bounding box. Field type: `float`
`MinX` Full Usage: `MinX` Field type: `float`	The fields holding the minimum X value of this 3D bounding box. Field type: `float`
`MinY` Full Usage: `MinY` Field type: `float`	The fields holding the minimum Y value of this 3D bounding box. Field type: `float`
`MinZ` Full Usage: `MinZ` Field type: `float`	The fields holding the minimum Z value of this 3D bounding box. Field type: `float`

Instance members

Instance member	Description
`this.AsBRect` Full Usage: `this.AsBRect` Returns: `BRect` Modifiers: inline	Returns the 2D part of this 3D bounding box as a bounding rectangle (BRect). Returns: `BRect`
`this.AsFSharpCode` Full Usage: `this.AsFSharpCode` Returns: `string`	Format bounding box into an F# code string that can be used to recreate the bounding box. Returns: `string`
`this.AsString` Full Usage: `this.AsString` Returns: `string`	Format bounding box into string with nice floating point number formatting of size and position. But without full type name as in bbox.ToString() Returns: `string`
`this.BottomPoints` Full Usage: `this.BottomPoints` Returns: `Pnt[]`	Returns the bottom of the box as a Counter-Clockwise array of 4 Points. Starting at MinPt. Points 0, 1, 2, and 3. Last and first point are NOT the same. `Z-Axis Y-Axis ^ / \| 7 / 6 MaxPt \| +---------------+ \| /\| / /\| \| / \| / / \| 4 \|/ \| / 5 / \| +---------------+ \| \| \|/ \| \| \| +-----------\|---+ \| / 3 \| / 2 \| / \| / \|/ \|/ +---------------+----> X-Axis 0 MinPt 1` Returns: `Pnt[]`
`this.BottomPointsLooped` Full Usage: `this.BottomPointsLooped` Returns: `Pnt[]`	Returns the bottom of the box as a Counter-Clockwise array of 5 Points, starting at MinPt. Points 0, 1, 2, 3, and again 0. Last and first point are the same. `Z-Axis Y-Axis ^ / \| 7 / 6 MaxPt \| +---------------+ \| /\| / /\| \| / \| / / \| 4 \|/ \| / 5 / \| +---------------+ \| \| \|/ \| \| \| +-----------\|---+ \| / 3 \| / 2 \| / \| / \|/ \|/ +---------------+----> X-Axis 0 MinPt 1` Returns: `Pnt[]`
`this.Center` Full Usage: `this.Center` Returns: `Pnt` Modifiers: inline	The center of this 3D bounding box. Returns: `Pnt`
`this.Contains` Full Usage: `this.Contains` Parameters: o : `BBox` Returns: `bool` Modifiers: inline	Returns TRUE if this 3D bounding box is inside or exactly on the other bounding Box. o : `BBox` Returns: `bool`
`this.ContainsPnt` Full Usage: `this.ContainsPnt` Parameters: p : `Pnt` Returns: `bool` Modifiers: inline	Returns TRUE if the point is inside or exactly on the bounding Box. p : `Pnt` Returns: `bool`
`this.ContainsXYZ` Full Usage: `this.ContainsXYZ` Parameters: x : `float` y : `float` z : `float` Returns: `bool` Modifiers: inline	Returns TRUE if the point is inside or exactly on the bounding Box. x : `float` y : `float` z : `float` Returns: `bool`
`this.CountZeroSides` Full Usage: `this.CountZeroSides` Returns: `int` Modifiers: inline	Counts the amount of sides that are smaller than the zeroLength tolerance. This is 0, 1, 2 or 3. Returns: `int`
`this.Diagonal` Full Usage: `this.Diagonal` Returns: `Vec` Modifiers: inline	The diagonal 3D vector of this 3D bounding box. From MinPnt to MaxPnt. Returns: `Vec`
`this.Edge01` Full Usage: `this.Edge01` Returns: `Line3D` Modifiers: inline	Returns the X-aligned edge from point 0 to 1. Returns: `Line3D`
`this.Edge03` Full Usage: `this.Edge03` Returns: `Line3D` Modifiers: inline	Returns the Y-aligned edge from point 0 to 3. Returns: `Line3D`
`this.Edge04` Full Usage: `this.Edge04` Returns: `Line3D` Modifiers: inline	Returns the Z-aligned edge from point 0 to 4. Returns: `Line3D`
`this.Edge12` Full Usage: `this.Edge12` Returns: `Line3D` Modifiers: inline	Returns the Y-aligned edge from point 1 to 2. Returns: `Line3D`
`this.Edge15` Full Usage: `this.Edge15` Returns: `Line3D` Modifiers: inline	Returns the Z-aligned edge from point 1 to 5. Returns: `Line3D`
`this.Edge26` Full Usage: `this.Edge26` Returns: `Line3D` Modifiers: inline	Returns the Z-aligned edge from point 2 to 6. Returns: `Line3D`
`this.Edge32` Full Usage: `this.Edge32` Returns: `Line3D` Modifiers: inline	Returns the X-aligned edge from point 3 to 2. Returns: `Line3D`
`this.Edge37` Full Usage: `this.Edge37` Returns: `Line3D` Modifiers: inline	Returns the Z-aligned edge from point 3 to 7. Returns: `Line3D`
`this.Edge45` Full Usage: `this.Edge45` Returns: `Line3D` Modifiers: inline	Returns the X-aligned edge from point 4 to 5. Returns: `Line3D`
`this.Edge47` Full Usage: `this.Edge47` Returns: `Line3D` Modifiers: inline	Returns the Y-aligned edge from point 4 to 7. Returns: `Line3D`
`this.Edge56` Full Usage: `this.Edge56` Returns: `Line3D` Modifiers: inline	Returns the Y-aligned edge from point 5 to 6. Returns: `Line3D`
`this.Edge76` Full Usage: `this.Edge76` Returns: `Line3D` Modifiers: inline	Returns the X-aligned edge from point 7 to 6. Returns: `Line3D`
`this.Edges` Full Usage: `this.Edges` Returns: `Line3D[]`	Returns the 12 edges of this 3D bounding box as an array of 12 Lines. Pairs in this order: 0-1, 1-2, 3-2, 0-3, 0-4, 1-5, 2-6, 3-7, 4-5, 5-6, 7-6, 4-7 `Z-Axis Y-Axis ^ / \| 7 / 6 MaxPt \| +---------------+ \| /\| / /\| \| / \| / / \| 4 \|/ \| / 5 / \| +---------------+ \| \| \|/ \| \| \| +-----------\|---+ \| / 3 \| / 2 \| / \| / \|/ \|/ +---------------+----> X-Axis 0 MinPt 1` Returns: `Line3D[]`
`this.EvaluateAt` Full Usage: `this.EvaluateAt` Parameters: xParameter : `float` yParameter : `float` zParameter : `float` Returns: `Pnt` Modifiers: inline	Evaluate a X, Y and Z parameter of this 3D bounding box. 0.0, 0.0, 0.0 returns the MinPnt. 1.0, 1.0, 1.0 returns the MaxPnt. xParameter : `float` yParameter : `float` zParameter : `float` Returns: `Pnt`
`this.Expand` Full Usage: `this.Expand` Parameters: xDist : `float` yDist : `float` zDist : `float` Returns: `BBox` Modifiers: inline	Returns a 3D bounding box expanded by a distance for X, Y, and Z-axis each. Does check for underflow if distance is negative and raises EuclidException. xDist : `float` yDist : `float` zDist : `float` Returns: `BBox`
`this.Expand` Full Usage: `this.Expand` Parameters: dist : `float` Returns: `BBox` Modifiers: inline	Returns a 3D bounding box expanded by distance. Does check for underflow if distance is negative and raises EuclidException. dist : `float` Returns: `BBox`
`this.ExpandSafe` Full Usage: `this.ExpandSafe` Parameters: dist : `float` Returns: `BBox` Modifiers: inline	Returns a 3D bounding box expanded by a distance. If expansion is negative it shrinks the Box without causing underflow. When the negative expansion is bigger than the size on any axis, both Min and Max values on that axis will be set to the midpoint of their original values (the box collapses to a plane or line on that axis). dist : `float` Returns: `BBox`
`this.ExpandSafe` Full Usage: `this.ExpandSafe` Parameters: xDist : `float` yDist : `float` zDist : `float` Returns: `BBox` Modifiers: inline	Returns a 3D bounding box expanded by a distance for X, Y, and Z-axis each. If expansion is negative it shrinks the Box without causing underflow. When the negative expansion is bigger than the size on any axis, both Min and Max values on that axis will be set to the midpoint of their original values (the box collapses to a plane or line on that axis). xDist : `float` yDist : `float` zDist : `float` Returns: `BBox`
`this.ExpandXaxis` Full Usage: `this.ExpandXaxis` Parameters: startDist : `float` endDist : `float` Returns: `BBox` Modifiers: inline	Returns a 3D bounding box expanded only in X direction by different distances for start(minX) and end (maxX). Does check for underflow if distance is negative and raises EuclidException. startDist : `float` endDist : `float` Returns: `BBox`
`this.ExpandYaxis` Full Usage: `this.ExpandYaxis` Parameters: startDist : `float` endDist : `float` Returns: `BBox` Modifiers: inline	Returns a 3D bounding box expanded only in Y direction by different distances for start(minY) and end (maxY). Does check for underflow if distance is negative and raises EuclidException. startDist : `float` endDist : `float` Returns: `BBox`
`this.ExpandZaxis` Full Usage: `this.ExpandZaxis` Parameters: startDist : `float` endDist : `float` Returns: `BBox` Modifiers: inline	Returns a 3D bounding box expanded only in Z direction by different distances for start(minZ) and end (maxZ). Does check for underflow if distance is negative and raises EuclidException. startDist : `float` endDist : `float` Returns: `BBox`
`this.HasVolume` Full Usage: `this.HasVolume` Returns: `bool` Modifiers: inline	Tests if none of the X, Y and Z axis is smaller than the zeroLength tolerance. Same as .IsValid Returns: `bool`
`this.Intersection` Full Usage: `this.Intersection` Parameters: a : `BBox` Returns: `BBox voption` Modifiers: inline	Returns the intersection of two 3D bounding boxes. The returned BBox is the volume that is inside both input 3D bounding boxes. Returns ValueNone if the two 3D bounding boxes do not overlap. Just touching 3D bounding boxes will return ValueSome with a zero volume collapsed BBox. a : `BBox` Returns: `BBox voption`
`this.IsFlat` Full Usage: `this.IsFlat` Returns: `bool` Modifiers: inline	Tests if one of the X, Y and Z axis is smaller than the zeroLength tolerance. Returns: `bool`
`this.IsLine` Full Usage: `this.IsLine` Returns: `bool` Modifiers: inline	Tests if two of the X, Y and Z axis is smaller than the zeroLength tolerance. Returns: `bool`
`this.IsOverlapping` Full Usage: `this.IsOverlapping` Parameters: a : `BBox` Returns: `bool` Modifiers: inline	Returns TRUE if the two 3D bounding boxes do overlap or touch exactly. Also returns TRUE if one box is completely inside the other. Also returns TRUE if one box is completely surrounding the other. Use .IsOverlappingOrClose if you want to specify a tolerance for near misses. a : `BBox` Returns: `bool`
`this.IsOverlappingOrClose` Full Usage: `this.IsOverlappingOrClose` Parameters: a : `BBox` tolerance : `float` Returns: `bool` Modifiers: inline	Returns TRUE if the two 3D bounding boxes do overlap or are apart less than the specified tolerance. Also returns TRUE if one box is completely inside the other. Also returns TRUE if one box is completely surrounding the other. A negative tolerance shrinks the effective boundaries instead of expanding them. a : `BBox` tolerance : `float` Returns: `bool`
`this.IsPoint` Full Usage: `this.IsPoint` Returns: `bool` Modifiers: inline	Tests if all sides are smaller than the zeroLength tolerance. This is the same as IsZero. Returns: `bool`
`this.IsTouching` Full Usage: `this.IsTouching` Parameters: other : `BBox` ?tolerance : `float` Returns: `bool` Modifiers: inline	Returns TRUE if the two 3D bounding boxes are just touching. The default tolerance is 1e-6.But can also be specified as a parameter. Returns FALSE if one box is completely inside the other. Returns FALSE if one box is completely surrounding the other. other : `BBox` ?tolerance : `float` Returns: `bool`
`this.IsValid` Full Usage: `this.IsValid` Returns: `bool` Modifiers: inline	Tests if no sides of the X, Y and Z axis is smaller than the zeroLength tolerance. Same as .HasVolume Returns: `bool`
`this.IsZero` Full Usage: `this.IsZero` Returns: `bool` Modifiers: inline	Tests if all sides are smaller than the zeroLength tolerance. This is the same as IsPoint. Returns: `bool`
`this.LongestEdge` Full Usage: `this.LongestEdge` Returns: `float` Modifiers: inline	Returns the longest edge of the Box. Returns: `float`
`this.MaxPnt` Full Usage: `this.MaxPnt` Returns: `Pnt` Modifiers: inline	The point where X, Y, and Z are the maximum values. Returns: `Pnt`
`this.MinPnt` Full Usage: `this.MinPnt` Returns: `Pnt` Modifiers: inline	The point where X, Y, and Z are the minimum values. Returns: `Pnt`
`this.Points` Full Usage: `this.Points` Returns: `Pnt[]`	Returns the bottom corners of this 3D bounding box in Counter-Clockwise order, starting at MinPt. Then the top corners starting above MinPt. Returns an array of 8 Points. `Z-Axis Y-Axis ^ / \| 7 / 6 MaxPt \| +---------------+ \| /\| / /\| \| / \| / / \| 4 \|/ \| / 5 / \| +---------------+ \| \| \|/ \| \| \| +-----------\|---+ \| / 3 \| / 2 \| / \| / \|/ \|/ +---------------+----> X-Axis 0 MinPt 1` Returns: `Pnt[]`
`this.Pt0` Full Usage: `this.Pt0` Returns: `Pnt` Modifiers: inline	Returns point 0 of this 3D bounding box, same as member box.MinPnt. `Z-Axis Y-Axis ^ / \| 7 / 6 MaxPt \| +---------------+ \| /\| / /\| \| / \| / / \| 4 \|/ \| / 5 / \| +---------------+ \| \| \|/ \| \| \| +-----------\|---+ \| / 3 \| / 2 \| / \| / \|/ \|/ +---------------+----> X-Axis 0 MinPt 1` Returns: `Pnt`
`this.Pt1` Full Usage: `this.Pt1` Returns: `Pnt` Modifiers: inline	Returns point 1 of this 3D bounding box. `Z-Axis Y-Axis ^ / \| 7 / 6 MaxPt \| +---------------+ \| /\| / /\| \| / \| / / \| 4 \|/ \| / 5 / \| +---------------+ \| \| \|/ \| \| \| +-----------\|---+ \| / 3 \| / 2 \| / \| / \|/ \|/ +---------------+----> X-Axis 0 MinPt 1` Returns: `Pnt`
`this.Pt2` Full Usage: `this.Pt2` Returns: `Pnt` Modifiers: inline	Returns point 2 of this 3D bounding box. `Z-Axis Y-Axis ^ / \| 7 / 6 MaxPt \| +---------------+ \| /\| / /\| \| / \| / / \| 4 \|/ \| / 5 / \| +---------------+ \| \| \|/ \| \| \| +-----------\|---+ \| / 3 \| / 2 \| / \| / \|/ \|/ +---------------+----> X-Axis 0 MinPt 1` Returns: `Pnt`
`this.Pt3` Full Usage: `this.Pt3` Returns: `Pnt` Modifiers: inline	Returns point 3 of this 3D bounding box. `Z-Axis Y-Axis ^ / \| 7 / 6 MaxPt \| +---------------+ \| /\| / /\| \| / \| / / \| 4 \|/ \| / 5 / \| +---------------+ \| \| \|/ \| \| \| +-----------\|---+ \| / 3 \| / 2 \| / \| / \|/ \|/ +---------------+----> X-Axis 0 MinPt 1` Returns: `Pnt`
`this.Pt4` Full Usage: `this.Pt4` Returns: `Pnt` Modifiers: inline	Returns point 4 of this 3D bounding box. `Z-Axis Y-Axis ^ / \| 7 / 6 MaxPt \| +---------------+ \| /\| / /\| \| / \| / / \| 4 \|/ \| / 5 / \| +---------------+ \| \| \|/ \| \| \| +-----------\|---+ \| / 3 \| / 2 \| / \| / \|/ \|/ +---------------+----> X-Axis 0 MinPt 1` Returns: `Pnt`
`this.Pt5` Full Usage: `this.Pt5` Returns: `Pnt` Modifiers: inline	Returns point 5 of this 3D bounding box. `Z-Axis Y-Axis ^ / \| 7 / 6 MaxPt \| +---------------+ \| /\| / /\| \| / \| / / \| 4 \|/ \| / 5 / \| +---------------+ \| \| \|/ \| \| \| +-----------\|---+ \| / 3 \| / 2 \| / \| / \|/ \|/ +---------------+----> X-Axis 0 MinPt 1` Returns: `Pnt`
`this.Pt6` Full Usage: `this.Pt6` Returns: `Pnt` Modifiers: inline	Returns point 6 of this 3D bounding box. `Z-Axis Y-Axis ^ / \| 7 / 6 MaxPt \| +---------------+ \| /\| / /\| \| / \| / / \| 4 \|/ \| / 5 / \| +---------------+ \| \| \|/ \| \| \| +-----------\|---+ \| / 3 \| / 2 \| / \| / \|/ \|/ +---------------+----> X-Axis 0 MinPt 1` Returns: `Pnt`
`this.Pt7` Full Usage: `this.Pt7` Returns: `Pnt` Modifiers: inline	Returns point 7 of this 3D bounding box. `Z-Axis Y-Axis ^ / \| 7 / 6 MaxPt \| +---------------+ \| /\| / /\| \| / \| / / \| 4 \|/ \| / 5 / \| +---------------+ \| \| \|/ \| \| \| +-----------\|---+ \| / 3 \| / 2 \| / \| / \|/ \|/ +---------------+----> X-Axis 0 MinPt 1` Returns: `Pnt`
`this.ShortestEdge` Full Usage: `this.ShortestEdge` Returns: `float` Modifiers: inline	Returns the shortest edge of the Box. Returns: `float`
`this.SizeX` Full Usage: `this.SizeX` Returns: `float` Modifiers: inline	The size in X direction, often also called Width. Returns: `float`
`this.SizeY` Full Usage: `this.SizeY` Returns: `float` Modifiers: inline	The size in Y direction. Returns: `float`
`this.SizeZ` Full Usage: `this.SizeZ` Returns: `float` Modifiers: inline	The size in Z direction, also called Height. Returns: `float`
`this.TopPoints` Full Usage: `this.TopPoints` Returns: `Pnt[]`	Returns the top of the box as a Counter-Clockwise array of 4 Points. Starting at point 4 then 5, 6, and 7. Last and first point are NOT the same. `Z-Axis Y-Axis ^ / \| 7 / 6 MaxPt \| +---------------+ \| /\| / /\| \| / \| / / \| 4 \|/ \| / 5 / \| +---------------+ \| \| \|/ \| \| \| +-----------\|---+ \| / 3 \| / 2 \| / \| / \|/ \|/ +---------------+----> X-Axis 0 MinPt 1` Returns: `Pnt[]`
`this.TopPointsLooped` Full Usage: `this.TopPointsLooped` Returns: `Pnt[]`	Returns the top of the box as a Counter-Clockwise array of 5 Points. Points 4, 5, 6, 7, and again 4. Last and first point are the same. `Z-Axis Y-Axis ^ / \| 7 / 6 MaxPt \| +---------------+ \| /\| / /\| \| / \| / / \| 4 \|/ \| / 5 / \| +---------------+ \| \| \|/ \| \| \| +-----------\|---+ \| / 3 \| / 2 \| / \| / \|/ \|/ +---------------+----> X-Axis 0 MinPt 1` Returns: `Pnt[]`
`this.TouchingSide` Full Usage: `this.TouchingSide` Parameters: other : `BBox` ?tolerance : `float` Returns: `int` Modifiers: inline	Returns a value from -1 to 6 indicating the side on which the two 3D bounding boxes are just touching within the tolerance. The default tolerance is 1e-6.But can also be specified as a parameter. -1 : not touching but overlapping / one inside the other 0 : not touching, apart on at least one axis by more than tolerance 1 : other is in front of this (this.MinX touches other.MaxX) 2 : other is behind this (this.MaxX touches other.MinX) 3 : other is to the left of this (this.MinY touches other.MaxY) 4 : other is to the right of this (this.MaxY touches other.MinY) 5 : this.MinZ touches other.MaxZ 6 : this.MaxZ touches other.MinZ other : `BBox` ?tolerance : `float` Returns: `int`
`this.Union` Full Usage: `this.Union` Parameters: p : `Pnt` Returns: `BBox` Modifiers: inline	Returns a bounding 3D bounding box that contains the input 3D bounding box and the point. p : `Pnt` Returns: `BBox`
`this.Union` Full Usage: `this.Union` Parameters: a : `BBox` Returns: `BBox` Modifiers: inline	Returns a 3D bounding box that contains both input 3D bounding boxes. a : `BBox` Returns: `BBox`
`this.Volume` Full Usage: `this.Volume` Returns: `float` Modifiers: inline	Returns the volume of this 3D bounding box. Returns: `float`

Static members

Static member	Description
`BBox.asBRect b` Full Usage: `BBox.asBRect b` Parameters: b : `BBox` Returns: `BRect` Modifiers: inline	Returns the 2D part of a 3D bounding box as a bounding rectangle (BRect). Projects the BBox onto the XY plane, discarding Z information. b : `BBox` Returns: `BRect`
`BBox.asFSharpCode b` Full Usage: `BBox.asFSharpCode b` Parameters: b : `BBox` Returns: `string` Modifiers: inline	Returns an F# code string that recreates the 3D bounding box. b : `BBox` Returns: `string`
`BBox.asString b` Full Usage: `BBox.asString b` Parameters: b : `BBox` Returns: `string` Modifiers: inline	Returns a concise formatted string representation of the 3D bounding box. b : `BBox` Returns: `string`
`BBox.bottomPoints b` Full Usage: `BBox.bottomPoints b` Parameters: b : `BBox` Returns: `Pnt[]` Modifiers: inline	Returns the 4 bottom face points of the 3D bounding box. b : `BBox` Returns: `Pnt[]`
`BBox.bottomPointsLooped b` Full Usage: `BBox.bottomPointsLooped b` Parameters: b : `BBox` Returns: `Pnt[]` Modifiers: inline	Returns the looped 5-point bottom face polyline of the 3D bounding box. b : `BBox` Returns: `Pnt[]`
`BBox.center b` Full Usage: `BBox.center b` Parameters: b : `BBox` Returns: `Pnt` Modifiers: inline	Returns the center point of the 3D bounding box. b : `BBox` Returns: `Pnt`
`BBox.contains boxInside surroundingBox` Full Usage: `BBox.contains boxInside surroundingBox` Parameters: boxInside : `BBox` surroundingBox : `BBox` Returns: `bool` Modifiers: inline	Returns TRUE if a 3D bounding box is inside or exactly on the other bounding Box. Argument order matters! boxInside : `BBox` surroundingBox : `BBox` Returns: `bool`
`BBox.containsPnt pt box` Full Usage: `BBox.containsPnt pt box` Parameters: pt : `Pnt` box : `BBox` Returns: `bool` Modifiers: inline	Returns TRUE if the point is inside or on a 3D bounding box. pt : `Pnt` box : `BBox` Returns: `bool`
`BBox.containsXYZ x y z box` Full Usage: `BBox.containsXYZ x y z box` Parameters: x : `float` y : `float` z : `float` box : `BBox` Returns: `bool` Modifiers: inline	Returns TRUE if the point is inside or on a 3D bounding box. x : `float` y : `float` z : `float` box : `BBox` Returns: `bool`
`BBox.countZeroSides b` Full Usage: `BBox.countZeroSides b` Parameters: b : `BBox` Returns: `int` Modifiers: inline	Returns the amount of dimensions that are below zero-length tolerance. b : `BBox` Returns: `int`
`BBox.create (a, b)` Full Usage: `BBox.create (a, b)` Parameters: a : `Pnt` b : `Pnt` Returns: `BBox` Modifiers: inline	Creates a 3D bounding box from two points. Automatically determines min and max values for each axis, so the points can be provided in any order. a : `Pnt` b : `Pnt` Returns: `BBox`
`BBox.createFromBRect minZ maxZ r` Full Usage: `BBox.createFromBRect minZ maxZ r` Parameters: minZ : `float` maxZ : `float` r : `BRect` Returns: `BBox`	Creates a 3D bounding box from a 2D bounding rectangle (BRect) and Z-axis bounds. The BRect defines the X and Y extents, while minZ and maxZ define the Z extent. minZ : `float` maxZ : `float` r : `BRect` Returns: `BBox`
`BBox.createFromCenter (center, sizeX, sizeY, sizeZ)` Full Usage: `BBox.createFromCenter (center, sizeX, sizeY, sizeZ)` Parameters: center : `Pnt` sizeX : `float` sizeY : `float` sizeZ : `float` Returns: `BBox`	Creates a 3D bounding box from a center point and the total X, Y and Z size. center : `Pnt` sizeX : `float` sizeY : `float` sizeZ : `float` Returns: `BBox`
`BBox.createFromIList ps` Full Usage: `BBox.createFromIList ps` Parameters: ps : `IList<Pnt>` Returns: `BBox`	Finds min and max values for x, y and z. Creates a 3D bounding box from the points. ps : `IList<Pnt>` Returns: `BBox`
`BBox.createFromLine l` Full Usage: `BBox.createFromLine l` Parameters: l : `Line3D` Returns: `BBox` Modifiers: inline	Creates a 3D bounding box from a 3D line. The bounding box will be the minimal box containing the line's start and end points. l : `Line3D` Returns: `BBox`
`BBox.createFromSeq ps` Full Usage: `BBox.createFromSeq ps` Parameters: ps : `Pnt seq` Returns: `BBox`	Finds min and max values for x, y and z. Creates a 3D bounding box from the points. ps : `Pnt seq` Returns: `BBox`
`BBox.createUnchecked (minX, minY, minZ, maxX, maxY, maxZ)` Full Usage: `BBox.createUnchecked (minX, minY, minZ, maxX, maxY, maxZ)` Parameters: minX : `float` minY : `float` minZ : `float` maxX : `float` maxY : `float` maxZ : `float` Returns: `BBox` Modifiers: inline	Creates a 3D bounding box from six coordinate values. Does not verify that min values are less than or equal to max values. minX : `float` minY : `float` minZ : `float` maxX : `float` maxY : `float` maxZ : `float` Returns: `BBox`
`BBox.diagonal b` Full Usage: `BBox.diagonal b` Parameters: b : `BBox` Returns: `Vec` Modifiers: inline	Returns the diagonal vector from MinPnt to MaxPnt. b : `BBox` Returns: `Vec`
`BBox.edge01 b` Full Usage: `BBox.edge01 b` Parameters: b : `BBox` Returns: `Line3D` Modifiers: inline	Returns edge 0-1 of the 3D bounding box. b : `BBox` Returns: `Line3D`
`BBox.edge03 b` Full Usage: `BBox.edge03 b` Parameters: b : `BBox` Returns: `Line3D` Modifiers: inline	Returns edge 0-3 of the 3D bounding box. b : `BBox` Returns: `Line3D`
`BBox.edge04 b` Full Usage: `BBox.edge04 b` Parameters: b : `BBox` Returns: `Line3D` Modifiers: inline	Returns edge 0-4 of the 3D bounding box. b : `BBox` Returns: `Line3D`
`BBox.edge12 b` Full Usage: `BBox.edge12 b` Parameters: b : `BBox` Returns: `Line3D` Modifiers: inline	Returns edge 1-2 of the 3D bounding box. b : `BBox` Returns: `Line3D`
`BBox.edge15 b` Full Usage: `BBox.edge15 b` Parameters: b : `BBox` Returns: `Line3D` Modifiers: inline	Returns edge 1-5 of the 3D bounding box. b : `BBox` Returns: `Line3D`
`BBox.edge26 b` Full Usage: `BBox.edge26 b` Parameters: b : `BBox` Returns: `Line3D` Modifiers: inline	Returns edge 2-6 of the 3D bounding box. b : `BBox` Returns: `Line3D`
`BBox.edge32 b` Full Usage: `BBox.edge32 b` Parameters: b : `BBox` Returns: `Line3D` Modifiers: inline	Returns edge 3-2 of the 3D bounding box. b : `BBox` Returns: `Line3D`
`BBox.edge37 b` Full Usage: `BBox.edge37 b` Parameters: b : `BBox` Returns: `Line3D` Modifiers: inline	Returns edge 3-7 of the 3D bounding box. b : `BBox` Returns: `Line3D`
`BBox.edge45 b` Full Usage: `BBox.edge45 b` Parameters: b : `BBox` Returns: `Line3D` Modifiers: inline	Returns edge 4-5 of the 3D bounding box. b : `BBox` Returns: `Line3D`
`BBox.edge47 b` Full Usage: `BBox.edge47 b` Parameters: b : `BBox` Returns: `Line3D` Modifiers: inline	Returns edge 4-7 of the 3D bounding box. b : `BBox` Returns: `Line3D`
`BBox.edge56 b` Full Usage: `BBox.edge56 b` Parameters: b : `BBox` Returns: `Line3D` Modifiers: inline	Returns edge 5-6 of the 3D bounding box. b : `BBox` Returns: `Line3D`
`BBox.edge76 b` Full Usage: `BBox.edge76 b` Parameters: b : `BBox` Returns: `Line3D` Modifiers: inline	Returns edge 7-6 of the 3D bounding box. b : `BBox` Returns: `Line3D`
`BBox.edges b` Full Usage: `BBox.edges b` Parameters: b : `BBox` Returns: `Line3D[]` Modifiers: inline	Returns all 12 edges of the 3D bounding box. b : `BBox` Returns: `Line3D[]`
`BBox.equals tol a b` Full Usage: `BBox.equals tol a b` Parameters: tol : `float` a : `BBox` b : `BBox` Returns: `bool`	Checks if two 3D bounding boxes are equal within tolerance. Use a tolerance of 0.0 to check for an exact match. tol : `float` a : `BBox` b : `BBox` Returns: `bool`
`BBox.evaluateAt xParameter yParameter zParameter b` Full Usage: `BBox.evaluateAt xParameter yParameter zParameter b` Parameters: xParameter : `float` yParameter : `float` zParameter : `float` b : `BBox` Returns: `Pnt` Modifiers: inline	Evaluates X, Y and Z parameters on the 3D bounding box and returns a point. xParameter : `float` yParameter : `float` zParameter : `float` b : `BBox` Returns: `Pnt`
`BBox.expand dist b` Full Usage: `BBox.expand dist b` Parameters: dist : `float` b : `BBox` Returns: `BBox`	Returns a 3D bounding box expanded by distance. Does check for underflow if distance is negative and raises EuclidException. dist : `float` b : `BBox` Returns: `BBox`
`BBox.expandRel factor b` Full Usage: `BBox.expandRel factor b` Parameters: factor : `float` b : `BBox` Returns: `BBox`	Returns the 3D bounding box expanded by a relative factor on all six sides. Values between 0.0 and 1.0 shrink the box. Values larger than 1.0 expand the box. Does check for underflow if factor is negative and raises EuclidException. factor : `float` b : `BBox` Returns: `BBox`
`BBox.expandRelXYZ factorX factorY factorZ b` Full Usage: `BBox.expandRelXYZ factorX factorY factorZ b` Parameters: factorX : `float` factorY : `float` factorZ : `float` b : `BBox` Returns: `BBox`	Returns the 3D bounding box expanded by a relative factor on all six sides, separately for X, Y, Z. Values between 0.0 and 1.0 shrink the box. Values larger than 1.0 expand the box. Does check for underflow if any factor is negative and raises EuclidException. factorX : `float` factorY : `float` factorZ : `float` b : `BBox` Returns: `BBox`
`BBox.expandSafe dist b` Full Usage: `BBox.expandSafe dist b` Parameters: dist : `float` b : `BBox` Returns: `BBox`	Returns a 3D bounding box expanded by distance. If expansion is negative it shrinks the Box without causing underflow. When the negative expansion is bigger than the size on any axis, both Min and Max values on that axis will be set to the midpoint of their original values (the box collapses to a plane or line on that axis). dist : `float` b : `BBox` Returns: `BBox`
`BBox.expandSafeXYZ xDist yDist zDist b` Full Usage: `BBox.expandSafeXYZ xDist yDist zDist b` Parameters: xDist : `float` yDist : `float` zDist : `float` b : `BBox` Returns: `BBox` Modifiers: inline	Returns a 3D bounding box safely expanded by separate distances in X, Y and Z. xDist : `float` yDist : `float` zDist : `float` b : `BBox` Returns: `BBox`
`BBox.expandXYZ xDist yDist zDist b` Full Usage: `BBox.expandXYZ xDist yDist zDist b` Parameters: xDist : `float` yDist : `float` zDist : `float` b : `BBox` Returns: `BBox` Modifiers: inline	Returns a 3D bounding box expanded by separate distances in X, Y and Z. xDist : `float` yDist : `float` zDist : `float` b : `BBox` Returns: `BBox`
`BBox.expandXaxis startDist endDist b` Full Usage: `BBox.expandXaxis startDist endDist b` Parameters: startDist : `float` endDist : `float` b : `BBox` Returns: `BBox`	Returns a 3D bounding box expanded only in X direction by different distances for start(minX) and end (maxX). Does check for underflow if distance is negative and raises EuclidException. startDist : `float` endDist : `float` b : `BBox` Returns: `BBox`
`BBox.expandYaxis startDist endDist b` Full Usage: `BBox.expandYaxis startDist endDist b` Parameters: startDist : `float` endDist : `float` b : `BBox` Returns: `BBox`	Returns a 3D bounding box expanded only in Y direction by different distances for start(minY) and end (maxY). Does check for underflow if distance is negative and raises EuclidException. startDist : `float` endDist : `float` b : `BBox` Returns: `BBox`
`BBox.expandZaxis startDist endDist b` Full Usage: `BBox.expandZaxis startDist endDist b` Parameters: startDist : `float` endDist : `float` b : `BBox` Returns: `BBox`	Returns a 3D bounding box expanded only in Z direction by different distances for start(minZ) and end (maxZ). Does check for underflow if distance is negative and raises EuclidException. startDist : `float` endDist : `float` b : `BBox` Returns: `BBox`
`BBox.hasVolume b` Full Usage: `BBox.hasVolume b` Parameters: b : `BBox` Returns: `bool` Modifiers: inline	Returns TRUE if the 3D bounding box has volume. b : `BBox` Returns: `bool`
`BBox.intersection a b` Full Usage: `BBox.intersection a b` Parameters: a : `BBox` b : `BBox` Returns: `BBox voption` Modifiers: inline	Returns the intersection of two 3D bounding boxes. The returned BBox is the volume that is inside both input 3D bounding boxes. Returns ValueNone if the two 3D bounding boxes do not overlap. Just touching 3D bounding boxes will return ValueSome with a zero volume collapsed BBox. a : `BBox` b : `BBox` Returns: `BBox voption`
`BBox.isFlat b` Full Usage: `BBox.isFlat b` Parameters: b : `BBox` Returns: `bool` Modifiers: inline	Returns TRUE if exactly one dimension is below zero-length tolerance. b : `BBox` Returns: `bool`
`BBox.isLine b` Full Usage: `BBox.isLine b` Parameters: b : `BBox` Returns: `bool` Modifiers: inline	Returns TRUE if exactly two dimensions are below zero-length tolerance. b : `BBox` Returns: `bool`
`BBox.isOverlapping a b` Full Usage: `BBox.isOverlapping a b` Parameters: a : `BBox` b : `BBox` Returns: `bool` Modifiers: inline	Returns TRUE if the two 3D bounding boxes do overlap or touch exactly. Also returns TRUE if one box is completely inside the other. Also returns TRUE if one box is completely surrounding the other. Use BBox.isOverlappingOrClose if you want to specify a tolerance for near misses. a : `BBox` b : `BBox` Returns: `bool`
`BBox.isOverlappingOrClose tolerance a b` Full Usage: `BBox.isOverlappingOrClose tolerance a b` Parameters: tolerance : `float` a : `BBox` b : `BBox` Returns: `bool` Modifiers: inline	Returns TRUE if the two 3D bounding boxes do overlap or are apart less than the specified tolerance. Also returns TRUE if one box is completely inside the other. Also returns TRUE if one box is completely surrounding the other. A negative tolerance shrinks the effective boundaries instead of expanding them. The math works out symmetrically: tolerance : `float` a : `BBox` b : `BBox` Returns: `bool`
`BBox.isPoint b` Full Usage: `BBox.isPoint b` Parameters: b : `BBox` Returns: `bool` Modifiers: inline	Returns TRUE if all dimensions are below zero-length tolerance. b : `BBox` Returns: `bool`
`BBox.isTouching tolerance other thisBox` Full Usage: `BBox.isTouching tolerance other thisBox` Parameters: tolerance : `float` other : `BBox` thisBox : `BBox` Returns: `bool` Modifiers: inline	Returns TRUE if the two 3D bounding boxes are just touching within a given specified tolerance. Returns FALSE if one box is completely inside the other. Returns FALSE if one box is completely surrounding the other. tolerance : `float` other : `BBox` thisBox : `BBox` Returns: `bool`
`BBox.isValid b` Full Usage: `BBox.isValid b` Parameters: b : `BBox` Returns: `bool` Modifiers: inline	Returns TRUE if no dimension is below zero-length tolerance. b : `BBox` Returns: `bool`
`BBox.isZero b` Full Usage: `BBox.isZero b` Parameters: b : `BBox` Returns: `bool` Modifiers: inline	Returns TRUE if all box dimensions are below zero-length tolerance. b : `BBox` Returns: `bool`
`BBox.longestEdge b` Full Usage: `BBox.longestEdge b` Parameters: b : `BBox` Returns: `float` Modifiers: inline	Returns the longest edge length of the 3D bounding box. b : `BBox` Returns: `float`
`BBox.maxPnt b` Full Usage: `BBox.maxPnt b` Parameters: b : `BBox` Returns: `Pnt` Modifiers: inline	Returns the maximum corner point of the 3D bounding box. b : `BBox` Returns: `Pnt`
`BBox.minPnt b` Full Usage: `BBox.minPnt b` Parameters: b : `BBox` Returns: `Pnt` Modifiers: inline	Returns the minimum corner point of the 3D bounding box. b : `BBox` Returns: `Pnt`
`BBox.move v b` Full Usage: `BBox.move v b` Parameters: v : `Vec` b : `BBox` Returns: `BBox`	Returns a 3D bounding box moved by a vector. v : `Vec` b : `BBox` Returns: `BBox`
`BBox.moveX translation b` Full Usage: `BBox.moveX translation b` Parameters: translation : `float` b : `BBox` Returns: `BBox`	Returns a new 3D bounding box moved in X-axis direction. translation : `float` b : `BBox` Returns: `BBox`
`BBox.moveY translation b` Full Usage: `BBox.moveY translation b` Parameters: translation : `float` b : `BBox` Returns: `BBox`	Returns a new 3D bounding box moved in Y-axis direction. translation : `float` b : `BBox` Returns: `BBox`
`BBox.moveZ translation b` Full Usage: `BBox.moveZ translation b` Parameters: translation : `float` b : `BBox` Returns: `BBox`	Returns a new 3D bounding box moved in Z-axis direction. translation : `float` b : `BBox` Returns: `BBox`
`BBox.notEquals tol a b` Full Usage: `BBox.notEquals tol a b` Parameters: tol : `float` a : `BBox` b : `BBox` Returns: `bool`	Check if two 3D bounding boxes are not equal within a given tolerance. Use a tolerance of 0.0 to check if the two 3D bounding boxes are not exactly equal. tol : `float` a : `BBox` b : `BBox` Returns: `bool`
`BBox.points b` Full Usage: `BBox.points b` Parameters: b : `BBox` Returns: `Pnt[]` Modifiers: inline	Returns all 8 corner points of the 3D bounding box. b : `BBox` Returns: `Pnt[]`
`BBox.pt0 b` Full Usage: `BBox.pt0 b` Parameters: b : `BBox` Returns: `Pnt` Modifiers: inline	Returns corner point 0 of the 3D bounding box. b : `BBox` Returns: `Pnt`
`BBox.pt1 b` Full Usage: `BBox.pt1 b` Parameters: b : `BBox` Returns: `Pnt` Modifiers: inline	Returns corner point 1 of the 3D bounding box. b : `BBox` Returns: `Pnt`
`BBox.pt2 b` Full Usage: `BBox.pt2 b` Parameters: b : `BBox` Returns: `Pnt` Modifiers: inline	Returns corner point 2 of the 3D bounding box. b : `BBox` Returns: `Pnt`
`BBox.pt3 b` Full Usage: `BBox.pt3 b` Parameters: b : `BBox` Returns: `Pnt` Modifiers: inline	Returns corner point 3 of the 3D bounding box. b : `BBox` Returns: `Pnt`
`BBox.pt4 b` Full Usage: `BBox.pt4 b` Parameters: b : `BBox` Returns: `Pnt` Modifiers: inline	Returns corner point 4 of the 3D bounding box. b : `BBox` Returns: `Pnt`
`BBox.pt5 b` Full Usage: `BBox.pt5 b` Parameters: b : `BBox` Returns: `Pnt` Modifiers: inline	Returns corner point 5 of the 3D bounding box. b : `BBox` Returns: `Pnt`
`BBox.pt6 b` Full Usage: `BBox.pt6 b` Parameters: b : `BBox` Returns: `Pnt` Modifiers: inline	Returns corner point 6 of the 3D bounding box. b : `BBox` Returns: `Pnt`
`BBox.pt7 b` Full Usage: `BBox.pt7 b` Parameters: b : `BBox` Returns: `Pnt` Modifiers: inline	Returns corner point 7 of the 3D bounding box. b : `BBox` Returns: `Pnt`
`BBox.scale factor b` Full Usage: `BBox.scale factor b` Parameters: factor : `float` b : `BBox` Returns: `BBox` Modifiers: inline	Scales the 3D bounding box by a given factor. Scale center is World Origin 0,0,0. A negative factor will flip the box orientation, creating an invalid BBox. Use only positive factors. factor : `float` b : `BBox` Returns: `BBox`
`BBox.shortestEdge b` Full Usage: `BBox.shortestEdge b` Parameters: b : `BBox` Returns: `float` Modifiers: inline	Returns the shortest edge length of the 3D bounding box. b : `BBox` Returns: `float`
`BBox.sizeX b` Full Usage: `BBox.sizeX b` Parameters: b : `BBox` Returns: `float` Modifiers: inline	Returns the X-size (width) of the 3D bounding box. b : `BBox` Returns: `float`
`BBox.sizeY b` Full Usage: `BBox.sizeY b` Parameters: b : `BBox` Returns: `float` Modifiers: inline	Returns the Y-size (depth) of the 3D bounding box. b : `BBox` Returns: `float`
`BBox.sizeZ b` Full Usage: `BBox.sizeZ b` Parameters: b : `BBox` Returns: `float` Modifiers: inline	Returns the Z-size (height) of the 3D bounding box. b : `BBox` Returns: `float`
`BBox.toString b` Full Usage: `BBox.toString b` Parameters: b : `BBox` Returns: `string` Modifiers: inline	Returns a nicely formatted string representation of the 3D bounding box. b : `BBox` Returns: `string`
`BBox.topPoints b` Full Usage: `BBox.topPoints b` Parameters: b : `BBox` Returns: `Pnt[]` Modifiers: inline	Returns the 4 top face points of the 3D bounding box. b : `BBox` Returns: `Pnt[]`
`BBox.topPointsLooped b` Full Usage: `BBox.topPointsLooped b` Parameters: b : `BBox` Returns: `Pnt[]` Modifiers: inline	Returns the looped 5-point top face polyline of the 3D bounding box. b : `BBox` Returns: `Pnt[]`
`BBox.touchingSide tolerance other thisBox` Full Usage: `BBox.touchingSide tolerance other thisBox` Parameters: tolerance : `float` other : `BBox` thisBox : `BBox` Returns: `int` Modifiers: inline	Returns a value from -1 to 6 indicating the side on which the two 3D bounding boxes are just touching within a given specified tolerance. -1 : not touching but overlapping / one inside the other 0 : not touching, apart on at least one axis by more than tolerance 1 : other is in front of this (this.MinX touches other.MaxX) 2 : other is behind this (this.MaxX touches other.MinX) 3 : other is to the left of this (this.MinY touches other.MaxY) 4 : other is to the right of this (this.MaxY touches other.MinY) 5 : this.MinZ touches other.MaxZ 6 : this.MaxZ touches other.MinZ tolerance : `float` other : `BBox` thisBox : `BBox` Returns: `int`
`BBox.translate v b` Full Usage: `BBox.translate v b` Parameters: v : `Vec` b : `BBox` Returns: `BBox`	Returns a 3D bounding box moved by a vector. This is an alias for the 'move' function. v : `Vec` b : `BBox` Returns: `BBox`
`BBox.union a b` Full Usage: `BBox.union a b` Parameters: a : `BBox` b : `BBox` Returns: `BBox` Modifiers: inline	Returns a 3D bounding box that contains both input a 3D bounding boxes. a : `BBox` b : `BBox` Returns: `BBox`
`BBox.unionPt p b` Full Usage: `BBox.unionPt p b` Parameters: p : `Pnt` b : `BBox` Returns: `BBox` Modifiers: inline	Returns a bounding a 3D bounding box that contains the input a 3D bounding box and the point. p : `Pnt` b : `BBox` Returns: `BBox`
`BBox.volume b` Full Usage: `BBox.volume b` Parameters: b : `BBox` Returns: `float` Modifiers: inline	Returns the volume of a 3D bounding box. b : `BBox` Returns: `float`