FClothingSimulationSolver

Solver simulation node.

Windows
MacOS
Linux

References

Module

ChaosCloth

Header

/Engine/Plugins/Experimental/ChaosCloth/Source/Chaos/Public/ChaosCloth/ChaosClothingSimulationSolver.h

Include

#include "ChaosCloth/ChaosClothingSimulationSolver.h"

Syntax

class FClothingSimulationSolver

Remarks

Solver simulation node.

Constructors

Name Description

Public function

FClothingSimulationSolver()

Destructors

Name Description

Public function

~FClothingSimulationSolver()

Functions

Name Description

Public function

void

 

AddCloth

(
    FClothingSimulationCloth* InCl...
)

Public function

int32

 

AddCollisionParticles

(
    int32 NumCollisionParticles,
    uint32 GroupId,
    int32 RecycledOffset
)

  • Collider interface -

Public function

void

 

AddExternalForces

(
    uint32 GroupId,
    bool bUseLegacyWind
)

Add external forces to the particles.

Public function

int32

 

AddParticles

(
    int32 NumParticles,
    uint32 GroupId
)

  • Cloth interface -

Public function Const

FBoxSphereBo...

 

CalculateBounds()

Public function

void

 

EnableClothGravityOverride

(
    bool bInIsClothGravityOverrideEnabl...
)

Disables all Cloths gravity override mechanism.

Public function

void

 

EnableCollisionParticles

(
    int32 Offset,
    bool bEnable
)

Public function

void

 

EnableParticles

(
    int32 Offset,
    bool bEnable
)

Public function

FVec3 *

 

GetAnimationNormals

(
    int32 Offset
)

Public function Const

const FVec3 ...

 

GetAnimationNormals

(
    int32 Offset
)

Public function Const

const FVec3 ...

 

GetAnimationPositions

(
    int32 Offset
)

Public function

FVec3 *

 

GetAnimationPositions

(
    int32 Offset
)

Public function Const

const FCloth...

 

GetClothConstraints

(
    int32 Offset
)

Public function

FClothConstr...

 

GetClothConstraints

(
    int32 Offset
)

Public function Const

TConstArrayV...

 

GetCloths()

Public function Const

const FRigid...

 

GetCollisionBaseTransforms

(
    int32 Offset
)

Public function

FRigidTransf...

 

GetCollisionBaseTransforms

(
    int32 Offset
)

Public function Const

const int32 ...

 

GetCollisionBoneIndices

(
    int32 Offset
)

Public function

int32 *

 

GetCollisionBoneIndices

(
    int32 Offset
)

Public function Const

const TArray...

 

GetCollisionContacts()

Public function Const

const TUniqu...

 

GetCollisionGeometries

(
    int32 Offset
)

Public function Const

const TArray...

 

GetCollisionNormals()

Public function Const

const FRotat...

 

GetCollisionParticleRs

(
    int32 Offset
)

Public function

FRotation3 &...

 

GetCollisionParticleRs

(
    int32 Offset
)

Public function Const

const FVec3 ...

 

GetCollisionParticleXs

(
    int32 Offset
)

Public function

FVec3 *

 

GetCollisionParticleXs

(
    int32 Offset
)

Public function Const

const bool &...

 

GetCollisionStatus

(
    int32 Offset
)

Public function Const

const FRigid...

 

GetCollisionTransforms

(
    int32 Offset
)

Public function

FRigidTransf...

 

GetCollisionTransforms

(
    int32 Offset
)

Public function Const

const FVec3 ...

 

GetGravity()

Public function Const

const FVec3 ...

 

GetLocalSpaceLocation()

Public function

FVec3 *

 

GetNormals

(
    int32 Offset
)

Public function Const

const FVec3 ...

 

GetNormals

(
    int32 Offset
)

Public function Const

int32

 

GetNumIterations()

Public function Const

int32

 

GetNumSubsteps()

Public function Const

const FVec3 ...

 

GetOldAnimationPositions

(
    int32 Offset
)

Public function

FVec3 *

 

GetOldAnimationPositions

(
    int32 Offset
)

Public function Const

const FRigid...

 

GetOldCollisionTransforms

(
    int32 Offset
)

Public function

FRigidTransf...

 

GetOldCollisionTransforms

(
    int32 Offset
)

Public function Const

const FReal ...

 

GetParticleInvMasses

(
    int32 Offset
)

Public function

FVec3 *

 

GetParticlePs

(
    int32 Offset
)

Public function Const

const FVec3 ...

 

GetParticlePs

(
    int32 Offset
)

Public function

FVec3 *

 

GetParticleVs

(
    int32 Offset
)

Public function Const

const FVec3 ...

 

GetParticleVs

(
    int32 Offset
)

Public function Const

const FVec3 ...

 

GetParticleXs

(
    int32 Offset
)

Public function

FVec3 *

 

GetParticleXs

(
    int32 Offset
)

Public function

FPerSolverFi...

 

GetPerSolverField()

-Field interface -

Public function Const

const FPerSo...

 

GetPerSolverField()

Public function Const

FReal

 

GetTime()

Get the currrent solver time.

Public function Const

const FVec3 ...

 

GetWindVelocity()

Public function

const FVeloc...

 

GetWindVelocityField

(
    uint32 GroupId
)

Public function Const

bool

 

IsClothGravityOverrideEnabled()

Public function

void

 

RefreshCloth

(
    FClothingSimulationCloth* InCl...
)

Public function

void

 

RefreshCloths()

Public function

void

 

RemoveCloth

(
    FClothingSimulationCloth* InCl...
)

Public function

void

 

RemoveCloths()

Public function

void

 

SetCloths

(
    TArray< FClothingSimulationCloth&#...
)

  • Object management functions -

Public function

void

 

SetCollisionGeometry

(
    int32 Offset,
    int32 Index,
    TUniquePtr< FImplicitObject >&& Ge...
)

Public function

void

 

SetGravity

(
    uint32 GroupId,
    const FVec3& Gravity
)

Set per group gravity, used to override solver's gravity. Must be called during cloth update.

Public function

void

 

SetGravity

(
    const FVec3& InGravity
)

Public function

void

 

SetLocalSpaceLocation

(
    const FVec3& InLocalSpaceLocation,
    bool bReset
)

  • Animatable property setters -

Public function

void

 

SetNumIterations

(
    int32 InNumIterations
)

Public function

void

 

SetNumSubsteps

(
    int32 InNumSubsteps
)

Public function

void

 

SetParticleMassFromDensity

(
    int32 Offset,
    FReal Density,
    FReal MinPerParticleMass,
    const FTriangleMesh& Mesh,
    const TFunctionRef< bool)>& ...
)

Public function

void

 

SetParticleMassFromTotalMass

(
    int32 Offset,
    FReal TotalMass,
    FReal MinPerParticleMass,
    const FTriangleMesh& Mesh,
    const TFunctionRef< bool)>& ...
)

Public function

void

 

SetParticleMassUniform

(
    int32 Offset,
    FReal UniformMass,
    FReal MinPerParticleMass,
    const FTriangleMesh& Mesh,
    const TFunctionRef< bool)>& ...
)

Public function

void

 

SetProperties

(
    uint32 GroupId,
    FRealSingle DampingCoefficient,
    FRealSingle CollisionThickness,
    FRealSingle FrictionCoefficient
)

Set general cloth simulation properties.

Public function

void

 

SetReferenceVelocityScale

(
    uint32 GroupId,
    const FRigidTransform3& OldReferen...,
    const FRigidTransform3& ReferenceS...,
    const FVec3& LinearVelocityScale,
    FReal AngularVelocityScale,
    FReal FictitiousAngularScale
)

Set the amount of velocity allowed to filter from the given change in reference space transform, including local simulation space.

Public function

void

 

SetUseCCD

(
    uint32 GroupId,
    bool bUseCCD
)

Set whether to use continuous collision detection.

Public function

void

 

SetWindFluidDensity

(
    FRealSingle InWindFluidDensity
)

Public function

void

 

SetWindVelocity

(
    const FVec3& InWindVelocity,
    FRealSingle InLegacyWindAdaption
)

Public function

void

 

SetWindVelocity

(
    uint32 GroupId,
    const FVec3& InWindVelocity
)

Set per group wind velocity, used to override solver's wind velocity. Must be called during cloth update.

Public function

void

 

SetWindVelocityField

(
    uint32 GroupId,
    FRealSingle DragCoefficient,
    FRealSingle LiftCoefficient,
    const FTriangleMesh* TriangleM...
)

Set the geometry affected by wind, or disable if TriangleMesh is null.

Public function

void

 

Update

(
    FReal InDeltaTime
)

Update solver properties before simulation.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss