UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
UE::Geometry::TAxisAlignedBox3< RealType > Struct Template Reference

#include <BoxTypes.h>

Public Member Functions

 TAxisAlignedBox3 ()
 
 TAxisAlignedBox3 (const TVector< RealType > &Min, const TVector< RealType > &Max)
 
 TAxisAlignedBox3 (const TVector< RealType > &A, const TVector< RealType > &B, const TVector< RealType > &C)
 
template<typename OtherRealType >
 TAxisAlignedBox3 (const TAxisAlignedBox3< OtherRealType > &OtherBox)
 
 TAxisAlignedBox3 (const TVector< RealType > &Center, RealType HalfWidth)
 
 TAxisAlignedBox3 (const TAxisAlignedBox3 &Box, const TFunction< TVector< RealType >(const TVector< RealType > &)> TransformF)
 
 TAxisAlignedBox3 (const TAxisAlignedBox3 &Box, const FTransformSRT3d &Transform)
 
 TAxisAlignedBox3 (TArrayView< const TVector< RealType > > Pts)
 
 TAxisAlignedBox3 (const TArray< TVector< RealType > > &Pts)
 
bool operator== (const TAxisAlignedBox3< RealType > &Other) const
 
bool operator!= (const TAxisAlignedBox3< RealType > &Other) const
 
template<typename OutRealType >
 operator TBox< OutRealType > () const
 
template<typename InRealType >
 TAxisAlignedBox3 (const TBox< InRealType > &Box)
 
TVector< RealType > GetCorner (int Index) const
 
TVector< RealType > Center () const
 
TVector< RealType > Extents () const
 
void Contain (const TVector< RealType > &V)
 
void Contain (const TAxisAlignedBox3< RealType > &Other)
 
void Contain (TArrayView< const TVector< RealType > > Pts)
 
void Contain (const TArray< TVector< RealType > > &Pts)
 
bool Contains (const TVector< RealType > &V) const
 
bool Contains (const TAxisAlignedBox3< RealType > &Box) const
 
TVector< RealType > Clamp (const TVector< RealType > &V) const
 
TAxisAlignedBox3< RealType > Intersect (const TAxisAlignedBox3< RealType > &Box) const
 
bool Intersects (TAxisAlignedBox3 Box) const
 
RealType DistanceSquared (const TVector< RealType > &V) const
 
RealType DistanceSquared (const TAxisAlignedBox3< RealType > &Box) const
 
RealType Dimension (int32 Index) const
 
RealType Width () const
 
RealType Height () const
 
RealType Depth () const
 
RealType Volume () const
 
RealType SurfaceArea () const
 
RealType DiagonalLength () const
 
RealType MaxDim () const
 
RealType MinDim () const
 
TVector< RealType > Diagonal () const
 
bool IsEmpty () const
 
void Expand (RealType Radius)
 
void Expand (const TVector< RealType > &ExpandByVec)
 

Static Public Member Functions

static TAxisAlignedBox3< RealType > Empty ()
 
static TAxisAlignedBox3< RealType > Infinite ()
 
template<typename PointFunc >
static TAxisAlignedBox3< RealType > MakeBoundsFromIndices (int32 MaxIndex, PointFunc GetPoint)
 
template<typename EnumerableIntType , typename PointFunc >
static TAxisAlignedBox3< RealType > MakeBoundsFromIndices (EnumerableIntType IndexEnumerable, PointFunc GetPoint)
 

Public Attributes

TVector< RealType > Min
 
TVector< RealType > Max
 

Constructor & Destructor Documentation

◆ TAxisAlignedBox3() [1/10]

template<typename RealType >
UE::Geometry::TAxisAlignedBox3< RealType >::TAxisAlignedBox3 ( )
inline

◆ TAxisAlignedBox3() [2/10]

template<typename RealType >
UE::Geometry::TAxisAlignedBox3< RealType >::TAxisAlignedBox3 ( const TVector< RealType > &  Min,
const TVector< RealType > &  Max 
)
inline

◆ TAxisAlignedBox3() [3/10]

template<typename RealType >
UE::Geometry::TAxisAlignedBox3< RealType >::TAxisAlignedBox3 ( const TVector< RealType > &  A,
const TVector< RealType > &  B,
const TVector< RealType > &  C 
)
inline

◆ TAxisAlignedBox3() [4/10]

template<typename RealType >
template<typename OtherRealType >
UE::Geometry::TAxisAlignedBox3< RealType >::TAxisAlignedBox3 ( const TAxisAlignedBox3< OtherRealType > &  OtherBox)
inlineexplicit

◆ TAxisAlignedBox3() [5/10]

template<typename RealType >
UE::Geometry::TAxisAlignedBox3< RealType >::TAxisAlignedBox3 ( const TVector< RealType > &  Center,
RealType  HalfWidth 
)
inline

◆ TAxisAlignedBox3() [6/10]

template<typename RealType >
UE::Geometry::TAxisAlignedBox3< RealType >::TAxisAlignedBox3 ( const TAxisAlignedBox3< RealType > &  Box,
const TFunction< TVector< RealType >(const TVector< RealType > &)>  TransformF 
)
inline

◆ TAxisAlignedBox3() [7/10]

template<typename RealType >
UE::Geometry::TAxisAlignedBox3< RealType >::TAxisAlignedBox3 ( const TAxisAlignedBox3< RealType > &  Box,
const FTransformSRT3d &  Transform 
)
inline

◆ TAxisAlignedBox3() [8/10]

template<typename RealType >
UE::Geometry::TAxisAlignedBox3< RealType >::TAxisAlignedBox3 ( TArrayView< const TVector< RealType > >  Pts)
inline

◆ TAxisAlignedBox3() [9/10]

template<typename RealType >
UE::Geometry::TAxisAlignedBox3< RealType >::TAxisAlignedBox3 ( const TArray< TVector< RealType > > &  Pts)
inline

◆ TAxisAlignedBox3() [10/10]

template<typename RealType >
template<typename InRealType >
UE::Geometry::TAxisAlignedBox3< RealType >::TAxisAlignedBox3 ( const TBox< InRealType > &  Box)
inline

Member Function Documentation

◆ Center()

template<typename RealType >
TVector< RealType > UE::Geometry::TAxisAlignedBox3< RealType >::Center ( ) const
inline

◆ Clamp()

template<typename RealType >
TVector< RealType > UE::Geometry::TAxisAlignedBox3< RealType >::Clamp ( const TVector< RealType > &  V) const
inline

◆ Contain() [1/4]

template<typename RealType >
void UE::Geometry::TAxisAlignedBox3< RealType >::Contain ( const TArray< TVector< RealType > > &  Pts)
inline

◆ Contain() [2/4]

template<typename RealType >
void UE::Geometry::TAxisAlignedBox3< RealType >::Contain ( const TAxisAlignedBox3< RealType > &  Other)
inline

◆ Contain() [3/4]

template<typename RealType >
void UE::Geometry::TAxisAlignedBox3< RealType >::Contain ( const TVector< RealType > &  V)
inline

◆ Contain() [4/4]

template<typename RealType >
void UE::Geometry::TAxisAlignedBox3< RealType >::Contain ( TArrayView< const TVector< RealType > >  Pts)
inline

◆ Contains() [1/2]

template<typename RealType >
bool UE::Geometry::TAxisAlignedBox3< RealType >::Contains ( const TAxisAlignedBox3< RealType > &  Box) const
inline

◆ Contains() [2/2]

template<typename RealType >
bool UE::Geometry::TAxisAlignedBox3< RealType >::Contains ( const TVector< RealType > &  V) const
inline

◆ Depth()

template<typename RealType >
RealType UE::Geometry::TAxisAlignedBox3< RealType >::Depth ( ) const
inline

◆ Diagonal()

template<typename RealType >
TVector< RealType > UE::Geometry::TAxisAlignedBox3< RealType >::Diagonal ( ) const
inline

◆ DiagonalLength()

template<typename RealType >
RealType UE::Geometry::TAxisAlignedBox3< RealType >::DiagonalLength ( ) const
inline

◆ Dimension()

template<typename RealType >
RealType UE::Geometry::TAxisAlignedBox3< RealType >::Dimension ( int32  Index) const
inline

◆ DistanceSquared() [1/2]

template<typename RealType >
RealType UE::Geometry::TAxisAlignedBox3< RealType >::DistanceSquared ( const TAxisAlignedBox3< RealType > &  Box) const
inline

◆ DistanceSquared() [2/2]

template<typename RealType >
RealType UE::Geometry::TAxisAlignedBox3< RealType >::DistanceSquared ( const TVector< RealType > &  V) const
inline

◆ Empty()

template<typename RealType >
static TAxisAlignedBox3< RealType > UE::Geometry::TAxisAlignedBox3< RealType >::Empty ( )
inlinestatic

