Class VRMNodeConstraintLoaderPlugin

Implements

GLTFLoaderPlugin

Index

Constructors

constructor

new VRMNodeConstraintLoaderPlugin(
parser: GLTFParser,
options?: VRMNodeConstraintLoaderPluginOptions,
): VRMNodeConstraintLoaderPlugin
Parameters
- parser: GLTFParser
- Optionaloptions: VRMNodeConstraintLoaderPluginOptions
Returns VRMNodeConstraintLoaderPlugin
- Defined in packages/three-vrm-node-constraint/src/VRMNodeConstraintLoaderPlugin.ts:33

Properties

`Optional`helperRoot

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 .

`Readonly`parser

parser: GLTFParser

`Static` `Readonly`EXTENSION_NAME

EXTENSION_NAME: "VRMC_node_constraint" = 'VRMC_node_constraint'

Accessors

name

get name(): string
Returns string
Implementation of GLTFLoaderPlugin.name
- Defined in packages/three-vrm-node-constraint/src/VRMNodeConstraintLoaderPlugin.ts:29

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>
- Defined in packages/three-vrm-node-constraint/src/VRMNodeConstraintLoaderPlugin.ts:49

`Protected`_importAimConstraint

_importAimConstraint(
    destination: Object3D,
    nodes: Object3D<Object3DEventMap>[],
    aimConstraintDef: AimConstraint,
): VRMAimConstraint
Parameters
- destination: Object3D
- nodes: Object3D<Object3DEventMap>[]
- aimConstraintDef: AimConstraint
Returns VRMAimConstraint
- Defined in packages/three-vrm-node-constraint/src/VRMNodeConstraintLoaderPlugin.ts:128

`Protected`_importRollConstraint

_importRollConstraint(
    destination: Object3D,
    nodes: Object3D<Object3DEventMap>[],
    rollConstraintDef: RollConstraint,
): VRMRollConstraint
Parameters
- destination: Object3D
- nodes: Object3D<Object3DEventMap>[]
- rollConstraintDef: RollConstraint
Returns VRMRollConstraint
- Defined in packages/three-vrm-node-constraint/src/VRMNodeConstraintLoaderPlugin.ts:104

`Protected`_importRotationConstraint

_importRotationConstraint(
    destination: Object3D,
    nodes: Object3D<Object3DEventMap>[],
    rotationConstraintDef: RotationConstraint,
): VRMRotationConstraint
Parameters
- destination: Object3D
- nodes: Object3D<Object3DEventMap>[]
- rotationConstraintDef: RotationConstraint
Returns VRMRotationConstraint
- Defined in packages/three-vrm-node-constraint/src/VRMNodeConstraintLoaderPlugin.ts:152

afterRoot

afterRoot(gltf: GLTF): Promise<void>
Parameters
- gltf: GLTF
Returns Promise<void>
Implementation of GLTFLoaderPlugin.afterRoot
- Defined in packages/three-vrm-node-constraint/src/VRMNodeConstraintLoaderPlugin.ts:39

Class VRMNodeConstraintLoaderPlugin

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns VRMNodeConstraintLoaderPlugin

Properties

`Optional`helperRoot

`Readonly`parser

`Static` `Readonly`EXTENSION_NAME

Accessors

name

Returns string

Methods

`Protected`_import

Parameters

Returns Promise<null | VRMNodeConstraintManager>

`Protected`_importAimConstraint

Parameters

Returns VRMAimConstraint

`Protected`_importRollConstraint

Parameters

Returns VRMRollConstraint

`Protected`_importRotationConstraint

Parameters

Returns VRMRotationConstraint

afterRoot

Parameters

Returns Promise<void>

Settings

On This Page

Class VRMNodeConstraintLoaderPlugin

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns VRMNodeConstraintLoaderPlugin

Properties

OptionalhelperRoot

Readonlyparser

Static ReadonlyEXTENSION_NAME

Accessors

name

Returns string

Methods

Protected_import

Parameters

Returns Promise<null | VRMNodeConstraintManager>

Protected_importAimConstraint

Parameters

Returns VRMAimConstraint

Protected_importRollConstraint

Parameters

Returns VRMRollConstraint

Protected_importRotationConstraint

Parameters

Returns VRMRotationConstraint

afterRoot

Parameters

Returns Promise<void>

Settings

On This Page

`Optional`helperRoot

`Readonly`parser

`Static` `Readonly`EXTENSION_NAME

`Protected`_import

`Protected`_importAimConstraint

`Protected`_importRollConstraint

`Protected`_importRotationConstraint