| FBox
|
Module |
|
Header |
/Engine/Source/Runtime/Core/Public/Math/Box.h |
Include |
#include "Math/Box.h" |
struct FBox
Implements an axis-aligned box.
Boxes describe an axis-aligned extent in three dimensions. They are used for many different things in the Engine and in games, such as bounding volumes, collision detection and visibility calculation.
Name | Description | |
---|---|---|
|
FBox() |
Default constructor (no initialization). |
|
FBox ( |
Creates and initializes a new box with zero extent and marks it as invalid. |
|
FBox |
Creates and initializes a new box from an array of points. |
|
FBox |
Creates and initializes a new box from the specified extents. |
|
FBox |
Creates and initializes a new box from the given set of points. |
Name | Description | ||
---|---|---|---|
|
BuildAABB |
Utility function to build an AABB from Origin and Extent |
|
|
float |
ComputeSquaredDistanceToPoint ( |
Calculates the distance of a point to this box. |
|
ExpandBy |
Increases the box size. |
|
|
ExpandBy ( |
Increases the box size. |
|
|
ExpandBy ( |
Increases the box size. |
|
|
GetCenter() |
Gets the center point of this box. |
|
|
GetCenterAndExtents |
Gets the center and extents of this box. |
|
|
GetClosestPointTo ( |
Calculates the closest point on or inside the box to a given point in space. |
|
|
GetExtent() |
Gets the extents of this box. |
|
|
GetSize() |
Gets the size of this box. |
|
|
float |
GetVolume() |
Gets the volume of this box. |
|
Init() |
Set the initial values of the bounding box to Zero. |
|
|
Intersect ( |
Checks whether the given bounding box intersects this bounding box. |
|
|
IntersectXY ( |
Checks whether the given bounding box intersects this bounding box in the XY plane. |
|
|
InverseTransformBy ( |
Gets a bounding volume transformed by an inverted FTransform object. |
|
|
IsInside ( |
Checks whether a given box is fully encapsulated by this box. |
|
|
IsInside ( |
Checks whether the given location is inside this box. |
|
|
IsInsideOrOn ( |
Checks whether the given location is inside or on this box. |
|
|
IsInsideXY ( |
Checks whether the given box is fully encapsulated by this box in the XY plane. |
|
|
IsInsideXY ( |
Checks whether the given location is inside this box in the XY plane. |
|
|
MoveTo ( |
Moves the center of bounding box to new destination. |
|
|
Overlap ( |
Returns the overlap FBox of two box |
|
|
Serialize ( |
||
|
Serialize ( |
||
|
ShiftBy ( |
Shifts the bounding box position. |
|
|
ToString() |
Get a textual representation of this box. |
|
|
TransformBy ( |
Gets a bounding volume transformed by a matrix. |
|
|
TransformBy ( |
Gets a bounding volume transformed by a FTransform object. |
|
|
TransformProjectBy ( |
Transforms and projects a world bounding box to screen space |
Name | Description | ||
---|---|---|---|
|
FVector & |
operator[] ( |
Gets reference to the min or max of this bounding volume. |
|
operator+ ( |
Gets the result of addition to this bounding volume. |
|
|
operator+ ( |
Gets the result of addition to this bounding volume. |
|
|
FBox & |
operator+= ( |
Adds to this bounding box to include a given point. |
|
FBox & |
operator+= ( |
Adds to this bounding box to include a new bounding volume. |
|
operator== ( |
Compares two boxes for equality. |
Name | Description | ||
---|---|---|---|
|
const FVecto... |
GetExtrema ( |
This method performed unsafe operations and should be replaced with using .Min and .Max directly or using the [] operator on this class instead. |
|
FVector & |
GetExtrema ( |
This method performed unsafe operations and should be replaced with using .Min and .Max directly or using the [] operator on this class instead. |