FClothingSimulationCloth


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

	Type	Name	Description
		FClothingSimulationCloth ( const FClothingSimulationCloth& )
		FClothingSimulationCloth ( FClothingSimulationCloth&& )
		FClothingSimulationCloth ( FClothingSimulationConfig* InConfig, PRAGMA_DISABLE_DEPRECATION_WARNINGSFClothingSimulationMesh* InMesh, TArray< FClothingSimulationCollider* >&& InColliders, uint32 InGroupId )
		FClothingSimulationCloth ( PRAGMA_DISABLE_DEPRECATION_WARNINGSFClothingSimulationMesh* InMesh, TArray< FClothingSimulationCollider* >&& InColliders, uint32 InGroupId, EMassMode InMassMode, FRealSingle InMassValue, FRealSingle InMinPerParticleMass, const TVec2< FRealSingle >& InEdgeStiffness, const TVec2< FRealSingle >& InBendingStiffness, FRealSingle InBucklingRatio, const TVec2< FRealSingle >& InBucklingStiffness, bool bInUseBendingElements, const TVec2< FRealSingle >& InAreaStiffness, FRealSingle InVolumeStiffness, bool bInUseThinShellVolumeConstraints, const TVec2< FRealSingle >& InTetherStiffness, const TVec2< FRealSingle >& InTetherScale, PRAGMA_DISABLE_DEPRECATION_WARNINGSETetherMode InTetherMode, FRealSingle InMaxDistancesMultiplier, const TVec2< FRealSingle >& InAnimDriveStiffness, const TVec2< FRealSingle >& InAnimDriveDamping, FRealSingle InShapeTargetStiffness, bool bInUseXPBDEdgeConstraints, bool bInUseXPBDBendingConstraints, bool bInUseXPBDAreaConstraints, FRealSingle InGravityScale, bool bIsGravityOverridden, const TVec3< FRealSingle >& InGravityOverride, const TVec3< FRealSingle >& InLinearVelocityScale, FRealSingle InAngularVelocityScale, FRealSingle InFictitiousAngularScale, const TVec2< FRealSingle >& InDrag, const TVec2< FRealSingle >& InLift, bool bInUsePointBasedWindModel, const TVec2< FRealSingle >& InPressure, FRealSingle InDampingCoefficient, FRealSingle InLocalDampingCoefficient, FRealSingle InCollisionThickness, FRealSingle InFrictionCoefficient, bool bInUseCCD, bool bInUseSelfCollisions, FRealSingle InSelfCollisionThickness, FRealSingle InSelfCollisionFrictionCoefficient, bool bInUseSelfIntersections, bool bInUseLegacyBackstop, bool bInUseLODIndexOverride, int32 InLODIndexOverride, const TVec2< FRealSingle >& EdgeDampingRatio, const TVec2< FRealSingle >& BendDampingRatio ) FClothingSimulationCloth ( PRAGMA_DISABLE_DEPRECATION_WARNINGSFClothingSimulationMesh* InMesh, TArray< FClothingSimulationCollider* >&& InColliders, uint32 InGroupId, EMassMode InMassMode, FRealSingle InMassValue, FRealSingle InMinPerParticleMass, const TVec2< FRealSingle >& InEdgeStiffness, const TVec2< FRealSingle >& InBendingStiffness, FRealSingle InBucklingRatio, const TVec2< FRealSingle >& InBucklingStiffness, bool bInUseBendingElements, const TVec2< FRealSingle >& InAreaStiffness, FRealSingle InVolumeStiffness, bool bInUseThinShellVolumeConstraints, const TVec2< FRealSingle >& InTetherStiffness, const TVec2< FRealSingle >& InTetherScale, PRAGMA_DISABLE_DEPRECATION_WARNINGSETetherMode InTetherMode, FRealSingle InMaxDistancesMultiplier, const TVec2< FRealSingle >& InAnimDriveStiffness, const TVec2< FRealSingle >& InAnimDriveDamping, FRealSingle InShapeTargetStiffness, bool bInUseXPBDEdgeConstraints, bool bInUseXPBDBendingConstraints, bool bInUseXPBDAreaConstraints, FRealSingle InGravityScale, bool bIsGravityOverridden, const TVec3< FRealSingle >& InGravityOverride, const TVec3< FRealSingle >& InLinearVelocityScale, FRealSingle InAngularVelocityScale, FRealSingle InFictitiousAngularScale, const TVec2< FRealSingle >& InDrag, const TVec2< FRealSingle >& InLift, bool bInUsePointBasedWindModel, const TVec2< FRealSingle >& InPressure, FRealSingle InDampingCoefficient, FRealSingle InLocalDampingCoefficient, FRealSingle InCollisionThickness, FRealSingle InFrictionCoefficient, bool bInUseCCD, bool bInUseSelfCollisions, FRealSingle InSelfCollisionThickness, FRealSingle InSelfCollisionFrictionCoefficient, bool bInUseSelfIntersections, bool bInUseLegacyBackstop, bool bInUseLODIndexOverride, int32 InLODIndexOverride, const TVec2< FRealSingle >& EdgeDampingRatio, const TVec2< FRealSingle >& BendDampingRatio )	Use config based constructor instead.

	Type	Name	Description
		~FClothingSimulationCloth ()

Type	Name	Description
void	Add ( FClothingSimulationSolver* Solver )	- Solver interface -
void	AddCollider ( FClothingSimulationCollider* InCollider )
FAABB3	CalculateBoundingBox ( const FClothingSimulationSolver* Solver )	Return the current bounding box based on a given solver, not thread safe, call must be done right after the solver update.
TConstArrayView< Softs::FSolverVec3 >	GetAnimationNormals ( const FClothingSimulationSolver* Solver )	Return the solver's input normals for this cloth source current LOD, not thread safe, call must be done right after the solver update.
TConstArrayView< Softs::FSolverVec3 >	GetAnimationPositions ( const FClothingSimulationSolver* Solver )	- Debugging/visualization functions Return the solver's input positions for this cloth source current LOD, not thread safe, call must be done right after the solver update.
const TArray< FClothingSimulationCollider * > &	GetColliders ()
FClothingSimulationConfig *	GetConfig ()
TVec3< FRealSingle >	GetGravity ( const FClothingSimulationSolver* Solver )	Return the current gravity as applied by the solver using the various overrides, not thread safe, call must be done right after the solver update.
uint32	GetGroupId ()
uint32	GetLODIndex ( const FClothingSimulationSolver* Solver )
PRAGMA_DISABLE_DEPRECATION_WARNINGSFClothingSimulationMesh *	GetMesh ()	- Node property getters/setters
int32	GetNumActiveDynamicParticles ()
int32	GetNumActiveKinematicParticles ()
int32	GetNumParticles ( const FClothingSimulationSolver* Solver )	Return the current LOD num particles, or 0 if no LOD is currently selected.
int32	GetOffset ( const FClothingSimulationSolver* Solver )	Return the current LOD offset in the solver's particle array, or INDEX_NONE if no LOD is currently selected.
TConstArrayView< Softs::FSolverReal >	GetParticleInvMasses ( const FClothingSimulationSolver* Solver )	Return the solver's inverse masses for this cloth current LOD, not thread safe, call must be done right after the solver update.
TConstArrayView< Softs::FSolverVec3 >	GetParticleNormals ( const FClothingSimulationSolver* Solver )	Return the solver's normals for this cloth current LOD, not thread safe, call must be done right after the solver update.
TConstArrayView< Softs::FSolverVec3 >	GetParticlePositions ( const FClothingSimulationSolver* Solver )	Return the solver's positions for this cloth current LOD, not thread safe, call must be done right after the solver update.
TConstArrayView< Softs::FSolverVec3 >	GetParticleVelocities ( const FClothingSimulationSolver* Solver )	Return the solver's velocities for this cloth current LOD, not thread safe, call must be done right after the solver update.
int32	GetReferenceBoneIndex ()	Return the reference bone index for this cloth.
const FRigidTransform3 &	GetReferenceSpaceTransform ()	Return the local reference space transform for this cloth.
const TArray< TConstArrayView< TTuple< int32, int32, float > > > &	GetTethers ( const FClothingSimulationSolver* Solver )	Return the current LOD tethers.
const FTriangleMesh &	GetTriangleMesh ( const FClothingSimulationSolver* Solver )	Return the current LOD mesh.
TConstArrayView< FRealSingle >	GetWeightMapByName ( const FClothingSimulationSolver* Solver, const FString& Name )	Return the weight map of the specified name if available on the current LOD, or an empty array view otherwise.
TConstArrayView< FRealSingle >	GetWeightMapByProperty ( const FClothingSimulationSolver* Solver, const FString& Property )	Return the weight map of the specified property name if it exists and is available on the current LOD, or an empty array view otherwise.
void	PostUpdate ( FClothingSimulationSolver* Solver )
void	PreUpdate ( FClothingSimulationSolver* Solver )
void	Remove ( FClothingSimulationSolver* Solver )
void	RemoveCollider ( FClothingSimulationCollider* InCollider )
void	RemoveColliders ()
void	Reset ()
void	SetColliders ( TArray< FClothingSimulationCollider* >&& InColliders )
void	SetConfig ( FClothingSimulationConfig* InConfig )
void	SetMaxDistancesMultiplier ( FRealSingle InMaxDistancesMultiplier )	- Animatable property setters -
void	SetMesh ( FClothingSimulationMesh* InMesh )
void	Teleport ()
void	Update ( FClothingSimulationSolver* Solver )
void	UpdateFromCache ( const FClothingSimulationCacheData& CacheData )

	Type	Name	Description
	FClothingSimulationCloth &	operator= ( FClothingSimulationCloth&& )
	FClothingSimulationCloth &	operator= ( const FClothingSimulationCloth& )

	Type	Name	Description
	FLODData

	Type	Name	Description
	EMassMode

	Type	Name	Description
	PRAGMA_DISABLE_DEPRECATION_WARNINGS typedef FClothConstraints::ETetherMode	ETetherMode	ETetherMode has been replaced with bUseGeodesicTethers.

Type	Name	Description
	FClothingSimulationCloth ( PRAGMA_DISABLE_DEPRECATION_WARNINGSFClothingSimulationMesh* InMesh, TArray< FClothingSimulationCollider* >&& InColliders, uint32 InGroupId, EMassMode InMassMode, FRealSingle InMassValue, FRealSingle InMinPerParticleMass, const TVec2< FRealSingle >& InEdgeStiffness, const TVec2< FRealSingle >& InBendingStiffness, FRealSingle InBucklingRatio, const TVec2< FRealSingle >& InBucklingStiffness, bool bInUseBendingElements, const TVec2< FRealSingle >& InAreaStiffness, FRealSingle InVolumeStiffness, bool bInUseThinShellVolumeConstraints, const TVec2< FRealSingle >& InTetherStiffness, const TVec2< FRealSingle >& InTetherScale, PRAGMA_DISABLE_DEPRECATION_WARNINGSETetherMode InTetherMode, FRealSingle InMaxDistancesMultiplier, const TVec2< FRealSingle >& InAnimDriveStiffness, const TVec2< FRealSingle >& InAnimDriveDamping, FRealSingle InShapeTargetStiffness, bool bInUseXPBDEdgeConstraints, bool bInUseXPBDBendingConstraints, bool bInUseXPBDAreaConstraints, FRealSingle InGravityScale, bool bIsGravityOverridden, const TVec3< FRealSingle >& InGravityOverride, const TVec3< FRealSingle >& InLinearVelocityScale, FRealSingle InAngularVelocityScale, FRealSingle InFictitiousAngularScale, const TVec2< FRealSingle >& InDrag, const TVec2< FRealSingle >& InLift, bool bInUsePointBasedWindModel, const TVec2< FRealSingle >& InPressure, FRealSingle InDampingCoefficient, FRealSingle InLocalDampingCoefficient, FRealSingle InCollisionThickness, FRealSingle InFrictionCoefficient, bool bInUseCCD, bool bInUseSelfCollisions, FRealSingle InSelfCollisionThickness, FRealSingle InSelfCollisionFrictionCoefficient, bool bInUseSelfIntersections, bool bInUseLegacyBackstop, bool bInUseLODIndexOverride, int32 InLODIndexOverride, const TVec2< FRealSingle >& EdgeDampingRatio, const TVec2< FRealSingle >& BendDampingRatio ) FClothingSimulationCloth ( PRAGMA_DISABLE_DEPRECATION_WARNINGSFClothingSimulationMesh* InMesh, TArray< FClothingSimulationCollider* >&& InColliders, uint32 InGroupId, EMassMode InMassMode, FRealSingle InMassValue, FRealSingle InMinPerParticleMass, const TVec2< FRealSingle >& InEdgeStiffness, const TVec2< FRealSingle >& InBendingStiffness, FRealSingle InBucklingRatio, const TVec2< FRealSingle >& InBucklingStiffness, bool bInUseBendingElements, const TVec2< FRealSingle >& InAreaStiffness, FRealSingle InVolumeStiffness, bool bInUseThinShellVolumeConstraints, const TVec2< FRealSingle >& InTetherStiffness, const TVec2< FRealSingle >& InTetherScale, PRAGMA_DISABLE_DEPRECATION_WARNINGSETetherMode InTetherMode, FRealSingle InMaxDistancesMultiplier, const TVec2< FRealSingle >& InAnimDriveStiffness, const TVec2< FRealSingle >& InAnimDriveDamping, FRealSingle InShapeTargetStiffness, bool bInUseXPBDEdgeConstraints, bool bInUseXPBDBendingConstraints, bool bInUseXPBDAreaConstraints, FRealSingle InGravityScale, bool bIsGravityOverridden, const TVec3< FRealSingle >& InGravityOverride, const TVec3< FRealSingle >& InLinearVelocityScale, FRealSingle InAngularVelocityScale, FRealSingle InFictitiousAngularScale, const TVec2< FRealSingle >& InDrag, const TVec2< FRealSingle >& InLift, bool bInUsePointBasedWindModel, const TVec2< FRealSingle >& InPressure, FRealSingle InDampingCoefficient, FRealSingle InLocalDampingCoefficient, FRealSingle InCollisionThickness, FRealSingle InFrictionCoefficient, bool bInUseCCD, bool bInUseSelfCollisions, FRealSingle InSelfCollisionThickness, FRealSingle InSelfCollisionFrictionCoefficient, bool bInUseSelfIntersections, bool bInUseLegacyBackstop, bool bInUseLODIndexOverride, int32 InLODIndexOverride, const TVec2< FRealSingle >& EdgeDampingRatio, const TVec2< FRealSingle >& BendDampingRatio )	Use config based constructor instead.
