UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::Geometry::TAxisAlignedBox2< RealType > Struct Template Reference

#include <BoxTypes.h>

Public Member Functions

 TAxisAlignedBox2 ()
 
 TAxisAlignedBox2 (const TVector2< RealType > &Min, const TVector2< RealType > &Max)
 
template<typename OtherRealType >
 TAxisAlignedBox2 (const TAxisAlignedBox2< OtherRealType > &OtherBox)
 
 TAxisAlignedBox2 (RealType SquareSize)
 
 TAxisAlignedBox2 (RealType Width, RealType Height)
 
 TAxisAlignedBox2 (const TArray< TVector2< RealType > > &Pts)
 
 TAxisAlignedBox2 (TArrayView< const TVector2< RealType > > Pts)
 
 TAxisAlignedBox2 (const TVector2< RealType > &Center, RealType HalfWidth)
 
template<typename OutRealType >
 operator TBox2< OutRealType > () const
 
template<typename InRealType >
 TAxisAlignedBox2 (const TBox2< InRealType > &Box)
 
TVector2< RealType > Center () const
 
TVector2< RealType > Extents () const
 
TVector2< RealType > GetCorner (int Index) const
 
void Contain (const TVector2< RealType > &V)
 
void Contain (const TAxisAlignedBox2< RealType > &Other)
 
void Contain (const TArray< TVector2< RealType > > &Pts)
 
void Contain (TArrayView< const TVector2< RealType > > Pts)
 
bool Contains (const TVector2< RealType > &V) const
 
bool Contains (const TAxisAlignedBox2< RealType > &Box) const
 
TVector< RealType > Clamp (const TVector2< RealType > &V)
 
bool Intersects (const TAxisAlignedBox2< RealType > &Box) const
 
TAxisAlignedBox2< RealType > Intersect (const TAxisAlignedBox2< RealType > &Box) const
 
RealType DistanceSquared (const TVector2< RealType > &V) const
 
RealType Width () const
 
RealType Height () const
 
RealType Area () const
 
RealType Perimeter () const
 
RealType DiagonalLength () const
 
RealType MaxDim () const
 
RealType MinDim () const
 
bool IsEmpty () const
 
void Expand (RealType Radius)
 
void Expand (const TVector2< RealType > &ExpandByVec)
 

Static Public Member Functions

static TAxisAlignedBox2< RealType > Empty ()
 

Public Attributes

TVector2< RealType > Min
 
TVector2< RealType > Max
 

Constructor & Destructor Documentation

◆ TAxisAlignedBox2() [1/9]

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

◆ TAxisAlignedBox2() [2/9]

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

◆ TAxisAlignedBox2() [3/9]

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

◆ TAxisAlignedBox2() [4/9]

template<typename RealType >
UE::Geometry::TAxisAlignedBox2< RealType >::TAxisAlignedBox2 ( RealType  SquareSize)
inline

◆ TAxisAlignedBox2() [5/9]

template<typename RealType >
UE::Geometry::TAxisAlignedBox2< RealType >::TAxisAlignedBox2 ( RealType  Width,
RealType  Height 
)
inline

◆ TAxisAlignedBox2() [6/9]

template<typename RealType >
UE::Geometry::TAxisAlignedBox2< RealType >::TAxisAlignedBox2 ( const TArray< TVector2< RealType > > &  Pts)
inline

◆ TAxisAlignedBox2() [7/9]

template<typename RealType >
UE::Geometry::TAxisAlignedBox2< RealType >::TAxisAlignedBox2 ( TArrayView< const TVector2< RealType > >  Pts)
inline

◆ TAxisAlignedBox2() [8/9]

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

◆ TAxisAlignedBox2() [9/9]

template<typename RealType >
template<typename InRealType >
UE::Geometry::TAxisAlignedBox2< RealType >::TAxisAlignedBox2 ( const TBox2< InRealType > &  Box)
inline

Member Function Documentation

◆ Area()

template<typename RealType >
RealType UE::Geometry::TAxisAlignedBox2< RealType >::Area ( ) const
inline

◆ Center()

template<typename RealType >
TVector2< RealType > UE::Geometry::TAxisAlignedBox2< RealType >::Center ( ) const
inline

◆ Clamp()

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

◆ Contain() [1/4]

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

◆ Contain() [2/4]

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

◆ Contain() [3/4]

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

◆ Contain() [4/4]

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

◆ Contains() [1/2]

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

◆ Contains() [2/2]

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

◆ DiagonalLength()

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

◆ DistanceSquared()

template<typename RealType >
RealType UE::Geometry::TAxisAlignedBox2< RealType >::DistanceSquared ( const TVector2< RealType > &  V) const
inline

◆ Empty()

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

◆ Expand() [1/2]

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

◆ Expand() [2/2]

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

◆ Extents()

template<typename RealType >
TVector2< RealType > UE::Geometry::TAxisAlignedBox2< RealType >::Extents ( ) const
inline

◆ GetCorner()

template<typename RealType >
TVector2< RealType > UE::Geometry::TAxisAlignedBox2< RealType >::GetCorner ( int  Index) const
inline

Corners are ordered to follow the perimeter of the bounding rectangle, starting from the (Min.X, Min.Y) corner and ending at (Min.X, Max.Y)

Parameters
Indexwhich corner to return, must be in range [0,3]
Returns
Corner of the bounding rectangle

◆ Height()

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

◆ Intersect()

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

◆ Intersects()

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

◆ IsEmpty()

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

◆ MaxDim()

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

◆ MinDim()

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

◆ operator TBox2< OutRealType >()

template<typename RealType >
template<typename OutRealType >
UE::Geometry::TAxisAlignedBox2< RealType >::operator TBox2< OutRealType > ( ) const
inlineexplicit

◆ Perimeter()

template<typename RealType >
RealType UE::Geometry::TAxisAlignedBox2< RealType >::Perimeter ( ) const
inline

◆ Width()

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

Member Data Documentation

◆ Max

template<typename RealType >
TVector2<RealType> UE::Geometry::TAxisAlignedBox2< RealType >::Max

◆ Min

template<typename RealType >
TVector2<RealType> UE::Geometry::TAxisAlignedBox2< RealType >::Min

The documentation for this struct was generated from the following file: