#include <BoxSphereBounds.h>

Collaboration diagram for UE::Math::TBoxSphereBounds< T, TExtent >:

Public Types
using	FReal = T

Public Member Functions
	TBoxSphereBounds ()

FORCEINLINE	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 , TEMPLATE_REQUIRES(!(std::is_same_v< T, TFrom > &&std::is_same_v< TExtent, TExtentFrom >)) >
	TBoxSphereBounds (const TBoxSphereBounds< TFrom, TExtentFrom > &From)

bool	Serialize (FArchive &Ar)

bool	SerializeFromMismatchedTag (FName StructTag, FArchive &Ar)

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

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

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

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

FORCEINLINE TBox< T >	GetBox () const

TVector< T >	GetBoxExtrema (uint32 Extrema) const

FORCEINLINE TSphere< T >	GetSphere () const

FORCEINLINE 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

FORCEINLINE void	DiagnosticCheckNaN () const

bool	ContainsNaN () const

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

static FORCEINLINE 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)

Detailed Description

template<typename T, typename TExtent>
struct UE::Math::TBoxSphereBounds< T, TExtent >

Definition at line 23 of file BoxSphereBounds.h.

Member Typedef Documentation

◆ FReal

template<typename T , typename TExtent >

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

Definition at line 25 of file BoxSphereBounds.h.

Constructor & Destructor Documentation

◆ TBoxSphereBounds() [1/8]

template<typename T , typename TExtent >

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

inline

Default constructor.

Definition at line 39 of file BoxSphereBounds.h.

◆ TBoxSphereBounds() [2/8]

template<typename T , typename TExtent >

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

inlineexplicit

Creates and initializes a new instance.

Parameters

EForceInit Force Init Enum.

Definition at line 46 of file BoxSphereBounds.h.

◆ 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.

Definition at line 61 of file BoxSphereBounds.h.

◆ 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.

Definition at line 75 of file BoxSphereBounds.h.

◆ 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.

Definition at line 93 of file BoxSphereBounds.h.

◆ 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.

Definition at line 107 of file BoxSphereBounds.h.

◆ TBoxSphereBounds() [7/8]

template<typename T , typename TExtent >

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

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.

Definition at line 353 of file BoxSphereBounds.h.

◆ TBoxSphereBounds() [8/8]

template<typename T , typename TExtent >

template<typename TFrom , typename TExtentFrom , TEMPLATE_REQUIRES(!(std::is_same_v< T, TFrom > &&std::is_same_v< TExtent, TExtentFrom >)) >

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

inlineexplicit

Definition at line 128 of file BoxSphereBounds.h.

Member Function Documentation

◆ BoxesIntersect()

template<typename T , typename TExtent >

static FORCEINLINE 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.

Definition at line 195 of file BoxSphereBounds.h.

◆ ComputeSquaredDistanceFromBoxToPoint()

template<typename T , typename TExtent >

FORCEINLINE 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.

Definition at line 167 of file BoxSphereBounds.h.

◆ ContainsNaN()

template<typename T , typename TExtent >

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

inline

Definition at line 303 of file BoxSphereBounds.h.

◆ DiagnosticCheckNaN()

template<typename T , typename TExtent >

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

inline

Definition at line 300 of file BoxSphereBounds.h.

◆ ExpandBy()

template<typename T , typename TExtent >

FORCEINLINE 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.

Definition at line 242 of file BoxSphereBounds.h.

◆ GetBox()

template<typename T , typename TExtent >

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

inline

Gets the bounding box.

Returns: The bounding box.

Definition at line 205 of file BoxSphereBounds.h.

◆ 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

Definition at line 216 of file BoxSphereBounds.h.

◆ GetSphere()

template<typename T , typename TExtent >

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

inline

Gets the bounding sphere.

Returns: The bounding sphere.

Definition at line 231 of file BoxSphereBounds.h.

◆ operator!=()

template<typename T , typename TExtent >

FORCEINLINE 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.

Definition at line 406 of file BoxSphereBounds.h.

◆ operator+()

template<typename T , typename TExtent >

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

Constructs a bounding volume containing both this and B.

Parameters

Other The other bounding volume.

Returns: The combined bounding volume.

Definition at line 381 of file BoxSphereBounds.h.

◆ operator==()

template<typename T , typename TExtent >

FORCEINLINE 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.

Definition at line 400 of file BoxSphereBounds.h.

◆ Serialize()

template<typename T , typename TExtent >

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

Definition at line 412 of file BoxSphereBounds.h.

◆ SerializeFromMismatchedTag()

bool FBoxSphereBounds3d::SerializeFromMismatchedTag	(	FName	StructTag,
		FArchive &	Ar )

inline

Definition at line 499 of file BoxSphereBounds.h.

◆ SpheresIntersect()

template<typename T , typename TExtent >

static FORCEINLINE 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.

Definition at line 183 of file BoxSphereBounds.h.

◆ ToString()

template<typename T , typename TExtent >

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

Get a textual representation of this bounding box.

Returns: Text describing the bounding box.

Definition at line 419 of file BoxSphereBounds.h.

◆ 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.

Definition at line 425 of file BoxSphereBounds.h.

◆ 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.

Definition at line 478 of file BoxSphereBounds.h.

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.

Definition at line 275 of file BoxSphereBounds.h.

Member Data Documentation

◆ BoxExtent

template<typename T , typename TExtent >

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

Holds the extent of the bounding box.

Definition at line 31 of file BoxSphereBounds.h.

◆ Origin

template<typename T , typename TExtent >

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

Holds the origin of the bounding box and sphere.

Definition at line 28 of file BoxSphereBounds.h.

◆ SphereRadius

template<typename T , typename TExtent >

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

Holds the radius of the bounding sphere.

Definition at line 34 of file BoxSphereBounds.h.

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

C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/Math/MathFwd.h
C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/Math/BoxSphereBounds.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Detailed Description

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