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

#include <MLLevelset.h>

+ Inheritance diagram for Chaos::FMLLevelSet:

Public Member Functions

CHAOS_API FMLLevelSet (FMLLevelSetImportData &&MLLevelSetImportData)
 
 FMLLevelSet (const FMLLevelSet &Other)=delete
 
CHAOS_API FMLLevelSet (FMLLevelSet &&Other)
 
virtual CHAOS_API ~FMLLevelSet ()
 
virtual CHAOS_API Chaos::FImplicitObjectPtr CopyGeometry () const override
 
virtual CHAOS_API Chaos::FImplicitObjectPtr CopyGeometryWithScale (const FVec3 &Scale) const override
 
virtual CHAOS_API FReal PhiWithNormal (const FVec3 &x, FVec3 &Normal) const override
 
CHAOS_API void BatchPhiWithNormal (const TConstArrayView< Softs::FPAndInvM > PAndInvMArray, const Softs::FSolverRigidTransform3 &SolverToThis, TArray< Softs::FSolverReal > &OutBatchPhis, TArray< Softs::FSolverVec3 > &OutBatchNormals, const Chaos::Softs::FSolverReal CollisionThickness, const int32 MLLevelsetThread, const int32 BatchBegin, const int32 BatchEnd) const
 
CHAOS_API FReal SignedDistance (const FVec3 &x) const
 
CHAOS_API void UpdateActiveBonesRelativeTransforms (TArray< FTransform > &InActiveBonesRelativeTransforms)
 
CHAOS_API void UpdateActiveBonesRelativeTransformsAndUpdateDebugPhi (TArray< FTransform > &InActiveBonesRelativeTransforms)
 
CHAOS_API void UpdateNeuralInferencesNumber (const int32 InNeuralInferencesNumber)
 
const int32 GetNumberOfActiveBones () const
 
const TArray< FName > & GetActiveBoneNames () const
 
virtual const FAABB3 BoundingBox () const override
 
const FVector3f GetTrainingGridMin () const
 
const FVector3f GetTrainingGridVector (int32 Index) const
 
const TUniformGrid< FReal, 3 > & GetGrid () const
 
const TArrayND< FReal, 3 > & GetPhiArray () const
 
FORCEINLINE void SerializeImp (FArchive &Ar)
 
virtual void Serialize (FChaosArchive &Ar) override
 
virtual void Serialize (FArchive &Ar) override
 
CHAOS_API void GetZeroIsosurfaceGridCellFaces (TArray< FVector3f > &Vertices, TArray< FIntVector > &Tris) const
 
CHAOS_API void GetInteriorCells (TArray< TVec3< int32 > > &InteriorCells, const FReal InteriorThreshold) const
 
CHAOS_API void CreatePhiFromMLModel ()
 
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::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 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 FORCEINLINE constexpr EImplicitObjectType StaticType ()
 
- 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

◆ FMLLevelSet() [1/3]

Chaos::FMLLevelSet::FMLLevelSet ( FMLLevelSetImportData &&  MLLevelSetImportData)

◆ FMLLevelSet() [2/3]

Chaos::FMLLevelSet::FMLLevelSet ( const FMLLevelSet Other)
delete

◆ FMLLevelSet() [3/3]

Chaos::FMLLevelSet::FMLLevelSet ( FMLLevelSet &&  Other)

◆ ~FMLLevelSet()

Chaos::FMLLevelSet::~FMLLevelSet ( )
virtual

Member Function Documentation

◆ BatchPhiWithNormal()

void Chaos::FMLLevelSet::BatchPhiWithNormal ( const TConstArrayView< Softs::FPAndInvM PAndInvMArray,
const Softs::FSolverRigidTransform3 SolverToThis,
TArray< Softs::FSolverReal > &  OutBatchPhis,
TArray< Softs::FSolverVec3 > &  OutBatchNormals,
const Chaos::Softs::FSolverReal  CollisionThickness,
const int32  MLLevelsetThread,
const int32  BatchBegin,
const int32  BatchEnd 
) const

◆ BoundingBox()

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

Reimplemented from Chaos::FImplicitObject.

◆ CopyGeometry()

Chaos::FImplicitObjectPtr Chaos::FMLLevelSet::CopyGeometry ( ) const
overridevirtual

Reimplemented from Chaos::FImplicitObject.

◆ CopyGeometryWithScale()

Chaos::FImplicitObjectPtr Chaos::FMLLevelSet::CopyGeometryWithScale ( const FVec3 Scale) const
overridevirtual

Reimplemented from Chaos::FImplicitObject.

◆ CreatePhiFromMLModel()

void Chaos::FMLLevelSet::CreatePhiFromMLModel ( )

◆ GetActiveBoneNames()

const TArray< FName > & Chaos::FMLLevelSet::GetActiveBoneNames ( ) const
inline

◆ GetGrid()

const TUniformGrid< FReal, 3 > & Chaos::FMLLevelSet::GetGrid ( ) const
inline

◆ GetInteriorCells()

void Chaos::FMLLevelSet::GetInteriorCells ( TArray< TVec3< int32 > > &  InteriorCells,
const FReal  InteriorThreshold 
) const

This function uses DebugPhi. Is there a better way to do this, which uses the network directly?

◆ GetNumberOfActiveBones()

const int32 Chaos::FMLLevelSet::GetNumberOfActiveBones ( ) const
inline

◆ GetPhiArray()

const TArrayND< FReal, 3 > & Chaos::FMLLevelSet::GetPhiArray ( ) const
inline

◆ GetTrainingGridMin()

const FVector3f Chaos::FMLLevelSet::GetTrainingGridMin ( ) const
inline

◆ GetTrainingGridVector()

const FVector3f Chaos::FMLLevelSet::GetTrainingGridVector ( int32  Index) const
inline

◆ GetTypeHash()

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

◆ GetZeroIsosurfaceGridCellFaces()

void Chaos::FMLLevelSet::GetZeroIsosurfaceGridCellFaces ( TArray< FVector3f > &  Vertices,
TArray< FIntVector > &  Tris 
) const

This function uses DebugPhi. Is there a better way to do this, which uses the network directly?

◆ PhiWithNormal()

FReal Chaos::FMLLevelSet::PhiWithNormal ( const FVec3 x,
FVec3 Normal 
) const
overridevirtual

◆ Serialize() [1/2]

virtual void Chaos::FMLLevelSet::Serialize ( FArchive Ar)
inlineoverridevirtual

Reimplemented from Chaos::FImplicitObject.

◆ Serialize() [2/2]

virtual void Chaos::FMLLevelSet::Serialize ( FChaosArchive Ar)
inlineoverridevirtual

Reimplemented from Chaos::FImplicitObject.

◆ SerializeImp()

FORCEINLINE void Chaos::FMLLevelSet::SerializeImp ( FArchive Ar)
inline

◆ SignedDistance()

FReal Chaos::FMLLevelSet::SignedDistance ( const FVec3 x) const

This function should not be called. MLLevelSets are only BatchPhiWithNormal friendly

◆ StaticType()

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

◆ UpdateActiveBonesRelativeTransforms()

void Chaos::FMLLevelSet::UpdateActiveBonesRelativeTransforms ( TArray< FTransform > &  InActiveBonesRelativeTransforms)

◆ UpdateActiveBonesRelativeTransformsAndUpdateDebugPhi()

void Chaos::FMLLevelSet::UpdateActiveBonesRelativeTransformsAndUpdateDebugPhi ( TArray< FTransform > &  InActiveBonesRelativeTransforms)

◆ UpdateNeuralInferencesNumber()

void Chaos::FMLLevelSet::UpdateNeuralInferencesNumber ( const int32  InNeuralInferencesNumber)

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