void	GetAnimDriveProperties ( TVec2< FRealSingle >& OutAnimDriveStiffness, TVec2< FRealSingle >& OutAnimDriveDamping )	Get properties directly through FClothingSimulationConfig
const TArray< TConstArrayView< FRealSingle > > &	GetWeightMaps ( const FClothingSimulationSolver* Solver )	Returns an empty array from 5.3. Update your code with GetWeightMapByName and GetWeightMapByProperty to return the current LOD weight map instead.
void	SetAerodynamicsProperties ( const TVec2< FRealSingle >& InDrag, const TVec2< FRealSingle >& InLift, FRealSingle InAirDensity, const FVec3& InWindVelocity )	Set properties directly through FClothingSimulationConfig
void	SetAnimDriveProperties ( const TVec2< FRealSingle >& InAnimDriveStiffness, const TVec2< FRealSingle >& InAnimDriveDamping )	Set properties directly through FClothingSimulationConfig
void	SetBackstopProperties ( bool bInEnableBackstop )	Set properties directly through FClothingSimulationConfig
void	SetCollisionProperties ( FRealSingle InCollisionThickness, FRealSingle InFrictionCoefficient, bool bInUseCCD, FRealSingle InSelfCollisionThickness )	Set properties directly through FClothingSimulationConfig
void	SetDampingProperties ( FRealSingle InDampingCoefficient, FRealSingle InLocalDampingCoefficient )	Set properties directly through FClothingSimulationConfig
void	SetGravityProperties ( FRealSingle InGravityScale, bool bInUseGravityOverride, const FVec3& InGravityOverride )	Set properties directly through FClothingSimulationConfig
void	SetLongRangeAttachmentProperties ( const TVec2< FRealSingle >& InTetherStiffness, const TVec2< FRealSingle >& InTetherScale )	Set properties directly through FClothingSimulationConfig
void	SetMaterialProperties ( const TVec2< FRealSingle >& InEdgeStiffness, const TVec2< FRealSingle >& InBendingStiffness, const TVec2< FRealSingle >& InAreaStiffness )	Set properties directly through FClothingSimulationConfig
void	SetPressureProperties ( const TVec2< FRealSingle >& InPressure )	Set properties directly through FClothingSimulationConfig
void	SetVelocityScaleProperties ( const FVec3& InLinearVelocityScale, FRealSingle InAngularVelocityScale, FRealSingle InFictitiousAngularScale )	Set properties directly through FClothingSimulationConfig

Navigation

References

Syntax

Remarks

Constructors

Destructors

Functions

Operators

Classes

Enums

Deprecated Variables

Deprecated Functions