Documentation / scene / GPUClothSystem
Class: GPUClothSystem
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2122
WebGPU-only cloth simulation entry.
On non-WebGPU backends (including WebGL), the system is always disabled.
Constructors
Constructor
new GPUClothSystem(
options?):GPUClothSystem
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2192
Parameters
options?
Returns
GPUClothSystem
Accessors
enabled
Get Signature
get enabled():
boolean
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2674
Returns
boolean
Set Signature
set enabled(
value):void
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2678
Parameters
value
boolean
Returns
void
supported
Get Signature
get supported():
boolean
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2686
Returns
boolean
disabledReason
Get Signature
get disabledReason():
string
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2690
Returns
string
colliders
Get Signature
get colliders():
SpringCollider[]
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2694
Returns
Set Signature
set colliders(
value):void
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2698
Parameters
value
Returns
void
gravity
Get Signature
get gravity():
Vector3
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2725
Returns
Vector3
Set Signature
set gravity(
value):void
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2729
Parameters
value
Vector3
Returns
void
damping
Get Signature
get damping():
number
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2733
Returns
number
Set Signature
set damping(
value):void
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2737
Parameters
value
number
Returns
void
dynamicFriction
Get Signature
get dynamicFriction():
number
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2741
Returns
number
Set Signature
set dynamicFriction(
value):void
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2745
Parameters
value
number
Returns
void
staticFriction
Get Signature
get staticFriction():
number
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2749
Returns
number
Set Signature
set staticFriction(
value):void
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2753
Parameters
value
number
Returns
void
stiffness
Get Signature
get stiffness():
number
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2757
Returns
number
Set Signature
set stiffness(
value):void
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2761
Parameters
value
number
Returns
void
poseFollow
Get Signature
get poseFollow():
number
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2765
Returns
number
Set Signature
set poseFollow(
value):void
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2769
Parameters
value
number
Returns
void
solverIterations
Get Signature
get solverIterations():
number
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2773
Returns
number
Set Signature
set solverIterations(
value):void
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2777
Parameters
value
number
Returns
void
substeps
Get Signature
get substeps():
number
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2781
Returns
number
Set Signature
set substeps(
value):void
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2785
Parameters
value
number
Returns
void
vertexCount
Get Signature
get vertexCount():
number
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2789
Returns
number
Methods
createFromPrimitive()
staticcreateFromPrimitive(primitive,options?):Promise<GPUClothSystem>
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2556
Parameters
primitive
options?
Omit<GPUClothSystemOptions, "primitive" | "positionData" | "indexData">
Returns
Promise<GPUClothSystem>
createFromMesh()
staticcreateFromMesh(mesh,options?):Promise<GPUClothSystem>
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2573
Parameters
mesh
MeshSkinningSource & object
options?
Omit<GPUClothSystemOptions, "primitive" | "positionData" | "indexData" | "scene">
Returns
Promise<GPUClothSystem>
setWrapTargets()
setWrapTargets(
targets):Promise<void>
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2595
Parameters
targets
any[]
Returns
Promise<void>
setWrapTargetsFromBindingData()
setWrapTargetsFromBindingData(
targets):Promise<void>
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2627
Parameters
targets
Returns
Promise<void>
clearWrapTargets()
clearWrapTargets():
void
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2664
Returns
void
addCollider()
addCollider(
collider):void
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2704
Parameters
collider
Returns
void
removeCollider()
removeCollider(
collider):boolean
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2709
Parameters
collider
Returns
boolean
clearColliders()
clearColliders():
void
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2719
Returns
void
bindToScene()
bindToScene(
scene):void
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2793
Parameters
scene
Returns
void
unbindFromScene()
unbindFromScene():
void
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2808
Returns
void
update()
update(
deltaTime):void
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2812
Parameters
deltaTime
number
Returns
void
dispose()
dispose():
void
Defined in: libs/scene/src/animation/cloth/gpu_cloth_system.ts:2852
Returns
void