@orillusion/physics-rapier

---

Class: SpringJoint

Defined in: packages/physics-rapier/joint/SpringJoint.ts:10

Spring joint — Hooke's law spring connecting two anchors with a rest length. Replaces ammo plugin's Generic6DofSpringConstraint for the simple case.

Extends

• ConstraintBase<RAPIER.ImpulseJoint>

Constructors

Constructor

new SpringJoint(): SpringJoint

Returns

SpringJoint

Inherited from

ConstraintBase.constructor

Properties

object3D

object3D: Object3D = null

Defined in: src/components/ComponentBase.ts:29

owner object3D

Inherited from

ConstraintBase.object3D

---

isDestroyed

isDestroyed: boolean = false

Defined in: src/components/ComponentBase.ts:77

Inherited from

ConstraintBase.isDestroyed

---

connectedBody

connectedBody: Rigidbody

Defined in: packages/physics-rapier/joint/ConstraintBase.ts:16

The other body of the constraint.

Inherited from

ConstraintBase.connectedBody

---

collisionsEnabled

collisionsEnabled: boolean = false

Defined in: packages/physics-rapier/joint/ConstraintBase.ts:19

Whether contacts are computed between the two connected bodies. Default: false.

Inherited from

ConstraintBase.collisionsEnabled

---

wakeUpOnCreate

wakeUpOnCreate: boolean = true

Defined in: packages/physics-rapier/joint/ConstraintBase.ts:22

Whether to wake up the bodies when the joint is created. Default: true.

Inherited from

ConstraintBase.wakeUpOnCreate

---

anchorSelf

anchorSelf: Vector3

Defined in: packages/physics-rapier/joint/SpringJoint.ts:11

---

anchorTarget

anchorTarget: Vector3

Defined in: packages/physics-rapier/joint/SpringJoint.ts:12

---

restLength

restLength: number = 1

Defined in: packages/physics-rapier/joint/SpringJoint.ts:13

---

stiffness

stiffness: number = 100

Defined in: packages/physics-rapier/joint/SpringJoint.ts:14

---

damping

damping: number = 10

Defined in: packages/physics-rapier/joint/SpringJoint.ts:15

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

ConstraintBase.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

ConstraintBase.eventDispatcher

---

isStart

Get Signature

get isStart(): boolean

Defined in: src/components/ComponentBase.ts:79

Returns

boolean

Inherited from

ConstraintBase.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

ConstraintBase.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

ConstraintBase.enable

---

native

Get Signature

get native(): T

Defined in: packages/physics-rapier/joint/ConstraintBase.ts:53

Native impulse joint. Touching this opts out of cross-backend portability.

Returns

T

Inherited from

ConstraintBase.native

Methods

init()

init(param?): void

Defined in: src/components/ComponentBase.ts:161

Parameters

param?

any

Returns

void

Inherited from

ConstraintBase.init

---

stop()

stop(): void

Defined in: src/components/ComponentBase.ts:163

Returns

void

Inherited from

ConstraintBase.stop

---

onEnable()?

optional onEnable(view?): any

Defined in: src/components/ComponentBase.ts:164

Parameters

view?

View3D

Returns

any

Inherited from

ConstraintBase.onEnable

---

onDisable()?

optional onDisable(view?): any

Defined in: src/components/ComponentBase.ts:165

Parameters

view?

View3D

Returns

any

Inherited from

ConstraintBase.onDisable

---

onUpdate()?

optional onUpdate(view?): any

Defined in: src/components/ComponentBase.ts:166

Parameters

view?

View3D

Returns

any

Inherited from

ConstraintBase.onUpdate

---

onLateUpdate()?

optional onLateUpdate(view?): any

Defined in: src/components/ComponentBase.ts:167

Parameters

view?

View3D

Returns

any

Inherited from

ConstraintBase.onLateUpdate

---

onBeforeUpdate()?

optional onBeforeUpdate(view?): any

Defined in: src/components/ComponentBase.ts:168

Parameters

view?

View3D

Returns

any

Inherited from

ConstraintBase.onBeforeUpdate

---

onCompute()?

optional onCompute(view?, command?): any

Defined in: src/components/ComponentBase.ts:169

Parameters

view?

View3D

command?

GPUCommandEncoder

Returns

any

Inherited from

ConstraintBase.onCompute

---

onGraphic()?

optional onGraphic(view?): any

Defined in: src/components/ComponentBase.ts:170

Parameters

view?

View3D

Returns

any

Inherited from

ConstraintBase.onGraphic

---

onParentChange()?

optional onParentChange(lastParent?, currentParent?): any

Defined in: src/components/ComponentBase.ts:171

Parameters

lastParent?

Object3D

currentParent?

Object3D

Returns

any

Inherited from

ConstraintBase.onParentChange

---

onAddChild()?

optional onAddChild(child): any

Defined in: src/components/ComponentBase.ts:172

Parameters

child

Object3D

Returns

any

Inherited from

ConstraintBase.onAddChild

---

onRemoveChild()?

optional onRemoveChild(child): any

Defined in: src/components/ComponentBase.ts:173

Parameters

child

Object3D

Returns

any

Inherited from

ConstraintBase.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

ConstraintBase.cloneTo

---

copyComponent()

copyComponent(from): this

Defined in: src/components/ComponentBase.ts:182

Parameters

from

this

Returns

this

Inherited from

ConstraintBase.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

ConstraintBase.beforeDestroy

---

start()

start(): Promise<void>

Defined in: packages/physics-rapier/joint/ConstraintBase.ts:24

Returns

Promise<void>

Inherited from

ConstraintBase.start

---

destroy()

destroy(force?): void

Defined in: packages/physics-rapier/joint/ConstraintBase.ts:46

release this component

Parameters

force?

boolean

Returns

void

Inherited from

ConstraintBase.destroy