◆ Expand() [1/2]

template<typename RealType >
void UE::Geometry::TAxisAlignedBox3< RealType >::Expand ( const TVector< RealType > &  ExpandByVec)
inline

◆ Expand() [2/2]

template<typename RealType >
void UE::Geometry::TAxisAlignedBox3< RealType >::Expand ( RealType  Radius)
inline

◆ Extents()

template<typename RealType >
TVector< RealType > UE::Geometry::TAxisAlignedBox3< RealType >::Extents ( ) const
inline

◆ GetCorner()

template<typename RealType >
TVector< RealType > UE::Geometry::TAxisAlignedBox3< RealType >::GetCorner ( int  Index) const
inline
Parameters
Indexcorner index in range 0-7
Returns
Corner point on the box identified by the given index. See diagram in OrientedBoxTypes.h for index/corner mapping.

◆ Height()

template<typename RealType >
RealType UE::Geometry::TAxisAlignedBox3< RealType >::Height ( ) const
inline

◆ Infinite()

template<typename RealType >
static TAxisAlignedBox3< RealType > UE::Geometry::TAxisAlignedBox3< RealType >::Infinite ( )
inlinestatic

◆ Intersect()

template<typename RealType >
TAxisAlignedBox3< RealType > UE::Geometry::TAxisAlignedBox3< RealType >::Intersect ( const TAxisAlignedBox3< RealType > &  Box) const
inline

◆ Intersects()

template<typename RealType >
bool UE::Geometry::TAxisAlignedBox3< RealType >::Intersects ( TAxisAlignedBox3< RealType >  Box) const
inline

◆ IsEmpty()

template<typename RealType >
bool UE::Geometry::TAxisAlignedBox3< RealType >::IsEmpty ( ) const
inline

◆ MakeBoundsFromIndices() [1/2]

template<typename RealType >
template<typename EnumerableIntType , typename PointFunc >
static TAxisAlignedBox3< RealType > UE::Geometry::TAxisAlignedBox3< RealType >::MakeBoundsFromIndices ( EnumerableIntType  IndexEnumerable,
PointFunc  GetPoint 
)
inlinestatic

Compute bounding box of 3D points returned by GetPoint(Index) for indices in range for_each(IndexEnumerable)

◆ MakeBoundsFromIndices() [2/2]

template<typename RealType >
template<typename PointFunc >
static TAxisAlignedBox3< RealType > UE::Geometry::TAxisAlignedBox3< RealType >::MakeBoundsFromIndices ( int32  MaxIndex,
PointFunc  GetPoint 
)
inlinestatic

Compute bounding box of 3D points returned by GetPoint(Index) for indices in range [0...MaxIndex)

◆ MaxDim()

template<typename RealType >
RealType UE::Geometry::TAxisAlignedBox3< RealType >::MaxDim ( ) const
inline

◆ MinDim()

template<typename RealType >
RealType UE::Geometry::TAxisAlignedBox3< RealType >::MinDim ( ) const
inline

◆ operator TBox< OutRealType >()

template<typename RealType >
template<typename OutRealType >
UE::Geometry::TAxisAlignedBox3< RealType >::operator TBox< OutRealType > ( ) const
inlineexplicit

◆ operator!=()

template<typename RealType >
bool UE::Geometry::TAxisAlignedBox3< RealType >::operator!= ( const TAxisAlignedBox3< RealType > &  Other) const
inline

◆ operator==()

template<typename RealType >
bool UE::Geometry::TAxisAlignedBox3< RealType >::operator== ( const TAxisAlignedBox3< RealType > &  Other) const
inline

◆ SurfaceArea()

template<typename RealType >
RealType UE::Geometry::TAxisAlignedBox3< RealType >::SurfaceArea ( ) const
inline

◆ Volume()

template<typename RealType >
RealType UE::Geometry::TAxisAlignedBox3< RealType >::Volume ( ) const
inline

◆ Width()

template<typename RealType >
RealType UE::Geometry::TAxisAlignedBox3< RealType >::Width ( ) const
inline

Member Data Documentation

◆ Max

template<typename RealType >
TVector<RealType> UE::Geometry::TAxisAlignedBox3< RealType >::Max

◆ Min

template<typename RealType >
TVector<RealType> UE::Geometry::TAxisAlignedBox3< RealType >::Min
The documentation for this struct was generated from the following file: