Class VRMAimConstraint

A constraint that makes it look at a source object.

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

Hierarchy (View Summary)

VRMNodeConstraint
- VRMAimConstraint

Index

Constructors

Properties

destination source weight

Accessors

aimAxis dependencies

Methods

setInitState update

Constructors

constructor

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

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

aimAxis

get aimAxis(): | "PositiveX"
| "NegativeX"
| "PositiveY"
| "NegativeY"
| "PositiveZ"
| "NegativeZ"
The aim axis of the constraint.

Returns
    | "PositiveX"
    | "NegativeX"
    | "PositiveY"
    | "NegativeY"
    | "PositiveZ"
    | "NegativeZ"
- Defined in packages/three-vrm-node-constraint/types/VRMAimConstraint.d.ts:12
set aimAxis(
    aimAxis:
        | "PositiveX"
        | "NegativeX"
        | "PositiveY"
        | "NegativeY"
        | "PositiveZ"
        | "NegativeZ",
): void
The aim axis of the constraint.
Parameters
- aimAxis:
      | "PositiveX"
      | "NegativeX"
      | "PositiveY"
      | "NegativeY"
      | "PositiveZ"
      | "NegativeZ"
Returns void
- Defined in packages/three-vrm-node-constraint/types/VRMAimConstraint.d.ts:16

dependencies

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

Methods

setInitState

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

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

update

update(): void
Update and apply the constraint.

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