1. Epic GamesDeveloper
  3. FClothingSimulationSolver

FClothingSimulationSolver

Solver simulation node.

Unreal Engine C++ API Reference > Plugins > ChaosCloth > ChaosCloth

Inheritance Hierarchy

References

   
Module ChaosCloth
Header /Engine/Plugins/Experimental/ChaosCloth/Source/Chaos/Public/ChaosCloth/ChaosClothingSimulationSolver.h
Include #include "ChaosCloth/ChaosClothingSimulationSolver.h"

Syntax

class FClothingSimulationSolver : public Chaos::FPhysicsSolverEvents

Remarks

Solver simulation node.

Constructors

  Type Name Description
Public function    
Public function    
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void  
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 FBoxSphereBounds  
Public function void

EnableClothGravityOverride ( bool bInIsClothGravityOverrideEnabled
)

 Disables all Cloths gravity override mechanism.
Public function void

EnableCollisionParticles ( int32 Offset,
bool bEnable
)

  
Public function void

EnableParticles ( int32 Offset,
bool bEnable
)

  
Public function Const const Softs::FSolverVec3 *

GetAnimationNormals ( int32 Offset
)

  
Public function Softs::FSolverVec3 *

GetAnimationNormals ( int32 Offset
)

  
Public function Softs::FSolverVec3 *

GetAnimationPositions ( int32 Offset
)

  
Public function Const const Softs::FSolverVec3 *

GetAnimationPositions ( int32 Offset
)

  
Public function Softs::FSolverVec3 *

GetAnimationVelocities ( int32 Offset
)

  
Public function Const const Softs::FSolverVec3 *

GetAnimationVelocities ( int32 Offset
)

  
Public function FClothConstraints &

GetClothConstraints ( int32 Offset
)

  
Public function Const const FClothConstraints &

GetClothConstraints ( int32 Offset
)

  
Public function Const TConstArrayView< const FClothingSimulationCloth * >  
Public function Softs::FSolverRigidTransform3 *

GetCollisionBaseTransforms ( int32 Offset
)

  
Public function Const const Softs::FSolverRigidTransform3 *

GetCollisionBaseTransforms ( int32 Offset
)

  
Public function Const const int32 *

GetCollisionBoneIndices ( int32 Offset
)

  
Public function int32 *

GetCollisionBoneIndices ( int32 Offset
)

  
Public function Const const TArray< Softs::FSolverVec3 > &  
Public function Const const TUniquePtr< FImplicitObject > *

GetCollisionGeometries ( int32 Offset
)

  
Public function Const const TArray< Softs::FSolverVec3 > &  
Public function Const const Softs::FSolverRotation3 *

GetCollisionParticleRs ( int32 Offset
)

  
Public function Softs::FSolverRotation3 *

GetCollisionParticleRs ( int32 Offset
)

  
Public function Const const Softs::FSolverVec3 *

GetCollisionParticleXs ( int32 Offset
)

  
Public function Softs::FSolverVec3 *

GetCollisionParticleXs ( int32 Offset
)

  
Public function Const const TArray< Softs::FSolverReal > &  
Public function Const const bool *

GetCollisionStatus ( int32 Offset
)

  
Public function Softs::FSolverRigidTransform3 *

GetCollisionTransforms ( int32 Offset
)

  
Public function Const const Softs::FSolverRigidTransform3 *

GetCollisionTransforms ( int32 Offset
)

  
Public function Const FClothingSimulationConfig * Get the solver configuration.
Public function Const FSolverReal Return the last delta time used for advancing the simulation.
Public function Const bool  
Public function Const const TVec3< FRealSingle > &  
Public function Const const Softs::FSolverVec3 *  
Public function Softs::FSolverVec3 *  
Public function Const const Softs::FSolverVec3 *  
Public function Softs::FSolverVec3 *  
Public function Const const FVec3 &  
Public function Const const FRotation3 &  
Public function Const int32  
Public function Softs::FSolverVec3 *

GetNormals ( int32 Offset
)

  
Public function Const const Softs::FSolverVec3 *

GetNormals ( int32 Offset
)

  
Public function Const int32  
Public function Const uint32  
Public function Const int32  
Public function Const int32 Return the actual of number of iterations used by the Evolution solver after the update (different from the number of iterations, depends on frame rate)
Public function Softs::FSolverVec3 *

GetOldAnimationNormals ( int32 Offset
)

  
Public function Const const Softs::FSolverVec3 *

GetOldAnimationNormals ( int32 Offset
)

  
Public function Const const Softs::FSolverVec3 *

GetOldAnimationPositions ( int32 Offset
)

  
Public function Softs::FSolverVec3 *

GetOldAnimationPositions ( int32 Offset
)

  
Public function Const const Softs::FSolverRigidTransform3 *

GetOldCollisionTransforms ( int32 Offset
)

  
Public function Softs::FSolverRigidTransform3 *

GetOldCollisionTransforms ( int32 Offset
)

  
Public function Const const Softs::FSolverReal *

GetParticleInvMasses ( int32 Offset
)

  
Public function Const const Softs::FPAndInvM *

GetParticlePandInvMs ( int32 Offset
)

  
Public function Softs::FPAndInvM *

GetParticlePandInvMs ( int32 Offset
)

  
Public function Softs::FSolverVec3 *

GetParticleVs ( int32 Offset
)

  
Public function Const const Softs::FSolverVec3 *

GetParticleVs ( int32 Offset
)

  
Public function Const const Softs::FSolverVec3 *

GetParticleXs ( int32 Offset
)

  
Public function Softs::FSolverVec3 *

GetParticleXs ( int32 Offset
)

  
Public function Const const FPerSolverFieldSystem &  
Public function FPerSolverFieldSystem & -Field interface -
Public function Const int32  
Public function Const FSolverReal

GetTime ()

 Get the current solver time.
Public function Const FReal  
Public function Const const TVec3< FRealSingle > &  
Public function Const const Softs::FVelocityAndPressureField &

GetWindVelocityAndPressureField ( uint32 GroupId
)

 Return the wind velocity and pressure field associated with a given group id.
Public function Const bool  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void

ResetCollisionStartPose ( int32 Offset,
int32 NumCollisionParticles
)

  
Public function void

ResetStartPose ( int32 Offset,
int32 NumParticles
)

  
Public function void - Object management functions -
Public function void

SetCollisionGeometry ( int32 Offset,
int32 Index,
TUniquePtr< FImplicitObject >&& Geometry
)

  
Public function void Set the solver configuration. Can use a cloth config if a single cloth is being simulated.
Public function void

SetEnableSolver ( bool InbEnableSolver
)

  
Public function void

SetGravity ( const TVec3< FRealSingle >& InGravity
)

  
Public function void

SetGravity ( uint32 GroupId,
const TVec3< FRealSingle >& Gravity
)

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

SetLocalSpaceLocation ( const FVec3& InLocalSpaceLocation,
bool bReset
)

 - Animatable property setters -
Public function void

SetLocalSpaceRotation ( const FQuat& InLocalSpaceRotation
)

  
Public function void

SetParticleMassFromDensity ( int32 Offset,
FRealSingle Density,
FRealSingle MinPerParticleMass,
const FTriangleMesh& Mesh,
const TFunctionRef< bool(int32)>& KinematicPredicate
)

  
Public function void

SetParticleMassFromTotalMass ( int32 Offset,
FRealSingle TotalMass,
FRealSingle MinPerParticleMass,
const FTriangleMesh& Mesh,
const TFunctionRef< bool(int32)>& KinematicPredicate
)

  
Public function void

SetParticleMassUniform ( int32 Offset,
FRealSingle UniformMass,
FRealSingle MinPerParticleMass,
const FTriangleMesh& Mesh,
const TFunctionRef< bool(int32)>& KinematicPredicate
)

  
Public function void

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

 Set general cloth simulation properties.
Public function void

SetReferenceVelocityScale ( uint32 GroupId,
const FRigidTransform3& OldReferenceSpaceTransform,
const FRigidTransform3& ReferenceSpaceTransform,
const TVec3< FRealSingle >& LinearVelocityScale,
FRealSingle AngularVelocityScale,
FRealSingle FictitiousAngularScale
)

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

SetSolverLOD ( int32 LODIndex
)

  
Public function void

SetUseCCD ( uint32 GroupId,
bool bUseCCD
)

 Set whether to use continuous collision detection.
Public function void

SetVelocityScale ( FReal InVelocityScale
)

  
Public function void

SetWindAndPressureGeometry ( uint32 GroupId,
const FTriangleMesh& TriangleMesh,
const Softs::FCollectionPropertyConstFacade& PropertyCollection,
const TMap< FString, TConstArrayView< FRealSingle >>& WeightMaps
)

 Set the geometry affected by the wind and pressure.
Public function void

SetWindAndPressureGeometry ( uint32 GroupId,
const FTriangleMesh& TriangleMesh,
const TConstArrayView< FRealSingle >& DragMultipliers,
const TConstArrayView< FRealSingle >& LiftMultipliers,
const TConstArrayView< FRealSingle >& PressureMultipliers
)

  
Public function void

SetWindAndPressureProperties ( uint32 GroupId,
const Softs::FCollectionPropertyConstFacade& PropertyCollection,
const TMap< FString, TConstArrayView< FRealSingle >>& WeightMaps,
bool bEnableAerodynamics
)

 Set the wind and pressure properties.
Public function void

SetWindAndPressureProperties ( uint32 GroupId,
const TVec2< FRealSingle >& Drag,
const TVec2< FRealSingle >& Lift,
FRealSingle FluidDensity,
const TVec2< FRealSingle >& Pressure
)

  
Public function void

SetWindVelocity ( const TVec3< FRealSingle >& InWindVelocity,
FRealSingle InLegacyWindAdaption
)

  
Public function void

SetWindVelocity ( uint32 GroupId,
const TVec3< FRealSingle >& InWindVelocity
)

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

Update ( FSolverReal InDeltaTime
)

 Advance the simulation.
Public function void Set the cached positions onto the particles

Operators

  Type Name Description
Public function FClothingSimulationSolver &  
Public function FClothingSimulationSolver &  

Deprecated Functions

  Type Name Description
Public function void

SetMaxNumIterations ( int32 InMaxNumIterations
)

 Set properties directly through FClothingSimulationConfig
Public function void

SetNumIterations ( int32 InNumIterations
)

 Set properties directly through FClothingSimulationConfig
Public function void

SetNumSubsteps ( int32 InNumSubsteps
)

 Set properties directly through FClothingSimulationConfig
Public function void

UpdateFromCache ( const TArray< FVector >& CachedPositions,
const TArray< FVector >& CachedVelocities
)

 Use UpdateFromCache(CacheData) instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page