UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Chaos::TWeightedLatticeImplicitObject< TConcrete > Class Template Reference

#include <WeightedLatticeImplicitObject.h>

+ Inheritance diagram for Chaos::TWeightedLatticeImplicitObject< TConcrete >:

Public Types

using T = typename TConcrete::TType
 
using TType = T
 
using ObjectType = TRefCountPtr< TConcrete >
 
- Public Types inherited from Chaos::FWeightedLatticeImplicitObject
using ObjectType = FImplicitObjectPtr
 
- Public Types inherited from Chaos::FImplicitObject
using TType = FReal
 

Public Member Functions

 TWeightedLatticeImplicitObject (ObjectType &&InObject, TUniformGrid< FReal, 3 > &&InGrid, TArrayND< FWeightedLatticeInfluenceData, 3 > &&InBoneData, TArray< FName > &&InUsedBones, TArray< FTransform > &&InReferenceRelativeTransforms)
 
virtual ~TWeightedLatticeImplicitObject () override=default
 
 TWeightedLatticeImplicitObject (const TWeightedLatticeImplicitObject &Other)=delete
 
 TWeightedLatticeImplicitObject (TWeightedLatticeImplicitObject &&Other)
 
const TConcreteGetEmbeddedObject () const
 
virtual FImplicitObjectPtr CopyGeometry () const override
 
virtual FImplicitObjectPtr DeepCopyGeometry () const override
 
virtual uint32 GetTypeHash () const override
 
FReal PhiWithNormalAndSurfacePoint (const FVec3 &X, FVec3 &Normal, FEmbeddingCoordinate &SurfaceCoord, bool bIncludeEmptyCells=false) const
 
void BatchPhiWithNormalAndGreatestInfluenceBone (const TConstArrayView< Softs::FPAndInvM > PAndInvMArray, const Softs::FSolverRigidTransform3 &SolverToThis, const Softs::FSolverReal Thickness, TArray< Softs::FSolverReal > &OutBatchPhis, TArray< Softs::FSolverVec3 > &OutBatchNormals, TArray< int32 > &OutBatchGreatestInfluenceBones) const
 
void BatchPhiWithNormal (const TConstArrayView< Softs::FPAndInvM > PAndInvMArray, const Softs::FSolverRigidTransform3 &SolverToThis, TArray< Softs::FSolverReal > &OutBatchPhis, TArray< Softs::FSolverVec3 > &OutBatchNormals) const
 
virtual FReal PhiWithNormal (const FVec3 &x, FVec3 &Normal) const override
 
virtual void Serialize (FChaosArchive &Ar) override
 
- Public Member Functions inherited from Chaos::FWeightedLatticeImplicitObject
CHAOS_API FWeightedLatticeImplicitObject (int32 Flags, EImplicitObjectType InType, TUniformGrid< FReal, 3 > &&InGrid, TArrayND< FWeightedLatticeInfluenceData, 3 > &&InBoneData, TArray< FName > &&InUsedBones, TArray< FTransform > &&InReferenceRelativeTransforms)
 
CHAOS_API FWeightedLatticeImplicitObject (FWeightedLatticeImplicitObject &&Other)
 
virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS ~FWeightedLatticeImplicitObject () override=default
 
virtual PRAGMA_ENABLE_DEPRECATION_WARNINGS const FAABB3 BoundingBox () const override
 
const TArrayND< FWeightedLatticeInfluenceData, 3 > & GetBoneData () const
 
const TArrayND< FVec3, 3 > & GetDeformedPoints () const
 
const TArrayND< bool, 3 > & GetEmptyCells () const
 
const TUniformGrid< FReal, 3 > & GetGrid () const
 
const TArray< FName > & GetUsedBones () const
 
const TArray< int32 > & GetSolverBoneIndices () const
 
void SetSolverBoneIndices (TArray< int32 > &&InSolverBoneIndices)
 
CHAOS_API FVec3 GetDeformedPoint (const FVec3 &UndeformedPoint) const
 
CHAOS_API void UpdateSpatialHierarchy (const FReal MinLodSize=0.)
 
CHAOS_API void FinalizeConstruction ()
 
CHAOS_API void DeformPoints (const TArray< FTransform > &RelativeTransforms)
 
CHAOS_API bool GetEmbeddingCoordinates (const FVec3 &DeformedPoint, TArray< FEmbeddingCoordinate > &CoordinatesOut, bool bFindClosest=false) 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_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 CopyGeometryWithScale (const FVec3 &Scale) 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 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 Public Member Functions inherited from Chaos::FWeightedLatticeImplicitObject
static CHAOS_API const FName GetTypeName (const EImplicitObjectType InType)
 
- 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

- Static Public Attributes inherited from Chaos::FImplicitObject
static constexpr int D = 3
 
- Protected Member Functions inherited from Chaos::FWeightedLatticeImplicitObject
 FWeightedLatticeImplicitObject (int32 Flags, EImplicitObjectType InType)
 
CHAOS_API FWeightedLatticeImplicitObject (const FWeightedLatticeImplicitObject &Other)
 
CHAOS_API void InitializeDeformedPoints ()
 
CHAOS_API void SetEmptyCells ()
 
CHAOS_API uint32 GetTypeHashHelper (const uint32 InHash) const
 
- 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::FWeightedLatticeImplicitObject
TUniformGrid< FReal, 3 > Grid
 
TArrayND< FWeightedLatticeInfluenceData, 3 > BoneData
 
TArray< FNameUsedBones
 
FTransform ReferenceRootTransform
 
TArray< FTransformReferenceRelativeTransforms
 
TArrayND< bool, 3 > EmptyCells
 
TArray< int32SolverBoneIndices
 
TAABB< FReal, 3 > LocalBoundingBox
 
TArrayND< FVec3, 3 > DeformedPoints
 
THierarchicalSpatialHash< int32, FRealSpatial
 
bool bSpatialDirty = true
 
- Protected Attributes inherited from Chaos::FImplicitObject
FRealSingle Margin
 
bool bIsConvex
 
bool bDoCollide
 
bool bHasBoundingBox
 
bool bIsTracked
 
EImplicitObjectType Type
 
EImplicitObjectType CollisionType
 

Member Typedef Documentation

◆ ObjectType

◆ T

template<typename TConcrete >
using Chaos::TWeightedLatticeImplicitObject< TConcrete >::T = typename TConcrete::TType

◆ TType

Constructor & Destructor Documentation

◆ TWeightedLatticeImplicitObject() [1/3]

template<typename TConcrete >
Chaos::TWeightedLatticeImplicitObject< TConcrete >::TWeightedLatticeImplicitObject ( ObjectType &&  InObject,
TUniformGrid< FReal, 3 > &&  InGrid,
TArrayND< FWeightedLatticeInfluenceData, 3 > &&  InBoneData,
TArray< FName > &&  InUsedBones,
TArray< FTransform > &&  InReferenceRelativeTransforms 
)

◆ ~TWeightedLatticeImplicitObject()

◆ TWeightedLatticeImplicitObject() [2/3]

template<typename TConcrete >
Chaos::TWeightedLatticeImplicitObject< TConcrete >::TWeightedLatticeImplicitObject ( const TWeightedLatticeImplicitObject< TConcrete > &  Other)
delete

◆ TWeightedLatticeImplicitObject() [3/3]

template<typename TConcrete >
Chaos::TWeightedLatticeImplicitObject< TConcrete >::TWeightedLatticeImplicitObject ( TWeightedLatticeImplicitObject< TConcrete > &&  Other)

Member Function Documentation

◆ BatchPhiWithNormal()

template<typename TConcrete >
void Chaos::TWeightedLatticeImplicitObject< TConcrete >::BatchPhiWithNormal ( const TConstArrayView< Softs::FPAndInvM PAndInvMArray,
const Softs::FSolverRigidTransform3 SolverToThis,
TArray< Softs::FSolverReal > &  OutBatchPhis,
TArray< Softs::FSolverVec3 > &  OutBatchNormals 
) const

◆ BatchPhiWithNormalAndGreatestInfluenceBone()

template<typename TConcrete >
void Chaos::TWeightedLatticeImplicitObject< TConcrete >::BatchPhiWithNormalAndGreatestInfluenceBone ( const TConstArrayView< Softs::FPAndInvM PAndInvMArray,
const Softs::FSolverRigidTransform3 SolverToThis,
const Softs::FSolverReal  Thickness,
TArray< Softs::FSolverReal > &  OutBatchPhis,
TArray< Softs::FSolverVec3 > &  OutBatchNormals,
TArray< int32 > &  OutBatchGreatestInfluenceBones 
) const

◆ CopyGeometry()

template<typename TConcrete >
FImplicitObjectPtr Chaos::TWeightedLatticeImplicitObject< TConcrete >::CopyGeometry ( ) const
overridevirtual

Reimplemented from Chaos::FImplicitObject.

◆ DeepCopyGeometry()

template<typename TConcrete >
FImplicitObjectPtr Chaos::TWeightedLatticeImplicitObject< TConcrete >::DeepCopyGeometry ( ) const
overridevirtual

Reimplemented from Chaos::FImplicitObject.

◆ GetEmbeddedObject()

template<typename TConcrete >
const TConcrete * Chaos::TWeightedLatticeImplicitObject< TConcrete >::GetEmbeddedObject ( ) const
inline

◆ GetTypeHash()

template<typename TConcrete >
virtual uint32 Chaos::TWeightedLatticeImplicitObject< TConcrete >::GetTypeHash ( ) const
inlineoverridevirtual

◆ PhiWithNormal()

template<typename TConcrete >
virtual FReal Chaos::TWeightedLatticeImplicitObject< TConcrete >::PhiWithNormal ( const FVec3 x,
FVec3 Normal 
) const
inlineoverridevirtual

◆ PhiWithNormalAndSurfacePoint()

template<typename TConcrete >
FReal Chaos::TWeightedLatticeImplicitObject< TConcrete >::PhiWithNormalAndSurfacePoint ( const FVec3 X,
FVec3 Normal,
FEmbeddingCoordinate SurfaceCoord,
bool  bIncludeEmptyCells = false 
) const

◆ Serialize()

template<typename TConcrete >
virtual void Chaos::TWeightedLatticeImplicitObject< TConcrete >::Serialize ( FChaosArchive Ar)
inlineoverridevirtual

◆ StaticType()


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