#include <BoxSphereBounds.h>

Classes
struct	Builder

Public Types
using	FReal = T

Public Member Functions
	TBoxSphereBounds ()=default

	TBoxSphereBounds (EForceInit)

	TBoxSphereBounds (const TVector< T > &InOrigin, const TVector< TExtent > &InBoxExtent, TExtent InSphereRadius)

	TBoxSphereBounds (const TBox< T > &Box, const TSphere< T > &Sphere)

	TBoxSphereBounds (const TBox< T > &Box)

	TBoxSphereBounds (const TSphere< T > &Sphere)

	TBoxSphereBounds (const TVector< T > *Points, uint32 NumPoints)

template<typename TFrom , typename TExtentFrom UE_REQUIRES>
	TBoxSphereBounds (const TBoxSphereBounds< TFrom, TExtentFrom > &From)

bool	Serialize (FArchive &Ar)

bool	SerializeFromMismatchedTag (FName StructTag, FArchive &Ar)

TBoxSphereBounds< T, TExtent >	operator+ (const TBoxSphereBounds< T, TExtent > &Other) const

UE_FORCEINLINE_HINT bool	operator== (const TBoxSphereBounds< T, TExtent > &Other) const

UE_FORCEINLINE_HINT bool	operator!= (const TBoxSphereBounds< T, TExtent > &Other) const

T	ComputeSquaredDistanceFromBoxToPoint (const TVector< T > &Point) const

UE_FORCEINLINE_HINT TBox< T >	GetBox () const

TVector< T >	GetBoxExtrema (uint32 Extrema) const

UE_FORCEINLINE_HINT TSphere< T >	GetSphere () const

UE_FORCEINLINE_HINT TBoxSphereBounds< T, TExtent >	ExpandBy (TExtent ExpandAmount) const

TBoxSphereBounds< T, TExtent >	TransformBy (const TMatrix< T > &M) const

TBoxSphereBounds< T, TExtent >	TransformBy (const TTransform< T > &M) const

FString	ToString () const

UE_FORCEINLINE_HINT void	DiagnosticCheckNaN () const

bool	ContainsNaN () const

Static Public Member Functions
static UE_FORCEINLINE_HINT bool	SpheresIntersect (const TBoxSphereBounds< T, TExtent > &A, const TBoxSphereBounds< T, TExtent > &B, TExtent Tolerance=UE_KINDA_SMALL_NUMBER)

static UE_FORCEINLINE_HINT bool	BoxesIntersect (const TBoxSphereBounds< T, TExtent > &A, const TBoxSphereBounds< T, TExtent > &B)

Public Attributes
TVector< T >	Origin

TVector< TExtent >	BoxExtent

TExtent	SphereRadius

Friends
TBoxSphereBounds< T, TExtent >	Union (const TBoxSphereBounds< T, TExtent > &A, const TBoxSphereBounds< T, TExtent > &B)

Member Typedef Documentation

◆ FReal

template<typename T , typename TExtent >

using UE::Math::TBoxSphereBounds< T, TExtent >::FReal = T

Constructor & Destructor Documentation

◆ TBoxSphereBounds() [1/8]

template<typename T , typename TExtent >

UE::Math::TBoxSphereBounds< T, TExtent >::TBoxSphereBounds ( )

default

Default constructor.

◆ TBoxSphereBounds() [2/8]

template<typename T , typename TExtent >

UE::Math::TBoxSphereBounds< T, TExtent >::TBoxSphereBounds ( EForceInit )

inlineexplicit

Creates and initializes a new instance.

Parameters

EForceInit Force Init Enum.

◆ TBoxSphereBounds() [3/8]

template<typename T , typename TExtent >

UE::Math::TBoxSphereBounds< T, TExtent >::TBoxSphereBounds	(	const TVector< T > &	InOrigin,
		const TVector< TExtent > &	InBoxExtent,
		TExtent	InSphereRadius
	)

inline

Creates and initializes a new instance from the specified parameters.

Parameters

InOrigin	origin of the bounding box and sphere.
InBoxExtent	half size of box.
InSphereRadius	radius of the sphere.

◆ TBoxSphereBounds() [4/8]

template<typename T , typename TExtent >

UE::Math::TBoxSphereBounds< T, TExtent >::TBoxSphereBounds	(	const TBox< T > &	Box,
		const TSphere< T > &	Sphere
	)

inline

Creates and initializes a new instance from the given Box and Sphere.

Parameters

Box	The bounding box.
Sphere	The bounding sphere.

◆ TBoxSphereBounds() [5/8]

template<typename T , typename TExtent >

UE::Math::TBoxSphereBounds< T, TExtent >::TBoxSphereBounds ( const TBox< T > & Box )

