@pixiv/three-vrm
    Preparing search index...

    Class VRMNodeConstraintLoaderPlugin

    Implements

    • GLTFLoaderPlugin
    Index

    Constructors

    • Parameters

      • parser: GLTFParser
      • Optionaloptions: VRMNodeConstraintLoaderPluginOptions

      Returns VRMNodeConstraintLoaderPlugin

    Properties

    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 .

    parser: GLTFParser
    EXTENSION_NAME: "VRMC_node_constraint"

    Accessors

    • get name(): string

      Returns string

    Methods

    • 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>

    • Parameters

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

      Returns VRMAimConstraint

    • Parameters

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

      Returns VRMRollConstraint

    • Parameters

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

      Returns VRMRotationConstraint

    • Parameters

      • gltf: GLTF

      Returns Promise<void>