UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Chaos::FTaperedCapsule Class Reference

#include <TaperedCapsule.h>

+ Inheritance diagram for Chaos::FTaperedCapsule:

Public Member Functions

 FTaperedCapsule ()
 
 FTaperedCapsule (const FVec3 &X1, const FVec3 &X2, const FReal InRadius1, const FReal InRadius2, const FVec3 &SplitXAxis=FVec3::ZeroVector)
 
 FTaperedCapsule (const FTaperedCapsule &Other)
 
 FTaperedCapsule (FTaperedCapsule &&Other)
 
 ~FTaperedCapsule ()
 
TArray< FVec3ComputeLocalSamplePoints (const int32 NumPoints) const
 
TArray< FVec3ComputeLocalSamplePoints (const FReal PointsPerUnitArea, const int32 MinPoints=0, const int32 MaxPoints=1000) const
 
TArray< FVec3ComputeSamplePoints (const int32 NumPoints) const
 
TArray< FVec3ComputeSamplePoints (const FReal PointsPerUnitArea, const int32 MinPoints, const int32 MaxPoints) const
 
virtual const FAABB3 BoundingBox () const override
 
FReal PhiWithNormal (const FVec3 &x, FVec3 &OutNormal) const
 
FReal GetRadius1 () const
 
FReal GetRadius2 () const
 
FReal GetHeight () const
 
FReal GetSlantHeight () const
 
FVec3 GetX1 () const
 
FVec3 GetX2 () const
 
FVec3 GetOrigin () const
 
const FVec3fGetOriginf () const
 
FVec3 GetInsertion () const
 
FVec3 GetCenter () const
 
bool IsOneSided () const
 
FVec3 GetOneSidedPlaneNormal () const
 
const FVec3fGetOneSidedPlaneNormalf () const
 
FVec3 GetCenterOfMass () const
 
FVec3 GetAxis () const
 
FReal GetArea (const bool IncludeEndCaps=true) const
 
FReal GetVolume () const
 
FMatrix33 GetInertiaTensor (const FReal Mass) const
 
FRotation3 GetRotationOfMass () const
 
virtual uint32 GetTypeHash () const override
 
- Public Member Functions inherited from Chaos::FImplicitObject
CHAOS_API FImplicitObject (int32 Flags, EImplicitObjectType InType=ImplicitObjectType::Unknown)
 
 FImplicitObject (const FImplicitObject &)=delete
 
 FImplicitObject (FImplicitObject &&)=delete
 
virtual CHAOS_API ~FImplicitObject () override
 
template<typename TargetType >
bool IsA () const
 
template<typename TargetType >
const TargetType * AsA () const
 
template<typename TargetType >
TargetType * AsA ()
 
template<typename TargetType >
const TargetType * AsAChecked () const
 
template<typename TargetType >
TargetType * AsAChecked ()
 
template<class T_DERIVED >
T_DERIVEDGetObject ()
 
template<class T_DERIVED >
const T_DERIVEDGetObject () const
 
template<class T_DERIVED >
const T_DERIVEDGetObjectChecked () const
 
template<class T_DERIVED >
T_DERIVEDGetObjectChecked ()
 
virtual EImplicitObjectType GetNestedType () const
 
CHAOS_API EImplicitObjectType GetType () const
 
CHAOS_API EImplicitObjectType GetCollisionType () const
 
void SetCollisionType (EImplicitObjectType InCollisionType)
 
virtual FReal GetRadius () const
 
virtual FRealSingle GetRadiusf () const
 
virtual FReal GetMargin () const
 
virtual FRealSingle GetMarginf () const
 
virtual CHAOS_API bool IsValidGeometry () const
 
virtual CHAOS_API Chaos::FImplicitObjectPtr CopyGeometry () const
 
virtual CHAOS_API Chaos::FImplicitObjectPtr CopyGeometryWithScale (const FVec3 &Scale) const
 
virtual Chaos::FImplicitObjectPtr DeepCopyGeometry () const
 
virtual Chaos::FImplicitObjectPtr DeepCopyGeometryWithScale (const FVec3 &Scale) const
 
virtual FImplicitObjectDuplicate () const
 
virtual TUniquePtr< FImplicitObjectCopy () const
 
virtual TUniquePtr< FImplicitObjectCopyWithScale (const FVec3 &Scale) const
 
virtual TUniquePtr< FImplicitObjectDeepCopy () const
 
virtual TUniquePtr< FImplicitObjectDeepCopyWithScale (const FVec3 &Scale) const
 
CHAOS_API bool IsUnderlyingUnion () const
 
CHAOS_API bool IsUnderlyingMesh () const
 
CHAOS_API FReal SignedDistance (const FVec3 &x) const
 
CHAOS_API FVec3 Normal (const FVec3 &x) const
 
virtual FReal PhiWithNormalScaled (const FVec3 &Pos, const FVec3 &Scale, FVec3 &Normal) const
 
virtual FAABB3 CalculateTransformedBounds (const FRigidTransform3 &Transform) const
 
bool HasBoundingBox () const
 
bool IsConvex () const
 
void SetConvex (const bool Convex=true)
 
void SetDoCollide (const bool Collide)
 
bool GetDoCollide () const
 
CHAOS_API void Track (TSerializablePtr< FImplicitObject > This, const FString &DebugInfo)
 
virtual bool IsPerformanceWarning () const
 
virtual FString PerformanceWarningAndSimplifaction ()
 
CHAOS_API Pair< FVec3, boolFindDeepestIntersection (const FImplicitObject *Other, const FBVHParticles *Particles, const FMatrix33 &OtherToLocalTransform, const FReal Thickness) const
 
CHAOS_API Pair< FVec3, boolFindDeepestIntersection (const FImplicitObject *Other, const FParticles *Particles, const FMatrix33 &OtherToLocalTransform, const FReal Thickness) const
 
CHAOS_API Pair< FVec3, boolFindClosestIntersection (const FVec3 &StartPoint, const FVec3 &EndPoint, const FReal Thickness) const
 
virtual bool Raycast (const FVec3 &StartPoint, const FVec3 &Dir, const FReal Length, const FReal Thickness, FReal &OutTime, FVec3 &OutPosition, FVec3 &OutNormal, int32 &OutFaceIndex) const
 
virtual int32 FindMostOpposingFace (const FVec3 &Position, const FVec3 &UnitDir, int32 HintFaceIndex, FReal SearchDist) const
 
virtual int32 FindMostOpposingFaceScaled (const FVec3 &Position, const FVec3 &UnitDir, int32 HintFaceIndex, FReal SearchDist, const FVec3 &Scale) const
 
virtual int32 FindClosestFaceAndVertices (const FVec3 &Position, TArray< FVec3 > &FaceVertices, FReal SearchDist=0.01f) const
 
virtual FVec3 FindGeometryOpposingNormal (const FVec3 &DenormDir, int32 FaceIndex, const FVec3 &OriginalNormal) const
 
virtual bool Overlap (const FVec3 &Point, const FReal Thickness) const
 
virtual void AccumulateAllImplicitObjects (TArray< Pair< const FImplicitObject *, FRigidTransform3 > > &Out, const FRigidTransform3 &ParentTM) const
 
virtual void AccumulateAllSerializableImplicitObjects (TArray< Pair< TSerializablePtr< FImplicitObject >, FRigidTransform3 > > &Out, const FRigidTransform3 &ParentTM, TSerializablePtr< FImplicitObject > This) const
 
virtual CHAOS_API void FindAllIntersectingObjects (TArray< Pair< const FImplicitObject *, FRigidTransform3 > > &Out, const FAABB3 &LocalBounds) const
 
virtual FString ToString () const
 
CHAOS_API void SerializeImp (FArchive &Ar)
 
virtual void Serialize (FArchive &Ar)
 
virtual CHAOS_API void Serialize (FChaosArchive &Ar)
 
virtual FName GetTypeName () const
 
virtual uint16 GetMaterialIndex (uint32 HintIndex) const
 
int32 CountObjectsInHierarchy () const
 
int32 CountLeafObjectsInHierarchy () const
 
void VisitOverlappingLeafObjects (const FAABB3 &LocalBounds, const FImplicitHierarchyVisitor &Visitor) const
 
void VisitLeafObjects (const FImplicitHierarchyVisitor &Visitor) const
 
void VisitObjects (const FImplicitHierarchyVisitorBool &Visitor) const
 
bool IsOverlappingBounds (const FAABB3 &LocalBounds) const
 
virtual int32 CountObjectsInHierarchyImpl () const
 
virtual int32 CountLeafObjectsInHierarchyImpl () const
 
virtual void VisitOverlappingLeafObjectsImpl (const FAABB3 &LocalBounds, const FRigidTransform3 &ObjectTransform, const int32 RootObjectIndex, int32 &ObjectIndex, int32 &LeafObjectIndex, const FImplicitHierarchyVisitor &VisitorFunc) const
 
virtual void VisitLeafObjectsImpl (const FRigidTransform3 &ObjectTransform, const int32 RootObjectIndex, int32 &ObjectIndex, int32 &LeafObjectIndex, const FImplicitHierarchyVisitor &VisitorFunc) const
 
virtual bool VisitObjectsImpl (const FRigidTransform3 &ObjectTransform, const int32 RootObjectIndex, int32 &ObjectIndex, int32 &LeafObjectIndex, const FImplicitHierarchyVisitorBool &VisitorFunc) const
 
virtual bool IsOverlappingBoundsImpl (const FAABB3 &LocalBounds) const
 
- Public Member Functions inherited from Chaos::FChaosRefCountedObject
 FChaosRefCountedObject ()
 
virtual ~FChaosRefCountedObject ()
 
 FChaosRefCountedObject (const FChaosRefCountedObject &Rhs)=delete
 
FChaosRefCountedObjectoperator= (const FChaosRefCountedObject &Rhs)=delete
 
uint32 AddRef () const
 
uint32 Release () const
 
uint32 GetRefCount () const
 
void MakePersistent () const
 

Static Public Member Functions

static constexpr EImplicitObjectType StaticType ()
 
static FReal GetArea (const FReal Height, const FReal Radius1, const FReal Radius2, const bool IncludeEndCaps)
 
static FReal GetVolume (const FReal Height, const FReal Radius1, const FReal Radius2)
 
static FMatrix33 GetInertiaTensor (const FReal Mass, const FReal Height, const FReal Radius1, const FReal Radius2)
 
static FRotation3 GetRotationOfMass (const FVec3 &Axis)
 
- Static Public Member Functions inherited from Chaos::FImplicitObject
static CHAOS_API FImplicitObjectSerializationFactory (FChaosArchive &Ar, FImplicitObject *Obj)
 
static int32 GetOffsetOfType ()
 
static int32 GetOffsetOfMargin ()
 
static constexpr EImplicitObjectType StaticType ()
 
static CHAOS_API FArchiveSerializeLegacyHelper (FArchive &Ar, TUniquePtr< FImplicitObject > &Value)
 
static CHAOS_API const FName GetTypeName (const EImplicitObjectType InType)
 

Additional Inherited Members

- Public Types inherited from Chaos::FImplicitObject
using TType = FReal
 
- Static Public Attributes inherited from Chaos::FImplicitObject
static constexpr int D = 3
 
- Protected Member Functions inherited from Chaos::FImplicitObject
void SetMargin (FReal InMargin)
 
void SetMargin (FRealSingle InMargin)
 
- Static Protected Member Functions inherited from Chaos::FImplicitObject
static FVec3 ScaleNormalizedHelper (const FVec3 &Normal, const FVec3 &Scale)
 
static FVec3 GetOuterScaledNormal (const FVec3 &InnerNormal, const FVec3 &Scale)
 
static FVec3 GetInnerUnscaledNormal (const FVec3 &OuterNormal, const FVec3 &Scale)
 
- Protected Attributes inherited from Chaos::FImplicitObject
FRealSingle Margin
 
bool bIsConvex
 
bool bDoCollide
 
bool bHasBoundingBox
 
bool bIsTracked
 
EImplicitObjectType Type
 
EImplicitObjectType CollisionType
 

Constructor & Destructor Documentation

◆ FTaperedCapsule() [1/4]

Chaos::FTaperedCapsule::FTaperedCapsule ( )
inline

◆ FTaperedCapsule() [2/4]

Chaos::FTaperedCapsule::FTaperedCapsule ( const FVec3 X1,
const FVec3 X2,
const FReal  InRadius1,
const FReal  InRadius2,
const FVec3 SplitXAxis = FVec3::ZeroVector 
)
inline

◆ FTaperedCapsule() [3/4]

Chaos::FTaperedCapsule::FTaperedCapsule ( const FTaperedCapsule Other)
inline

◆ FTaperedCapsule() [4/4]

Chaos::FTaperedCapsule::FTaperedCapsule ( FTaperedCapsule &&  Other)
inline

◆ ~FTaperedCapsule()

Chaos::FTaperedCapsule::~FTaperedCapsule ( )
inline

Member Function Documentation

◆ BoundingBox()

virtual const FAABB3 Chaos::FTaperedCapsule::BoundingBox ( ) const
inlineoverridevirtual

Reimplemented from Chaos::FImplicitObject.

◆ ComputeLocalSamplePoints() [1/2]

TArray< FVec3 > Chaos::FTaperedCapsule::ComputeLocalSamplePoints ( const FReal  PointsPerUnitArea,
const int32  MinPoints = 0,
const int32  MaxPoints = 1000 
) const
inline

Returns sample points centered about the origin.

PointsPerUnitArea specifies how many points to generate per square unit (cm). 0.5 would generate 1 point per 2 square cm. IncludeEndCaps determines whether or not points are generated on the end caps of the capsule.

◆ ComputeLocalSamplePoints() [2/2]

FORCEINLINE TArray< FVec3 > Chaos::FTaperedCapsule::ComputeLocalSamplePoints ( const int32  NumPoints) const

Returns sample points centered about the origin.

NumPoints specifies how many points to generate. IncludeEndCaps determines whether or not points are generated on the end caps of the capsule.