inline

Creates and initializes a new instance the given Box.

The sphere radius is taken from the extent of the box.

Parameters

Box	The bounding box.

◆ TBoxSphereBounds() [6/8]

template<typename T , typename TExtent >

UE::Math::TBoxSphereBounds< T, TExtent >::TBoxSphereBounds ( const TSphere< T > & Sphere )

inline

Creates and initializes a new instance for the given sphere.

◆ TBoxSphereBounds() [7/8]

template<typename T , typename TExtent >

UE::Math::TBoxSphereBounds< T, TExtent >::TBoxSphereBounds	(	const TVector< T > *	Points,
		uint32	NumPoints
	)

inline

Creates and initializes a new instance from the given set of points.

The sphere radius is taken from the extent of the box.

Parameters

Points	The points to be considered for the bounding box.
NumPoints	Number of points in the Points array.

◆ TBoxSphereBounds() [8/8]

template<typename T , typename TExtent >

template<typename TFrom , typename TExtentFrom UE_REQUIRES>

UE::Math::TBoxSphereBounds< T, TExtent >::TBoxSphereBounds ( const TBoxSphereBounds< TFrom, TExtentFrom > & From )

inlineexplicit

Member Function Documentation

◆ BoxesIntersect()

template<typename T , typename TExtent >

static UE_FORCEINLINE_HINT bool UE::Math::TBoxSphereBounds< T, TExtent >::BoxesIntersect	(	const TBoxSphereBounds< T, TExtent > &	A,
		const TBoxSphereBounds< T, TExtent > &	B
	)

inlinestatic

Test whether the boxes from two BoxSphereBounds intersect/overlap.

Parameters

A	First BoxSphereBounds to test.
B	Second BoxSphereBounds to test.

Returns: true if boxes intersect, false otherwise.

◆ ComputeSquaredDistanceFromBoxToPoint()

template<typename T , typename TExtent >

T UE::Math::TBoxSphereBounds< T, TExtent >::ComputeSquaredDistanceFromBoxToPoint ( const TVector< T > & Point ) const

inline

Calculates the squared distance from a point to a bounding box

Parameters

Point The point.

Returns: The distance.

◆ ContainsNaN()

template<typename T , typename TExtent >

bool UE::Math::TBoxSphereBounds< T, TExtent >::ContainsNaN ( ) const

inline

◆ DiagnosticCheckNaN()

template<typename T , typename TExtent >

UE_FORCEINLINE_HINT void UE::Math::TBoxSphereBounds< T, TExtent >::DiagnosticCheckNaN ( ) const

inline

◆ ExpandBy()

template<typename T , typename TExtent >

UE_FORCEINLINE_HINT TBoxSphereBounds< T, TExtent > UE::Math::TBoxSphereBounds< T, TExtent >::ExpandBy ( TExtent ExpandAmount ) const

inline

Increase the size of the box and sphere by a given size.

Parameters

ExpandAmount The size to increase by.

Returns: A new box with the expanded size.

◆ GetBox()

template<typename T , typename TExtent >

UE_FORCEINLINE_HINT TBox< T > UE::Math::TBoxSphereBounds< T, TExtent >::GetBox ( ) const

inline

Gets the bounding box.

Returns: The bounding box.

◆ GetBoxExtrema()

template<typename T , typename TExtent >

TVector< T > UE::Math::TBoxSphereBounds< T, TExtent >::GetBoxExtrema ( uint32 Extrema ) const

inline

Gets the extrema for the bounding box.

Parameters

Extrema 1 for positive extrema from the origin, else negative

Returns: The boxes extrema

◆ GetSphere()

template<typename T , typename TExtent >

UE_FORCEINLINE_HINT TSphere< T > UE::Math::TBoxSphereBounds< T, TExtent >::GetSphere ( ) const

inline

Gets the bounding sphere.

Returns: The bounding sphere.

◆ operator!=()

template<typename T , typename TExtent >

UE_FORCEINLINE_HINT bool UE::Math::TBoxSphereBounds< T, TExtent >::operator!= ( const TBoxSphereBounds< T, TExtent > & Other ) const

Compare bounding volume this and Other.

Parameters

Other The other bounding volume.

Returns: true of they do not match.

◆ operator+()

template<typename T , typename TExtent >

TBoxSphereBounds< T, TExtent > UE::Math::TBoxSphereBounds< T, TExtent >::operator+ ( const TBoxSphereBounds< T, TExtent > & Other ) const

inline

Constructs a bounding volume containing both this and B.

Parameters

Other The other bounding volume.

Returns: The combined bounding volume.

◆ operator==()

