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

    Class VRM

    A class that represents a single VRM model.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    expressionManager?: VRMExpressionManager

    Contains VRMExpressionManager of the VRM. You might want to control these facial expressions via VRMExpressionManager.setValue.

    firstPerson?: VRMFirstPerson

    Contains VRMFirstPerson of the VRM. VRMFirstPerson is mostly used for mesh culling for first person view.

    humanoid: VRMHumanoid

    Contains VRMHumanoid of the VRM. You can control each bones using VRMHumanoid.getNormalizedBoneNode or VRMHumanoid.getRawBoneNode.

    Add a link to VRM spec

    lookAt?: VRMLookAt

    Contains VRMLookAt of the VRM. You might want to use VRMLookAt.target to control the eye direction of your VRMs.

    materials?: Material[]

    Contains materials of the VRM. update method of these materials will be called via its VRM.update method.

    meta: VRMMeta

    Contains meta fields of the VRM. You might want to refer these license fields before use your VRMs.

    nodeConstraintManager?: VRMNodeConstraintManager

    A VRMNodeConstraintManager manipulates all constraints attached on the VRM. Usually you don't have to care about this property.

    scene: Group

    THREE.Group that contains the entire VRM.

    springBoneManager?: VRMSpringBoneManager

    A VRMSpringBoneManager manipulates all spring bones attached on the VRM. Usually you don't have to care about this property.

    Methods

    • You need to call this on your update loop.

      This function updates every VRM components.

      Parameters

      • delta: number

        deltaTime

      Returns void