◆ ComputeSamplePoints() [1/2]

TArray< FVec3 > Chaos::FTaperedCapsule::ComputeSamplePoints ( const FReal  PointsPerUnitArea,
const int32  MinPoints,
const int32  MaxPoints 
) const
inline

Returns sample points at the current location of the capsule.

PointsPerUnitArea specifies how many points to generate per square unit (cm). 0.5 would generate 1 point per 2 square cm. IncludeEndCaps determines whether or not points are generated on the end caps of the capsule.

◆ ComputeSamplePoints() [2/2]

FORCEINLINE TArray< FVec3 > Chaos::FTaperedCapsule::ComputeSamplePoints ( const int32  NumPoints) const

Returns sample points at the current location of the capsule.

NumPoints specifies how many points to generate. IncludeEndCaps determines whether or not points are generated on the end caps of the capsule.

◆ GetArea() [1/2]

FReal Chaos::FTaperedCapsule::GetArea ( const bool  IncludeEndCaps = true) const
inline

◆ GetArea() [2/2]

static FReal Chaos::FTaperedCapsule::GetArea ( const FReal  Height,
const FReal  Radius1,
const FReal  Radius2,
const bool  IncludeEndCaps 
)
inlinestatic

◆ GetAxis()

FVec3 Chaos::FTaperedCapsule::GetAxis ( ) const
inline

◆ GetCenter()

FVec3 Chaos::FTaperedCapsule::GetCenter ( ) const
inline

◆ GetCenterOfMass()

FVec3 Chaos::FTaperedCapsule::GetCenterOfMass ( ) const
inline

Returns the centroid (center of mass).

◆ GetHeight()

FReal Chaos::FTaperedCapsule::GetHeight ( ) const
inline

◆ GetInertiaTensor() [1/2]

FMatrix33 Chaos::FTaperedCapsule::GetInertiaTensor ( const FReal  Mass) const
inline

◆ GetInertiaTensor() [2/2]

static FMatrix33 Chaos::FTaperedCapsule::GetInertiaTensor ( const FReal  Mass,
const FReal  Height,
const FReal  Radius1,
const FReal  Radius2 
)
inlinestatic

◆ GetInsertion()

FVec3 Chaos::FTaperedCapsule::GetInsertion ( ) const
inline

Returns the topmost hemisphere center of capsule .

◆ GetOneSidedPlaneNormal()

FVec3 Chaos::FTaperedCapsule::GetOneSidedPlaneNormal ( ) const
inline

◆ GetOneSidedPlaneNormalf()

const FVec3f & Chaos::FTaperedCapsule::GetOneSidedPlaneNormalf ( ) const
inline

◆ GetOrigin()

FVec3 Chaos::FTaperedCapsule::GetOrigin ( ) const
inline

Returns the bottommost hemisphere center of the capsule.

◆ GetOriginf()

const FVec3f & Chaos::FTaperedCapsule::GetOriginf ( ) const
inline

◆ GetRadius1()

FReal Chaos::FTaperedCapsule::GetRadius1 ( ) const
inline

◆ GetRadius2()

FReal Chaos::FTaperedCapsule::GetRadius2 ( ) const
inline

◆ GetRotationOfMass() [1/2]

FRotation3 Chaos::FTaperedCapsule::GetRotationOfMass ( ) const
inline

◆ GetRotationOfMass() [2/2]

static FRotation3 Chaos::FTaperedCapsule::GetRotationOfMass ( const FVec3 Axis)
inlinestatic

◆ GetSlantHeight()

FReal Chaos::FTaperedCapsule::GetSlantHeight ( ) const
inline

◆ GetTypeHash()

virtual uint32 Chaos::FTaperedCapsule::GetTypeHash ( ) const
inlineoverridevirtual

◆ GetVolume() [1/2]

FReal Chaos::FTaperedCapsule::GetVolume ( ) const
inline

◆ GetVolume() [2/2]

static FReal Chaos::FTaperedCapsule::GetVolume ( const FReal  Height,
const FReal  Radius1,
const FReal  Radius2 
)
inlinestatic

◆ GetX1()

FVec3 Chaos::FTaperedCapsule::GetX1 ( ) const
inline

◆ GetX2()

FVec3 Chaos::FTaperedCapsule::GetX2 ( ) const
inline

◆ IsOneSided()

bool Chaos::FTaperedCapsule::IsOneSided ( ) const
inline

◆ PhiWithNormal()

FReal Chaos::FTaperedCapsule::PhiWithNormal ( const FVec3 x,
FVec3 OutNormal 
) const
inlinevirtual

◆ StaticType()

static constexpr EImplicitObjectType Chaos::FTaperedCapsule::StaticType ( )
inlinestaticconstexpr

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