template<typename T , typename TExtent >

UE_FORCEINLINE_HINT bool UE::Math::TBoxSphereBounds< T, TExtent >::operator== ( const TBoxSphereBounds< T, TExtent > & Other ) const

Compare bounding volume this and Other.

Parameters

Other The other bounding volume.

Returns: true of they match.

◆ Serialize()

template<typename T , typename TExtent >

bool UE::Math::TBoxSphereBounds< T, TExtent >::Serialize ( FArchive & Ar )

inline

◆ SerializeFromMismatchedTag()

template<typename T , typename TExtent >

bool UE::Math::TBoxSphereBounds< T, TExtent >::SerializeFromMismatchedTag	(	FName	StructTag,
		FArchive &	Ar
	)

inline

◆ SpheresIntersect()

template<typename T , typename TExtent >

static UE_FORCEINLINE_HINT bool UE::Math::TBoxSphereBounds< T, TExtent >::SpheresIntersect	(	const TBoxSphereBounds< T, TExtent > &	A,
		const TBoxSphereBounds< T, TExtent > &	B,
		TExtent	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

inlinestatic

Test whether the spheres from two BoxSphereBounds intersect/overlap.

Parameters

A	First BoxSphereBounds to test.
B	Second BoxSphereBounds to test.
Tolerance	Error tolerance added to test distance.

Returns: true if spheres intersect, false otherwise.

◆ ToString()

template<typename T , typename TExtent >

UE_FORCEINLINE_HINT FString UE::Math::TBoxSphereBounds< T, TExtent >::ToString ( ) const

Get a textual representation of this bounding box.

Returns: Text describing the bounding box.

◆ TransformBy() [1/2]

template<typename T , typename TExtent >

TBoxSphereBounds< T, TExtent > UE::Math::TBoxSphereBounds< T, TExtent >::TransformBy ( const TMatrix< T > & M ) const

Gets a bounding volume transformed by a matrix.

Parameters

M	The matrix.

Returns: The transformed volume.

◆ TransformBy() [2/2]

template<typename T , typename TExtent >

TBoxSphereBounds< T, TExtent > UE::Math::TBoxSphereBounds< T, TExtent >::TransformBy ( const TTransform< T > & M ) const

Gets a bounding volume transformed by a FTransform object.

Parameters

M	The FTransform object.

Returns: The transformed volume.

Friends And Related Symbol Documentation

◆ Union

template<typename T , typename TExtent >

TBoxSphereBounds< T, TExtent > Union	(	const TBoxSphereBounds< T, TExtent > &	A,
		const TBoxSphereBounds< T, TExtent > &	B
	)

friend

Constructs a bounding volume containing both A and B.

This is a legacy version of the function used to compute primitive bounds, to avoid the need to rebuild lighting after the change.

Member Data Documentation

◆ BoxExtent

template<typename T , typename TExtent >

TVector<TExtent> UE::Math::TBoxSphereBounds< T, TExtent >::BoxExtent

Holds the extent of the bounding box.

◆ Origin

template<typename T , typename TExtent >

TVector<T> UE::Math::TBoxSphereBounds< T, TExtent >::Origin

Holds the origin of the bounding box and sphere.

◆ SphereRadius

template<typename T , typename TExtent >

TExtent UE::Math::TBoxSphereBounds< T, TExtent >::SphereRadius

Holds the radius of the bounding sphere.

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

Engine/Source/Runtime/Core/Public/Math/BoxSphereBounds.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Member Typedef Documentation

◆ FReal

Constructor & Destructor Documentation

◆ TBoxSphereBounds() [1/8]

◆ TBoxSphereBounds() [2/8]

◆ TBoxSphereBounds() [3/8]

◆ TBoxSphereBounds() [4/8]

◆ TBoxSphereBounds() [5/8]

◆ TBoxSphereBounds() [6/8]

◆ TBoxSphereBounds() [7/8]

◆ TBoxSphereBounds() [8/8]

Member Function Documentation

◆ BoxesIntersect()

◆ ComputeSquaredDistanceFromBoxToPoint()

◆ ContainsNaN()

◆ DiagnosticCheckNaN()

◆ ExpandBy()

◆ GetBox()

◆ GetBoxExtrema()

◆ GetSphere()

◆ operator!=()

◆ operator+()

◆ operator==()

◆ Serialize()

◆ SerializeFromMismatchedTag()

◆ SpheresIntersect()

◆ ToString()

◆ TransformBy() [1/2]

◆ TransformBy() [2/2]

Friends And Related Symbol Documentation

◆ Union

Member Data Documentation

◆ BoxExtent

◆ Origin

◆ SphereRadius