1. Epic GamesDeveloper
  3. TBoxSphereBounds

TBoxSphereBounds

API > API/Runtime > API/Runtime/Core

   
Name TBoxSphereBounds
Type struct
Header File /Engine/Source/Runtime/Core/Public/Math/BoxSphereBounds.h
Include Path #include "Math/BoxSphereBounds.h"
Source /Engine/Source/Runtime/Core/Public/Math/MathFwd.h

Syntax

template<typename T, typename TExtent>  
struct TBoxSphereBounds

Constructors

Name Remarks Include Path Unreal Specifiers
Default constructor. Math/BoxSphereBounds.h  
Creates and initializes a new instance. Math/BoxSphereBounds.h  

TBoxSphereBounds ( const TBox< T >& Box
)

 Creates and initializes a new instance the given Box. Math/BoxSphereBounds.h  

TBoxSphereBounds ( const TSphere< T >& Sphere
)

 Creates and initializes a new instance for the given sphere. Math/BoxSphereBounds.h  

TBoxSphereBounds ( const TBoxSphereBounds< TFrom, TExtentFrom >& From
)

 Conversion to other type. Math/BoxSphereBounds.h  

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

 Creates and initializes a new instance from the given Box and Sphere. Math/BoxSphereBounds.h  

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

 Creates and initializes a new instance from the given set of points. Math/BoxSphereBounds.h  

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

 Creates and initializes a new instance from the specified parameters. Math/BoxSphereBounds.h  

Structs

Name Remarks
Builder Utility class to build a TBoxSphereBounds by adding other math primitives.

Typedefs

Name Type Remarks Include Path
FReal T   Math/BoxSphereBounds.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
BoxExtent TVector< TExtent > Holds the extent of the bounding box. Math/BoxSphereBounds.h  
Origin TVector< T > Holds the origin of the bounding box and sphere. Math/BoxSphereBounds.h  
SphereRadius TExtent Holds the radius of the bounding sphere. Math/BoxSphereBounds.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 Calculates the squared distance from a point to a bounding box Math/BoxSphereBounds.h  

bool ContainsNaN()

   Math/BoxSphereBounds.h  

void DiagnosticCheckNaN()

   Math/BoxSphereBounds.h  

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

 Increase the size of the box and sphere by a given size. Math/BoxSphereBounds.h  

TBox< T > GetBox()

 Gets the bounding box. Math/BoxSphereBounds.h  

TVector< T > GetBoxExtrema ( uint32 Extrema
) const

 Gets the extrema for the bounding box. Math/BoxSphereBounds.h  

TSphere< T > GetSphere()

 Gets the bounding sphere. Math/BoxSphereBounds.h  

bool Serialize ( FArchive& Ar
)

   Math/BoxSphereBounds.h  

bool SerializeFromMismatchedTag ( FName StructTag,
FArchive& Ar
)

   Math/BoxSphereBounds.h  

FString ToString()

 Get a textual representation of this bounding box. Math/BoxSphereBounds.h  

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

 Gets a bounding volume transformed by a matrix. Math/BoxSphereBounds.h  

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

 Gets a bounding volume transformed by a FTransform object. Math/BoxSphereBounds.h  

Static

Name Remarks Include Path Unreal Specifiers

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

 Test whether the boxes from two BoxSphereBounds intersect/overlap. Math/BoxSphereBounds.h  

static bool SpheresIntersect ( const TBoxSphereBounds< T, TExtent >& A,
const TBoxSphereBounds< T, TExtent >& B,
TExtent Tolerance
)

 Test whether the spheres from two BoxSphereBounds intersect/overlap. Math/BoxSphereBounds.h  

Operators

Name Remarks Include Path Unreal Specifiers

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

 Compare bounding volume this and Other. Math/BoxSphereBounds.h  

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

 Constructs a bounding volume containing both this and B. Math/BoxSphereBounds.h  

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

 Compare bounding volume this and Other. Math/BoxSphereBounds.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page