Class VRMNodeConstraintLoaderPlugin

Implements

  • GLTFLoaderPlugin

Constructors

constructor

Properties

helperRoot? parser EXTENSION_NAME

Accessors

name

Methods

_import _importAimConstraint _importRollConstraint _importRotationConstraint afterRoot

Constructors

constructor

  • new VRMNodeConstraintLoaderPlugin(
        parser: GLTFParser,
        options?: VRMNodeConstraintLoaderPluginOptions,
    ): VRMNodeConstraintLoaderPlugin

    Parameters

    • parser: GLTFParser
    • Optionaloptions: VRMNodeConstraintLoaderPluginOptions

    Returns VRMNodeConstraintLoaderPlugin

Properties

OptionalhelperRoot

helperRoot?: Object3D<Object3DEventMap>

Specify an Object3D to add VRMNodeConstraintHelper s. If not specified, helper will not be created. If renderOrder is set to the root, helpers will copy the same renderOrder .

Readonlyparser

parser: GLTFParser

Static ReadonlyEXTENSION_NAME

EXTENSION_NAME: "VRMC_node_constraint"

Accessors

name

  • get name(): string

    Returns string

Methods

Protected_import

  • _import(gltf: GLTF): Promise<null | VRMNodeConstraintManager>

    Import constraints from a GLTF and returns a VRMNodeConstraintManager. It might return null instead when it does not need to be created or something go wrong.

    Parameters

    • gltf: GLTF

      A parsed result of GLTF taken from GLTFLoader

    Returns Promise<null | VRMNodeConstraintManager>

Protected_importAimConstraint

  • _importAimConstraint(
        destination: Object3D,
        nodes: Object3D<Object3DEventMap>[],
        aimConstraintDef: AimConstraint,
    ): VRMAimConstraint

    Parameters

    • destination: Object3D
    • nodes: Object3D<Object3DEventMap>[]
    • aimConstraintDef: AimConstraint

    Returns VRMAimConstraint

Protected_importRollConstraint

  • _importRollConstraint(
        destination: Object3D,
        nodes: Object3D<Object3DEventMap>[],
        rollConstraintDef: RollConstraint,
    ): VRMRollConstraint

    Parameters

    • destination: Object3D
    • nodes: Object3D<Object3DEventMap>[]
    • rollConstraintDef: RollConstraint

    Returns VRMRollConstraint

Protected_importRotationConstraint

  • _importRotationConstraint(
        destination: Object3D,
        nodes: Object3D<Object3DEventMap>[],
        rotationConstraintDef: RotationConstraint,
    ): VRMRotationConstraint

    Parameters

    • destination: Object3D
    • nodes: Object3D<Object3DEventMap>[]
    • rotationConstraintDef: RotationConstraint

    Returns VRMRotationConstraint

afterRoot

  • afterRoot(gltf: GLTF): Promise<void>

    Parameters

    • gltf: GLTF

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods