UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Chaos::FImplicitObjectUnion Class Reference

#include <ImplicitObjectUnion.h>

+ Inheritance diagram for Chaos::FImplicitObjectUnion:

Classes

union  FFLags
 

Public Member Functions

 FImplicitObjectUnion (TArray< TUniquePtr< FImplicitObject > > &&Objects)
 
CHAOS_API FImplicitObjectUnion (TArray< Chaos::FImplicitObjectPtr > &&Objects)
 
 FImplicitObjectUnion (const FImplicitObjectUnion &Other)=delete
 
CHAOS_API FImplicitObjectUnion (FImplicitObjectUnion &&Other)
 
virtual CHAOS_API ~FImplicitObjectUnion ()
 
void Combine (TArray< TUniquePtr< FImplicitObject > > &Objects)
 
CHAOS_API void Combine (TArray< Chaos::FImplicitObjectPtr > &Objects)
 
CHAOS_API void RemoveAt (int32 RemoveIndex)
 
CHAOS_API void RemoveAtSortedIndices (const TArrayView< const int32 > &InIndices)
 
int32 GetNumRootObjects () const
 
int32 GetNumLeafObjects () const
 
void SetAllowBVH (const bool bInAllowBVH)
 
void SetLocked (const bool bInLocked)
 
void SetLockedRecursive (const bool bInLocked)
 
bool IsLocked () const
 
virtual CHAOS_API Chaos::FImplicitObjectPtr CopyGeometry () const
 
virtual CHAOS_API Chaos::FImplicitObjectPtr CopyGeometryWithScale (const FVec3 &Scale) const override
 
virtual CHAOS_API Chaos::FImplicitObjectPtr DeepCopyGeometry () const
 
virtual CHAOS_API Chaos::FImplicitObjectPtr DeepCopyGeometryWithScale (const FVec3 &Scale) const override
 
virtual FReal PhiWithNormal (const FVec3 &x, FVec3 &Normal) const override
 
virtual const FAABB3 BoundingBox () const override
 
virtual void AccumulateAllImplicitObjects (TArray< Pair< const FImplicitObject *, FRigidTransform3 > > &Out, const FRigidTransform3 &ParentTM) const
 
virtual CHAOS_API void FindAllIntersectingObjects (TArray< Pair< const FImplicitObject *, FRigidTransform3 > > &Out, const FAABB3 &LocalBounds) const
 
virtual void CacheAllImplicitObjects ()
 
virtual bool Raycast (const FVec3 &StartPoint, const FVec3 &Dir, const FReal Length, const FReal Thickness, FReal &OutTime, FVec3 &OutPosition, FVec3 &OutNormal, int32 &OutFaceIndex) const override
 
virtual bool Overlap (const FVec3 &Point, const FReal Thickness) const override
 
virtual CHAOS_API void Serialize (FChaosArchive &Ar) override
 
virtual bool IsValidGeometry () const
 
const TArray< Chaos::FImplicitObjectPtr > & GetObjects () const
 
TArray< Chaos::FImplicitObjectPtr > & GetObjects ()
 
CHAOS_API void ForEachObject (TFunctionRef< bool(const FImplicitObject &, const FRigidTransform3 &)> Lambda) const
 
virtual uint32 GetTypeHash () const override
 
const Private::FImplicitBVH * GetBVH () const
 
virtual FName GetTypeName () const
 
- 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_DERIVED * GetObject ()
 
template<class T_DERIVED >
const T_DERIVED * GetObject () const
 
template<class T_DERIVED >
const T_DERIVED & GetObjectChecked () const
 
template<class T_DERIVED >
T_DERIVED & GetObjectChecked ()
 
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 FImplicitObject * Duplicate () const
 
virtual TUniquePtr< FImplicitObject > Copy () const
 
virtual TUniquePtr< FImplicitObject > CopyWithScale (const FVec3 &Scale) const
 
virtual TUniquePtr< FImplicitObject > DeepCopy () const
 
virtual TUniquePtr< FImplicitObject > DeepCopyWithScale (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, bool > FindDeepestIntersection (const FImplicitObject *Other, const FBVHParticles *Particles, const FMatrix33 &OtherToLocalTransform, const FReal Thickness) const
 
CHAOS_API Pair< FVec3, bool > FindDeepestIntersection (const FImplicitObject *Other, const FParticles *Particles, const FMatrix33 &OtherToLocalTransform, const FReal Thickness) const
 
CHAOS_API Pair< FVec3, bool > FindClosestIntersection (const FVec3 &StartPoint, const FVec3 &EndPoint, const FReal Thickness) 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 void AccumulateAllSerializableImplicitObjects (TArray< Pair< TSerializablePtr< FImplicitObject >, FRigidTransform3 > > &Out, const FRigidTransform3 &ParentTM, TSerializablePtr< FImplicitObject > This) const
 
virtual FString ToString () const
 
CHAOS_API void SerializeImp (FArchive &Ar)
 
virtual void Serialize (FArchive &Ar)
 
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
 
- Public Member Functions inherited from Chaos::FChaosRefCountedObject
 FChaosRefCountedObject ()
 
virtual ~FChaosRefCountedObject ()
 
 FChaosRefCountedObject (const FChaosRefCountedObject &Rhs)=delete
 
FChaosRefCountedObject & operator= (const FChaosRefCountedObject &Rhs)=delete
 
uint32 AddRef () const
 
uint32 Release () const
 
uint32 GetRefCount () const
 
void MakePersistent () const
 

Static Public Member Functions

static FORCEINLINE constexpr EImplicitObjectType StaticType ()
 
static CHAOS_API const FName GetTypeName (const EImplicitObjectType InType)
 
- Static Public Member Functions inherited from Chaos::FImplicitObject
static CHAOS_API FImplicitObject * SerializationFactory (FChaosArchive &Ar, FImplicitObject *Obj)
 
static int32 GetOffsetOfType ()
 
static int32 GetOffsetOfMargin ()
 
static constexpr EImplicitObjectType StaticType ()
 
static CHAOS_API FArchive & SerializeLegacyHelper (FArchive &Ar, TUniquePtr< FImplicitObject > &Value)
 
static CHAOS_API const FName GetTypeName (const EImplicitObjectType InType)
 

Protected Member Functions

virtual Pair< FVec3, bool > FindClosestIntersectionImp (const FVec3 &StartPoint, const FVec3 &EndPoint, const FReal Thickness) const override
 
virtual CHAOS_API int32 CountObjectsInHierarchyImpl () const override final
 
virtual CHAOS_API int32 CountLeafObjectsInHierarchyImpl () const override final
 
virtual CHAOS_API void VisitOverlappingLeafObjectsImpl (const FAABB3 &LocalBounds, const FRigidTransform3 &ObjectTransform, const int32 RootObjectIndex, int32 &ObjectIndex, int32 &LeafObjectIndex, const FImplicitHierarchyVisitor &VisitorFunc) const override final
 
virtual CHAOS_API void VisitLeafObjectsImpl (const FRigidTransform3 &ObjectTransform, const int32 RootObjectIndex, int32 &ObjectIndex, int32 &LeafObjectIndex, const FImplicitHierarchyVisitor &VisitorFunc) const override final
 
virtual CHAOS_API bool VisitObjectsImpl (const FRigidTransform3 &ObjectTransform, const int32 RootObjectIndex, int32 &ObjectIndex, int32 &LeafObjectIndex, const FImplicitHierarchyVisitorBool &VisitorFunc) const override final
 
virtual CHAOS_API bool IsOverlappingBoundsImpl (const FAABB3 &LocalBounds) const override final
 
CHAOS_API FImplicitObjectUnion ()
 
CHAOS_API void SetNumLeafObjects (const int32 InNumLeafObjects)
 
CHAOS_API void CreateBVH ()
 
CHAOS_API void DestroyBVH ()
 
CHAOS_API void RebuildBVH ()
 
CHAOS_API void LegacySerializeBVH (FChaosArchive &Ar)
 
bool HasValidBVH () const
 
CHAOS_API void CheckNotLocked () const
 
- Protected Member Functions inherited from Chaos::FImplicitObject
void SetMargin (FReal InMargin)
 
void SetMargin (FRealSingle InMargin)
 

Protected Attributes

friend FImplicitObject
 
TArray< Chaos::FImplicitObjectPtr > MObjects
 
FAABB3 MLocalBoundingBox
 
TUniquePtr< Private::FImplicitBVH > BVH
 
int32 NumLeafObjects
 
FFLags Flags
 
- Protected Attributes inherited from Chaos::FImplicitObject
FRealSingle Margin
 
bool bIsConvex
 
bool bDoCollide
 
bool bHasBoundingBox
 
bool bIsTracked
 
EImplicitObjectType Type
 
EImplicitObjectType CollisionType
 

Additional Inherited Members

- Public Types inherited from Chaos::FImplicitObject
using TType = FReal
 
- Static Public Attributes inherited from Chaos::FImplicitObject
static constexpr int D = 3
 
- 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)
 

Constructor & Destructor Documentation

◆ FImplicitObjectUnion() [1/5]

Chaos::FImplicitObjectUnion::FImplicitObjectUnion ( TArray< TUniquePtr< FImplicitObject > > &&  Objects)

◆ FImplicitObjectUnion() [2/5]

Chaos::FImplicitObjectUnion::FImplicitObjectUnion ( TArray< Chaos::FImplicitObjectPtr > &&  Objects)

◆ FImplicitObjectUnion() [3/5]

Chaos::FImplicitObjectUnion::FImplicitObjectUnion ( const FImplicitObjectUnion &  Other)
delete

◆ FImplicitObjectUnion() [4/5]

Chaos::FImplicitObjectUnion::FImplicitObjectUnion ( FImplicitObjectUnion &&  Other)

◆ ~FImplicitObjectUnion()

Chaos::FImplicitObjectUnion::~FImplicitObjectUnion ( )
virtualdefault

◆ FImplicitObjectUnion() [5/5]

Chaos::FImplicitObjectUnion::FImplicitObjectUnion ( )
protected

Member Function Documentation

◆ AccumulateAllImplicitObjects()

virtual void Chaos::FImplicitObjectUnion::AccumulateAllImplicitObjects ( TArray< Pair< const FImplicitObject *, FRigidTransform3 > > &  Out,
const FRigidTransform3 &  ParentTM 
) const
inlinevirtual

Reimplemented from Chaos::FImplicitObject.

◆ BoundingBox()

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

Reimplemented from Chaos::FImplicitObject.

◆ CacheAllImplicitObjects()

virtual void Chaos::FImplicitObjectUnion::CacheAllImplicitObjects ( )
inlinevirtual

◆ CheckNotLocked()

void Chaos::FImplicitObjectUnion::CheckNotLocked ( ) const
protected

◆ Combine() [1/2]

void Chaos::FImplicitObjectUnion::Combine ( TArray< Chaos::FImplicitObjectPtr > &  Objects)

◆ Combine() [2/2]

void Chaos::FImplicitObjectUnion::Combine ( TArray< TUniquePtr< FImplicitObject > > &  Objects)
inline

◆ CopyGeometry()

Chaos::FImplicitObjectPtr Chaos::FImplicitObjectUnion::CopyGeometry ( ) const
virtual

Reimplemented from Chaos::FImplicitObject.

◆ CopyGeometryWithScale()

Chaos::FImplicitObjectPtr Chaos::FImplicitObjectUnion::CopyGeometryWithScale ( const FVec3 &  Scale) const
overridevirtual

Reimplemented from Chaos::FImplicitObject.

◆ CountLeafObjectsInHierarchyImpl()

int32 Chaos::FImplicitObjectUnion::CountLeafObjectsInHierarchyImpl ( ) const
finaloverrideprotectedvirtual

Reimplemented from Chaos::FImplicitObject.

◆ CountObjectsInHierarchyImpl()

int32 Chaos::FImplicitObjectUnion::CountObjectsInHierarchyImpl ( ) const
finaloverrideprotectedvirtual

Reimplemented from Chaos::FImplicitObject.

◆ CreateBVH()

void Chaos::FImplicitObjectUnion::CreateBVH ( )
protected

◆ DeepCopyGeometry()

Chaos::FImplicitObjectPtr Chaos::FImplicitObjectUnion::DeepCopyGeometry ( ) const
virtual

Reimplemented from Chaos::FImplicitObject.

◆ DeepCopyGeometryWithScale()

Chaos::FImplicitObjectPtr Chaos::FImplicitObjectUnion::DeepCopyGeometryWithScale ( const FVec3 &  Scale) const
overridevirtual

Reimplemented from Chaos::FImplicitObject.

◆ DestroyBVH()

void Chaos::FImplicitObjectUnion::DestroyBVH ( )
protected

◆ FindAllIntersectingObjects()

void Chaos::FImplicitObjectUnion::FindAllIntersectingObjects ( TArray< Pair< const FImplicitObject *, FRigidTransform3 > > &  Out,
const FAABB3 &  LocalBounds 
) const
virtual

Reimplemented from Chaos::FImplicitObject.

◆ FindClosestIntersectionImp()

virtual Pair< FVec3, bool > Chaos::FImplicitObjectUnion::FindClosestIntersectionImp ( const FVec3 &  StartPoint,
const FVec3 &  EndPoint,
const FReal  Thickness 
) const
inlineoverrideprotectedvirtual

Reimplemented from Chaos::FImplicitObject.

◆ ForEachObject()

void Chaos::FImplicitObjectUnion::ForEachObject ( TFunctionRef< bool(const FImplicitObject &, const FRigidTransform3 &)>  Lambda) const

◆ GetBVH()

const Private::FImplicitBVH * Chaos::FImplicitObjectUnion::GetBVH ( ) const
inline

◆ GetNumLeafObjects()

int32 Chaos::FImplicitObjectUnion::GetNumLeafObjects ( ) const
inline

◆ GetNumRootObjects()

int32 Chaos::FImplicitObjectUnion::GetNumRootObjects ( ) const
inline

◆ GetObjects() [1/2]

TArray< Chaos::FImplicitObjectPtr > & Chaos::FImplicitObjectUnion::GetObjects ( )
inline

◆ GetObjects() [2/2]

const TArray< Chaos::FImplicitObjectPtr > & Chaos::FImplicitObjectUnion::GetObjects ( ) const
inline

◆ GetTypeHash()

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

Implements Chaos::FImplicitObject.

◆ GetTypeName() [1/2]

virtual FName Chaos::FImplicitObject::GetTypeName ( ) const
inlinevirtual

Reimplemented from Chaos::FImplicitObject.

◆ GetTypeName() [2/2]

const FName Chaos::FImplicitObject::GetTypeName ( const EImplicitObjectType  InType)
static

◆ HasValidBVH()

bool Chaos::FImplicitObjectUnion::HasValidBVH ( ) const
protected

◆ IsLocked()

bool Chaos::FImplicitObjectUnion::IsLocked ( ) const
inline

◆ IsOverlappingBoundsImpl()

bool Chaos::FImplicitObjectUnion::IsOverlappingBoundsImpl ( const FAABB3 &  LocalBounds) const
finaloverrideprotectedvirtual

Reimplemented from Chaos::FImplicitObject.

◆ IsValidGeometry()

virtual bool Chaos::FImplicitObjectUnion::IsValidGeometry ( ) const
inlinevirtual

Reimplemented from Chaos::FImplicitObject.

◆ LegacySerializeBVH()

void Chaos::FImplicitObjectUnion::LegacySerializeBVH ( FChaosArchive &  Ar)
protected

◆ Overlap()

virtual bool Chaos::FImplicitObjectUnion::Overlap ( const FVec3 &  Point,
const FReal  Thickness 
) const
inlineoverridevirtual

Reimplemented from Chaos::FImplicitObject.

◆ PhiWithNormal()

virtual FReal Chaos::FImplicitObjectUnion::PhiWithNormal ( const FVec3 &  x,
FVec3 &  Normal 
) const
inlineoverridevirtual

Implements Chaos::FImplicitObject.

◆ Raycast()

virtual bool Chaos::FImplicitObjectUnion::Raycast ( const FVec3 &  StartPoint,
const FVec3 &  Dir,
const FReal  Length,
const FReal  Thickness,
FReal &  OutTime,
FVec3 &  OutPosition,
FVec3 &  OutNormal,
int32 &  OutFaceIndex 
) const
inlineoverridevirtual

Reimplemented from Chaos::FImplicitObject.

◆ RebuildBVH()

void Chaos::FImplicitObjectUnion::RebuildBVH ( )
protected

◆ RemoveAt()

void Chaos::FImplicitObjectUnion::RemoveAt ( int32  RemoveIndex)

◆ RemoveAtSortedIndices()

void Chaos::FImplicitObjectUnion::RemoveAtSortedIndices ( const TArrayView< const int32 > &  InIndices)

◆ Serialize()

void Chaos::FImplicitObjectUnion::Serialize ( FChaosArchive &  Ar)
overridevirtual

Reimplemented from Chaos::FImplicitObject.

◆ SetAllowBVH()

void Chaos::FImplicitObjectUnion::SetAllowBVH ( const bool  bInAllowBVH)
inline

◆ SetLocked()

void Chaos::FImplicitObjectUnion::SetLocked ( const bool  bInLocked)
inline

◆ SetLockedRecursive()

void Chaos::FImplicitObjectUnion::SetLockedRecursive ( const bool  bInLocked)
inline

◆ SetNumLeafObjects()

void Chaos::FImplicitObjectUnion::SetNumLeafObjects ( const int32  InNumLeafObjects)
protected

◆ StaticType()

static FORCEINLINE constexpr EImplicitObjectType Chaos::FImplicitObjectUnion::StaticType ( )
inlinestaticconstexpr

◆ VisitLeafObjectsImpl()

void Chaos::FImplicitObjectUnion::VisitLeafObjectsImpl ( const FRigidTransform3 &  ObjectTransform,
const int32  RootObjectIndex,
int32 &  ObjectIndex,
int32 &  LeafObjectIndex,
const FImplicitHierarchyVisitor &  VisitorFunc 
) const
finaloverrideprotectedvirtual

Reimplemented from Chaos::FImplicitObject.

◆ VisitObjectsImpl()

bool Chaos::FImplicitObjectUnion::VisitObjectsImpl ( const FRigidTransform3 &  ObjectTransform,
const int32  RootObjectIndex,
int32 &  ObjectIndex,
int32 &  LeafObjectIndex,
const FImplicitHierarchyVisitorBool &  VisitorFunc 
) const
finaloverrideprotectedvirtual

Reimplemented from Chaos::FImplicitObject.

◆ VisitOverlappingLeafObjectsImpl()

void Chaos::FImplicitObjectUnion::VisitOverlappingLeafObjectsImpl ( const FAABB3 &  LocalBounds,
const FRigidTransform3 &  ObjectTransform,
const int32  RootObjectIndex,
int32 &  ObjectIndex,
int32 &  LeafObjectIndex,
const FImplicitHierarchyVisitor &  VisitorFunc 
) const
finaloverrideprotectedvirtual

Reimplemented from Chaos::FImplicitObject.

Member Data Documentation

◆ BVH

TUniquePtr<Private::FImplicitBVH> Chaos::FImplicitObjectUnion::BVH
protected

◆ FImplicitObject

friend Chaos::FImplicitObjectUnion::FImplicitObject
protected

◆ Flags

FFLags Chaos::FImplicitObjectUnion::Flags
protected

◆ MLocalBoundingBox

FAABB3 Chaos::FImplicitObjectUnion::MLocalBoundingBox
protected

◆ MObjects

TArray<Chaos::FImplicitObjectPtr> Chaos::FImplicitObjectUnion::MObjects
protected

◆ NumLeafObjects

int32 Chaos::FImplicitObjectUnion::NumLeafObjects
protected
The documentation for this class was generated from the following files: