Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

TOrientedBox3

[TOrientedBox3](API\Plugins\GeometricObjects\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.

Windows

MacOS

Linux

References

Module	GeometricObjects
Header	/Engine/Plugins/Experimental/GeometryProcessing/Source/GeometricObjects/Public/OrientedBoxTypes.h
Include	#include "OrientedBoxTypes.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

		Name	Description
	FVector3< RealT...	Extents	Half-dimensions of box measured along the three axes
	TFrame3< RealTy...	Frame	3D position (center) and orientation (axes) of the box

Constructors

	Name	Description
	TOrientedBox3()
	TOrientedBox3 ( const TAxisAlignedBox3< RealType > ... )	Create oriented box from axis-aligned box
	TOrientedBox3 ( const FVector3< RealType >& Origin, const FVector3< RealType >& Extent... )	Create axis-aligned box with given Origin and Extents
	TOrientedBox3 ( const TFrame3< RealType >& FrameIn, const FVector3< RealType >& Extent... )	Create oriented box with given Frame and Extents

Functions

	Name	Description
FVector3< Re...	AxisX()
FVector3< Re...	AxisY()
FVector3< Re...	AxisZ()
FVector3< Re...	Center()
FVector3< Re...	ClosestPoint ( FVector3< RealType > Point )	Find closest point on box
bool	Contains ( const FVector3< RealType >& Point )
FVector3< Re...	Diagonal()
RealType	DistanceSquared ( FVector3< RealType > Point )	Find squared distance to box.
void	EnumerateCorners ( PointFuncType CornerPointFunc )	Call CornerPointFunc(FVector3) for each of the 8 box corners.
FVector3< Re...	GetAxis ( int AxisIndex )
FVector3< Re...	GetCorner ( int Index )	Corners [ (-x,-y), (x,-y), (x,y), (-x,y) ], -z, then +z
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
RealType	MaxExtent()
RealType	MinExtent()
bool	TestCorners ( PointPredicateType CornerPointPredi... )	Call CornerPointPredicate(FVector3) for each of the 8 box corners, with early-out if any call returns false
TOrientedBox...	UnitPositive()
TOrientedBox...	UnitZeroCentered()
RealType	Volume()

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss