Class: ClothSoftbody
Defined in: packages/physics/softbody/ClothSoftbody.ts:12
Extends
SoftbodyBase
Constructors
Constructor
new ClothSoftbody():
ClothSoftbody
Returns
ClothSoftbody
Inherited from
SoftbodyBase.constructor
Properties
object3D
object3D:
Object3D=null
Defined in: src/components/ComponentBase.ts:29
owner object3D
Inherited from
SoftbodyBase.object3D
isDestroyed
isDestroyed:
boolean=false
Defined in: src/components/ComponentBase.ts:77
Inherited from
SoftbodyBase.isDestroyed
clothCorners
clothCorners: [
Vector3,Vector3,Vector3,Vector3]
Defined in: packages/physics/softbody/ClothSoftbody.ts:22
The four corners of the cloth; by default, each corner is calculated from the plane's normal vector.
fixNodeIndices
fixNodeIndices:
number[] |CornerType[] =[]
Defined in: packages/physics/softbody/ClothSoftbody.ts:27
Indices of fixed nodes.
anchorRigidbody
anchorRigidbody:
Rigidbody
Defined in: packages/physics/softbody/ClothSoftbody.ts:32
The rigid body required when adding anchors.
anchorIndices
anchorIndices:
number[] |CornerType[] =[]
Defined in: packages/physics/softbody/ClothSoftbody.ts:37
The anchors of the cloth.
anchorPosition
anchorPosition:
Vector3
Defined in: packages/physics/softbody/ClothSoftbody.ts:42
Only effective after anchorRigidbody is set; represents the position of the cloth soft body relative to the rigid body.
anchorRotation
anchorRotation:
Vector3
Defined in: packages/physics/softbody/ClothSoftbody.ts:47
Only effective after anchorRigidbody is set; represents the rotation of the cloth soft body relative to the rigid body.
mass
mass:
number=1
Defined in: packages/physics/softbody/SoftbodyBase.ts:17
Total mass of the soft body. Default value is 1
Inherited from
SoftbodyBase.mass
margin
margin:
number=0.15
Defined in: packages/physics/softbody/SoftbodyBase.ts:22
Collision margin. Default value is 0.15
Inherited from
SoftbodyBase.margin
group
group:
number=1
Defined in: packages/physics/softbody/SoftbodyBase.ts:27
Collision group. Default value is 1
Inherited from
SoftbodyBase.group
mask
mask:
number=-1
Defined in: packages/physics/softbody/SoftbodyBase.ts:32
Collision mask. Default value is -1
Inherited from
SoftbodyBase.mask
influence
influence:
number=1
Defined in: packages/physics/softbody/SoftbodyBase.ts:37
Anchor influence. The higher the influence, the more closely the soft body node follows the rigid body's motion. Typically this value is between 0 and 1. Default value is 1.
Inherited from
SoftbodyBase.influence
disableCollision
disableCollision:
boolean=false
Defined in: packages/physics/softbody/SoftbodyBase.ts:42
Whether to disable collisions with the anchored rigid body. Default value is false.
Inherited from
SoftbodyBase.disableCollision
Accessors
visibleLayer
Get Signature
get visibleLayer():
number
Defined in: src/components/ComponentBase.ts:46
Composition-layer membership bitmask. The pass / camera / collector filters via
(component.visibleLayer & pass.layerMask & camera.cullingMask) !== 0
Defaults to VisibleLayer.Default (bit 0) so a fresh subclass is visible to passes whose layerMask is VisibleLayer.All (which includes bit 0). Application code can assign project-specific bits (1..31) to organise the scene into composition layers.
Returns
number
Set Signature
set visibleLayer(
value):void
Defined in: src/components/ComponentBase.ts:50
Parameters
value
number
Returns
void
Inherited from
SoftbodyBase.visibleLayer
eventDispatcher
Get Signature
get eventDispatcher():
CEventDispatcher
Defined in: src/components/ComponentBase.ts:63
Returns
CEventDispatcher
Set Signature
set eventDispatcher(
value):void
Defined in: src/components/ComponentBase.ts:68
Parameters
value
CEventDispatcher
Returns
void
Inherited from
SoftbodyBase.eventDispatcher
isStart
Get Signature
get isStart():
boolean
Defined in: src/components/ComponentBase.ts:79
Returns
boolean
Inherited from
SoftbodyBase.isStart
transform
Get Signature
get transform():
Transform
Defined in: src/components/ComponentBase.ts:89
Return the Transform component attached to the Object3D. Null before the component is attached — addComponent assigns object3D only after construction — so constructor-time callers can probe safely via this.transform?..
Returns
Transform
Inherited from
SoftbodyBase.transform
enable
Get Signature
get enable():
boolean
Defined in: src/components/ComponentBase.ts:113
Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.
Returns
boolean
Set Signature
set enable(
value):void
Defined in: src/components/ComponentBase.ts:96
Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.
Parameters
value
boolean
Returns
void
Inherited from
SoftbodyBase.enable
activationState
Set Signature
set activationState(
value):void
Defined in: packages/physics/softbody/SoftbodyBase.ts:47
Set the soft body activation state.
Parameters
value
Returns
void
Inherited from
SoftbodyBase.activationState
btBodyInited
Get Signature
get btBodyInited():
boolean
Defined in: packages/physics/softbody/SoftbodyBase.ts:51
Returns
boolean
Inherited from
SoftbodyBase.btBodyInited
btSoftBody
Get Signature
get btSoftBody():
btSoftBody
Defined in: packages/physics/softbody/SoftbodyBase.ts:55
Returns
Inherited from
SoftbodyBase.btSoftBody
Methods
stop()
stop():
void
Defined in: src/components/ComponentBase.ts:163
Returns
void
Inherited from
SoftbodyBase.stop
onEnable()?
optionalonEnable(view?):any
Defined in: src/components/ComponentBase.ts:164
Parameters
view?
View3D
Returns
any
Inherited from
SoftbodyBase.onEnable
onDisable()?
optionalonDisable(view?):any
Defined in: src/components/ComponentBase.ts:165
Parameters
view?
View3D
Returns
any
Inherited from
SoftbodyBase.onDisable
onLateUpdate()?
optionalonLateUpdate(view?):any
Defined in: src/components/ComponentBase.ts:167
Parameters
view?
View3D
Returns
any
Inherited from
SoftbodyBase.onLateUpdate
onBeforeUpdate()?
optionalonBeforeUpdate(view?):any
Defined in: src/components/ComponentBase.ts:168
Parameters
view?
View3D
Returns
any
Inherited from
SoftbodyBase.onBeforeUpdate
onCompute()?
optionalonCompute(view?,command?):any
Defined in: src/components/ComponentBase.ts:169
Parameters
view?
View3D
command?
GPUCommandEncoder
Returns
any
Inherited from
SoftbodyBase.onCompute
onGraphic()?
optionalonGraphic(view?):any
Defined in: src/components/ComponentBase.ts:170
Parameters
view?
View3D
Returns
any
Inherited from
SoftbodyBase.onGraphic
onParentChange()?
optionalonParentChange(lastParent?,currentParent?):any
Defined in: src/components/ComponentBase.ts:171
Parameters
lastParent?
Object3D
currentParent?
Object3D
Returns
any
Inherited from
SoftbodyBase.onParentChange
onAddChild()?
optionalonAddChild(child):any
Defined in: src/components/ComponentBase.ts:172
Parameters
child
Object3D
Returns
any
Inherited from
SoftbodyBase.onAddChild
onRemoveChild()?
optionalonRemoveChild(child):any
Defined in: src/components/ComponentBase.ts:173
Parameters
child
Object3D
Returns
any
Inherited from
SoftbodyBase.onRemoveChild
cloneTo()
cloneTo(
obj):void
Defined in: src/components/ComponentBase.ts:180
clone component data to target object3D
Parameters
obj
Object3D
target object3D
Returns
void
Inherited from
SoftbodyBase.cloneTo
copyComponent()
copyComponent(
from):this
Defined in: src/components/ComponentBase.ts:182
Parameters
from
this
Returns
this
Inherited from
SoftbodyBase.copyComponent
beforeDestroy()
beforeDestroy(
force?):void
Defined in: src/components/ComponentBase.ts:249
before release this component, object refrences are not be set null now.
Parameters
force?
boolean
Returns
void
Inherited from
SoftbodyBase.beforeDestroy
start()
start():
Promise<void>
Defined in: packages/physics/softbody/ClothSoftbody.ts:49
Returns
Promise<void>
Overrides
SoftbodyBase.start
applyFixedNodes()
applyFixedNodes(
fixedNodeIndices):void
Defined in: packages/physics/softbody/ClothSoftbody.ts:192
Fixes soft body nodes.
Parameters
fixedNodeIndices
number[] | CornerType[]
An array of node indices or CornerType values that should be fixed.
Returns
void
Overrides
SoftbodyBase.applyFixedNodes
clearAnchors()
clearAnchors():
void
Defined in: packages/physics/softbody/ClothSoftbody.ts:202
Clears anchors; the soft body will detach from the attached rigid body.
Returns
void
onUpdate()
onUpdate():
void
Defined in: packages/physics/softbody/ClothSoftbody.ts:209
Returns
void
Overrides
SoftbodyBase.onUpdate
destroy()
destroy(
force?):void
Defined in: packages/physics/softbody/ClothSoftbody.ts:243
Parameters
force?
boolean
Returns
void
Overrides
SoftbodyBase.destroy
init()
init():
void
Defined in: packages/physics/softbody/SoftbodyBase.ts:59
Returns
void
Inherited from
SoftbodyBase.init
wait()
wait():
Promise<btSoftBody>
Defined in: packages/physics/softbody/SoftbodyBase.ts:95
Asynchronously retrieves the fully initialized soft body instance.
Returns
Promise<btSoftBody>
Inherited from
SoftbodyBase.wait
appendAnchor()
appendAnchor(
nodeIndex,targetRigidbody,disCollision?,influence?):void
Defined in: packages/physics/softbody/SoftbodyBase.ts:107
Wraps the native soft body's appendAnchor method to anchor a node to a rigid body.
Parameters
nodeIndex
number
Index of the node to anchor.
targetRigidbody
The rigid body to anchor to.
disCollision?
boolean
Optional. Disable collisions if true.
influence?
number
Optional. Anchor's influence.
Returns
void
Inherited from
SoftbodyBase.appendAnchor
clearFixedNodes()
clearFixedNodes(
index?):void
Defined in: packages/physics/softbody/SoftbodyBase.ts:140
Clear fixed nodes
Parameters
index?
number
Index of the node to clear. If not provided, clears all nodes.
Returns
void
Inherited from
SoftbodyBase.clearFixedNodes