1. Epic GamesDeveloper
  3. TOrientedBox2

TOrientedBox2

API > API/Runtime > API/Runtime/GeometryCore

References

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

Syntax

template<typename RealType>  
struct TOrientedBox2

Variables

  Type Name Description
Public variable TVector2< RealType > Extents Half-dimensions of box measured along the two axes
Public variable TVector2< RealType > Origin Center of the box.
Public variable TVector2< RealType > UnitAxisX X Axis of the box must be normalized.

Constructors

  Type Name Description
Public function    
Public function  

TOrientedBox2 ( const TAxisAlignedBox2< RealType >& AxisBox
)

 Create oriented box from axis-aligned box
Public function  

TOrientedBox2 ( const TVector2< RealType >& OriginIn,
const TVector2< RealType >& ExtentsIn
)

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

TOrientedBox2 ( const TVector2< RealType >& OriginIn,
const TVector2< RealType >& XAxisIn,
const TVector2< RealType >& ExtentsIn
)

 Create oriented box with given Origin, X Axis and Extents
Public function  

TOrientedBox2 ( const TVector2< RealType >& OriginIn,
RealType AngleRad,
const TVector2< RealType >& ExtentsIn
)

 Create oriented box with given Origin, Angle (in radians) and Extents

Functions

  Type Name Description
Public function Const RealType

Area ()

  
Public function Const TVector2< RealType >

AxisX ()

  
Public function Const TVector2< RealType >

AxisY ()

  
Public function Const TVector2< RealType >

Center ()

  
Public function Const TVector2< RealType >

ClosestPoint ( const TVector2< RealType >& Point
)

 Find closest point on box
Public function Const bool

Contains ( const TVector2< RealType >& Point
)

  
Public function Const TVector2< RealType >  
Public function Const RealType

DistanceSquared ( const TVector2< RealType >& Point
)

 Find squared distance to box.
Public function Const void

EnumerateCorners ( PointFuncType CornerPointFunc
)

 Call CornerPointFunc(TVector2) for each of the 4 box corners.
Public function Const TVector2< RealType >

FromLocalSpace ( const TVector2< RealType >& Point
)

  
Public function Const TVector2< RealType >

GetAxis ( int AxisIndex
)

  
Public function Const TVector2< RealType >

GetCorner ( int Index
)

  
Public function Static FIndex2i

GetCornerSide ( int Index
)

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

SetAngleRadians ( RealType AngleRad
)

  
Public function Const bool

TestCorners ( PointPredicateType CornerPointPredicate
)

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

ToLocalSpace ( const TVector2< RealType >& Point
)

  
Public function Static TOrientedBox2< RealType >  
Public function Static TOrientedBox2< RealType >  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page