Class VRMSpringBoneJoint

constructor

• new VRMSpringBoneJoint(
      bone: Object3D,
      child: null | Object3D<Object3DEventMap>,
      settings?: Partial<VRMSpringBoneJointSettings>,
      colliderGroups?: VRMSpringBoneColliderGroup[],
  ): VRMSpringBoneJoint

  Create a new VRMSpringBone.

  Parameters

  • bone: Object3D

    An Object3D that will be attached to this bone
  • child: null | Object3D<Object3DEventMap>

    An Object3D that will be used as a tail of this spring bone. It can be null when the spring bone is imported from VRM 0.0
  • settings: Partial<VRMSpringBoneJointSettings> = {}

    Several parameters related to behavior of the spring bone
  • colliderGroups: VRMSpringBoneColliderGroup[] = []

    Collider groups that will be collided with this spring bone

  Returns VRMSpringBoneJoint

Readonlybone

Readonlychild

colliderGroups

settings

center

• get center(): null | Object3D<Object3DEventMap>

  Returns null | Object3D<Object3DEventMap>

• set center(center: null | Object3D<Object3DEventMap>): void

  Parameters

  • center: null | Object3D<Object3DEventMap>

  Returns void

dependencies

• get dependencies(): Set<Object3D<Object3DEventMap>>

  Set of dependencies that need to be updated before this joint.

  Returns Set<Object3D<Object3DEventMap>>

initialLocalChildPosition

• get initialLocalChildPosition(): Vector3

  Returns Vector3

reset

• reset(): void

  Reset the state of this bone. You might want to call [[VRMSpringBoneManager.reset]] instead.

  Returns void

setInitState

• setInitState(): void

  Set the initial state of this spring bone. You might want to call VRMSpringBoneManager.setInitState instead.

  Returns void

update

• update(delta: number): void

  Update the state of this bone. You might want to call [[VRMSpringBoneManager.update]] instead.

  Parameters

  • delta: number

    deltaTime

  Returns void