Class VRMFirstPerson

constructor

• new VRMFirstPerson(
      humanoid: VRMHumanoid,
      meshAnnotations: VRMFirstPersonMeshAnnotation[],
  ): VRMFirstPerson

  Create a new VRMFirstPerson object.

  Parameters

  • humanoid: VRMHumanoid

    A VRMHumanoid
  • meshAnnotations: VRMFirstPersonMeshAnnotation[]

    A renderer settings. See the description of [[RendererFirstPersonFlags]] for more info

  Returns VRMFirstPerson

Readonlyhumanoid

meshAnnotations

Static ReadonlyDEFAULT_FIRSTPERSON_ONLY_LAYER

Static ReadonlyDEFAULT_THIRDPERSON_ONLY_LAYER

firstPersonOnlyLayer

• get firstPersonOnlyLayer(): number

  A camera layer represents FirstPersonOnly layer. Note that you must call setup first before you use the layer feature or it does not work properly.

  The value is DEFAULT_FIRSTPERSON_ONLY_LAYER by default but you can change the layer by specifying via setup if you prefer.

  Returns number

  See

  • https://vrm.dev/en/univrm/api/univrm_use_firstperson/
  • https://threejs.org/docs/#api/en/core/Layers

thirdPersonOnlyLayer

• get thirdPersonOnlyLayer(): number

  A camera layer represents ThirdPersonOnly layer. Note that you must call setup first before you use the layer feature or it does not work properly.

  The value is DEFAULT_THIRDPERSON_ONLY_LAYER by default but you can change the layer by specifying via setup if you prefer.

  Returns number

  See

  • https://vrm.dev/en/univrm/api/univrm_use_firstperson/
  • https://threejs.org/docs/#api/en/core/Layers

clone

• clone(): VRMFirstPerson

  Returns a clone of this VRMFirstPerson.

  Returns VRMFirstPerson

  Copied VRMFirstPerson

copy

• copy(source: VRMFirstPerson): this

  Copy the given VRMFirstPerson into this one. humanoid must be same as the source one.

  Parameters

  • source: VRMFirstPerson

    The VRMFirstPerson you want to copy

  Returns this

  this

setup

• setup(
      cameraLayer?: {
          firstPersonOnlyLayer?: number;
          thirdPersonOnlyLayer?: number;
      },
  ): void

  In this method, it assigns layers for every meshes based on mesh annotations. You must call this method first before you use the layer feature.

  This is an equivalent of VRMFirstPerson.Setup of the UniVRM.

  The cameraLayer parameter specifies which layer will be assigned for FirstPersonOnly / ThirdPersonOnly. In UniVRM, we specified those by naming each desired layer as FIRSTPERSON_ONLY_LAYER / THIRDPERSON_ONLY_LAYER but we are going to specify these layers at here since we are unable to name layers in Three.js.

  Parameters

  • OptionalcameraLayer: { firstPersonOnlyLayer?: number; thirdPersonOnlyLayer?: number }

    Specify which layer will be for FirstPersonOnly / ThirdPersonOnly.

  Returns void