Documentation / scene / MultiChainSpringSystem

Class: MultiChainSpringSystem

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:64

Constructors

Constructor

new MultiChainSpringSystem(options?): MultiChainSpringSystem

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:92

Parameters

options?

MultiChainSpringSystemOptions

Returns

MultiChainSpringSystem

Accessors

chains

Get Signature

get chains(): SpringChain[]

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:243

Returns

SpringChain[]

---

interChainConstraints

Get Signature

get interChainConstraints(): InterChainConstraint[]

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:247

Returns

InterChainConstraint[]

---

gravity

Get Signature

get gravity(): Vector3

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:251

Returns

Vector3

Set Signature

set gravity(gravity): void

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:255

Parameters

gravity

Vector3

Returns

void

---

wind

Get Signature

get wind(): Vector3

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:259

Returns

Vector3

Set Signature

set wind(wind): void

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:263

Parameters

wind

Vector3

Returns

void

---

iterations

Get Signature

get iterations(): number

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:267

Returns

number

Set Signature

set iterations(count): void

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:271

Parameters

count

number

Returns

void

---

enableInertialForces

Get Signature

get enableInertialForces(): boolean

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:275

Returns

boolean

Set Signature

set enableInertialForces(enabled): void

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:279

Parameters

enabled

boolean

Returns

void

---

centrifugalScale

Get Signature

get centrifugalScale(): number

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:283

Returns

number

Set Signature

set centrifugalScale(scale): void

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:287

Parameters

scale

number

Returns

void

---

coriolisScale

Get Signature

get coriolisScale(): number

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:291

Returns

number

Set Signature

set coriolisScale(scale): void

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:295

Parameters

scale

number

Returns

void

---

solver

Get Signature

get solver(): "verlet" | "xpbd"

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:299

Returns

"verlet" | "xpbd"

Set Signature

set solver(type): void

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:303

Parameters

type

"verlet" | "xpbd"

Returns

void

---

poseFollow

Get Signature

get poseFollow(): number

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:312

Returns

number

Set Signature

set poseFollow(value): void

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:316

Parameters

value

number

Returns

void

---

poseFollowRoot

Get Signature

get poseFollowRoot(): number

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:323

Returns

number

Set Signature

set poseFollowRoot(value): void

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:327

Parameters

value

number

Returns

void

---

poseFollowTip

Get Signature

get poseFollowTip(): number

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:331

Returns

number

Set Signature

set poseFollowTip(value): void

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:335

Parameters

value

number

Returns

void

---

poseFollowExponent

Get Signature

get poseFollowExponent(): number

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:339

Returns

number

Set Signature

set poseFollowExponent(value): void

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:343

Parameters

value

number

Returns

void

---

maxPoseOffset

Get Signature

get maxPoseOffset(): number

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:347

Returns

number

Set Signature

set maxPoseOffset(value): void

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:351

Parameters

value

number

Returns

void

---

maxPoseOffsetRoot

Get Signature

get maxPoseOffsetRoot(): number

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:358

Returns

number

Set Signature

set maxPoseOffsetRoot(value): void

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:362

Parameters

value

number

Returns

void

---

maxPoseOffsetTip

Get Signature

get maxPoseOffsetTip(): number

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:366

Returns

number

Set Signature

set maxPoseOffsetTip(value): void

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:370

Parameters

value

number

Returns

void

---

colliders

Get Signature

get colliders(): SpringCollider[]

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:400

Returns

SpringCollider[]

Methods

addChain()

addChain(chain): number

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:121

Parameters

chain

SpringChain

Returns

number

---

addInterChainConstraint()

addInterChainConstraint(constraint): void

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:126

Parameters

constraint

InterChainConstraint

Returns

void

---

createRadialConstraints()

createRadialConstraints(options): void

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:130

Parameters

options

stiffness

number

maxDistance

number

skipRows?

number

connectDistance?

number

compliance?

number

Returns

void

---

update()

update(deltaTime): void

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:169

Parameters

deltaTime

number

Returns

void

---

applyToNodes()

applyToNodes(weight?): void

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:189

Parameters

weight?

number = 1.0

Returns

void

---

reset()

reset(): void

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:221

Returns

void

---

addCollider()

addCollider(collider): void

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:374

Parameters

collider

SpringCollider

Returns

void

---

removeCollider()

removeCollider(collider): boolean

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:381

Parameters

collider

SpringCollider

Returns

boolean

---

clearColliders()

clearColliders(): void

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:393

Returns

void

---

setRuntimeNodeMap()

setRuntimeNodeMap(nodeMap): void

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:408

Sets a runtime-only node remapping used by particles, anchors and colliders. The authored node references remain unchanged and therefore serialize normally.

Parameters

nodeMap

ReadonlyMap<SceneNode, SceneNode>

Returns

void

---

reinitializeFromCurrentPose()

reinitializeFromCurrentPose(options?): void

Defined in: libs/scene/src/animation/spring/multi_chain_spring_system.ts:420

Rebuilds particle history from the current runtime-remapped node pose. This must be called after a hierarchy graft or skeleton rebind.

Parameters

options?

SpringPoseReinitializeOptions

Returns

void