Class VRMRollConstraint

A constraint that transfers a rotation around one axis of a source.

See: https://github.com/vrm-c/vrm-specification/tree/master/specification/VRMC_node_constraint-1.0_beta#roll-constraint

Hierarchy (View Summary)

VRMNodeConstraint
- VRMRollConstraint

Index

Constructors

Properties

destination source weight

Accessors

dependencies rollAxis

Methods

setInitState update

Constructors

constructor

new VRMRollConstraint(
destination: Object3D,
source: Object3D,
): VRMRollConstraint
Parameters
- destination: Object3D
- source: Object3D
Returns VRMRollConstraint
Overrides VRMNodeConstraint.constructor
- Defined in packages/three-vrm-node-constraint/types/VRMRollConstraint.d.ts:38

Properties

destination

destination: Object3D

The object being constrained by the source.

source

source: Object3D

The object constrains the destination.

weight

weight: number

The weight of the constraint.

Accessors

dependencies

get dependencies(): Set<Object3D<Object3DEventMap>>
Returns Set<Object3D<Object3DEventMap>>
Overrides VRMNodeConstraint.dependencies
- Defined in packages/three-vrm-node-constraint/types/VRMRollConstraint.d.ts:37

rollAxis

get rollAxis(): "X" | "Y" | "Z"
The roll axis of the constraint.

Returns "X" | "Y" | "Z"
- Defined in packages/three-vrm-node-constraint/types/VRMRollConstraint.d.ts:12
set rollAxis(rollAxis: "X" | "Y" | "Z"): void
The roll axis of the constraint.
Parameters
- rollAxis: "X" | "Y" | "Z"
Returns void
- Defined in packages/three-vrm-node-constraint/types/VRMRollConstraint.d.ts:16

Methods

setInitState

setInitState(): void
Set initial state of the constraint.

Returns void
Overrides VRMNodeConstraint.setInitState
- Defined in packages/three-vrm-node-constraint/types/VRMRollConstraint.d.ts:39

update

update(): void
Update and apply the constraint.

Returns void
Overrides VRMNodeConstraint.update
- Defined in packages/three-vrm-node-constraint/types/VRMRollConstraint.d.ts:40