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 full)

Constructors

constructor

Properties

_aimAxis _dstRestQuat _v3AimAxis destination source weight

Accessors

aimAxis dependencies

Methods

setInitState update

Constructors

constructor

Properties

Private _aimAxis

_aimAxis: any

The aim axis of the constraint.

Private _dstRestQuat

_dstRestQuat: any

The rest quaternion of the destination.

Private _v3AimAxis

_v3AimAxis: any

The _aimAxis but in an actual Vector3 form.

destination

destination: Object3D<Object3DEventMap>

The object being constrained by the source.

source

source: Object3D<Object3DEventMap>

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"

  • set aimAxis(aimAxis): void

  • The aim axis of the constraint.

    Parameters

    • aimAxis: "PositiveX" | "NegativeX" | "PositiveY" | "NegativeY" | "PositiveZ" | "NegativeZ"

    Returns void

dependencies

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

  • Returns Set<Object3D<Object3DEventMap>>

Methods

setInitState

  • setInitState(): void

  • Set initial state of the constraint.

    Returns void

update

  • update(): void

  • Update and apply the constraint.

    Returns void

Settings

Member Visibility

Theme

On This Page

constructor_aimAxis_dstRestQuat_v3AimAxisdestinationsourceweightaimAxisdependenciessetInitStateupdate