UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::Geometry::TCapsule3< T > Struct Template Reference

#include <CapsuleTypes.h>

Public Member Functions

 TCapsule3 ()=default
 
 TCapsule3 (const TSegment3< T > &SegmentIn, T RadiusIn)
 
 TCapsule3 (const TVector< T > &StartPoint, const TVector< T > &EndPoint, T RadiusIn)
 
const TVector< T > & Center () const
 
const TVector< T > & Direction () const
 
Length () const
 
Extent () const
 
Volume () const
 
TAxisAlignedBox3< T > GetBounds () const
 
TOrientedBox3< T > GetOrientedBounds () const
 
bool Contains (const TVector< T > &Point) const
 
DistanceSquared (const TVector< T > &Point) const
 
SignedDistance (const TVector< T > &Point) const
 

Static Public Member Functions

staticVolume (T Radius, T Extent)
 

Public Attributes

TSegment3< T > Segment
 
Radius = (T)0
 

Constructor & Destructor Documentation

◆ TCapsule3() [1/3]

template<typename T >
UE::Geometry::TCapsule3< T >::TCapsule3 ( )
default

◆ TCapsule3() [2/3]

template<typename T >
UE::Geometry::TCapsule3< T >::TCapsule3 ( const TSegment3< T > &  SegmentIn,
RadiusIn 
)
inline

◆ TCapsule3() [3/3]

template<typename T >
UE::Geometry::TCapsule3< T >::TCapsule3 ( const TVector< T > &  StartPoint,
const TVector< T > &  EndPoint,
RadiusIn 
)
inline

Member Function Documentation

◆ Center()

template<typename T >
const TVector< T > & UE::Geometry::TCapsule3< T >::Center ( ) const
inline
Returns
Center of capsule line segment

◆ Contains()

template<typename T >
bool UE::Geometry::TCapsule3< T >::Contains ( const TVector< T > &  Point) const
inline
Returns
true if Capsule contains the given Point

◆ Direction()

template<typename T >
const TVector< T > & UE::Geometry::TCapsule3< T >::Direction ( ) const
inline
Returns
Direction of capsule line segment

◆ DistanceSquared()

template<typename T >
T UE::Geometry::TCapsule3< T >::DistanceSquared ( const TVector< T > &  Point) const
inline
Returns
minimum squared distance from Point to Capsule surface for points outside capsule, 0 for points inside

◆ Extent()

template<typename T >
T UE::Geometry::TCapsule3< T >::Extent ( ) const
inline
Returns
Extent (half-length) of capsule line segment

◆ GetBounds()

template<typename T >
TAxisAlignedBox3< T > UE::Geometry::TCapsule3< T >::GetBounds ( ) const
inline
Returns
Bounding Box of Capsule

◆ GetOrientedBounds()

template<typename T >
TOrientedBox3< T > UE::Geometry::TCapsule3< T >::GetOrientedBounds ( ) const
inline
Returns
Oriented Bounding Box of Capsule (orthogonal axes are arbitrary)

◆ Length()

template<typename T >
T UE::Geometry::TCapsule3< T >::Length ( ) const
inline
Returns
Length of capsule line segment

◆ SignedDistance()

template<typename T >
T UE::Geometry::TCapsule3< T >::SignedDistance ( const TVector< T > &  Point) const
inline
Returns
signed distance from Point to Capsule surface. Points inside capsule return negative distance.

◆ Volume() [1/2]

template<typename T >
T UE::Geometry::TCapsule3< T >::Volume ( ) const
inline
Returns
Volume of Capsule

◆ Volume() [2/2]

template<typename T >
static T UE::Geometry::TCapsule3< T >::Volume ( Radius,
Extent 
)
inlinestatic
Returns
Volume of Capsule with given Radius and Extent (half-length)

Member Data Documentation

◆ Radius

template<typename T >
T UE::Geometry::TCapsule3< T >::Radius = (T)0

Radius of the capsule

◆ Segment

template<typename T >
TSegment3<T> UE::Geometry::TCapsule3< T >::Segment

Line segment of the capsule


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