1. Epic GamesDeveloper
  3. TOrientedBox3

TOrientedBox3

[TOrientedBox3](API\Runtime\GeometryCore\TOrientedBox3) is a non-axis-aligned 3D box defined by a 3D frame and extents along the axes of that frame The frame is at the center of the box.

API > API/Runtime > API/Runtime/GeometryCore

References

   
Module GeometryCore
Header /Engine/Source/Runtime/GeometryCore/Public/OrientedBoxTypes.h
Include #include "OrientedBoxTypes.h"
Source /Engine/Source/Runtime/GeometryCore/Public/Intersection/IntersectionQueries3.h

Syntax

template<typename RealType>  
struct TOrientedBox3

Remarks

TOrientedBox3 is a non-axis-aligned 3D box defined by a 3D frame and extents along the axes of that frame The frame is at the center of the box.

Variables

  Type Name Description
Public variable TVector< RealType > Extents Half-dimensions of box measured along the three axes
Public variable TFrame3< RealType > Frame 3D position (center) and orientation (axes) of the box

Constructors

  Type Name Description
Public function    
Public function  

TOrientedBox3 ( const TAxisAlignedBox3< RealType >& AxisBox
)

 Create oriented box from axis-aligned box
Public function  

TOrientedBox3 ( const TVector< RealType >& Origin,
const TVector< RealType >& ExtentsIn
)

 Create axis-aligned box with given Origin and Extents
Public function  

TOrientedBox3 ( const TFrame3< RealType >& FrameIn,
const TVector< RealType >& ExtentsIn
)

 Create oriented box with given Frame and Extents

Functions

  Type Name Description
Public function Const TVector< RealType >

AxisX ()

  
Public function Const TVector< RealType >

AxisY ()

  
Public function Const TVector< RealType >

AxisZ ()

  
Public function Const TVector< RealType >

Center ()

  
Public function Const TVector< RealType >

ClosestPoint ( const TVector< RealType >& Point
)

 Find closest point on box
Public function Const bool

Contains ( const TVector< RealType >& Point
)

  
Public function Const TVector< RealType >  
Public function Const RealType

DistanceSquared ( TVector< RealType > Point
)

 Find squared distance to box.
Public function Const void

EnumerateCorners ( PointFuncType CornerPointFunc
)

 Call CornerPointFunc(FVector3) for each of the 8 box corners.
Public function Const TVector< RealType >

GetAxis ( int AxisIndex
)

  
Public function Const TVector< RealType >

GetCorner ( int Index
)

 Corners [ (-x,-y), (x,-y), (x,y), (-x,y) ], -z, then +z
Public function Static FIndex3i

GetCornerSide ( int Index
)

 Get whether the corner at Index (see diagram in GetCorner documentation comment) is in the negative or positive direction for each axis
Public function Const TOrientedBox3< RealType >

Merge ( const TOrientedBox3< RealType >& Other,
bool bOnlyConsiderExistingAxes
)

 Create a merged TOrientedBox, encompassing this box and one other.
Public function Const RealType

SignedDistance ( TVector< RealType > Point
)

 Find signed distance to box surface
Public function Const RealType  
Public function Const bool

TestCorners ( PointPredicateType CornerPointPredicate
)

 Call CornerPointPredicate(FVector3) for each of the 8 box corners, with early-out if any call returns false
Public function Static TOrientedBox3< RealType >  
Public function Static TOrientedBox3< RealType >  
Public function Const RealType

Volume ()

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page