@pmndrs/viverse 0.2.6 → 0.2.8

package/dist/animation/bone-map.d.ts

@@ -1,4 +1,3 @@
-import { VRMHumanBoneName } from '@pixiv/three-vrm';
 import { AnimationClip, Object3D } from 'three';
-export type BoneMap = Record<string, VRMHumanBoneName>;
-export declare function applyBoneMap(clip: AnimationClip, clipScene: Object3D | undefined, boneMap: BoneMap): void;
+import type { BoneMap } from '../utils.js';
+export declare function applyAnimationBoneMap(clip: AnimationClip, clipScene: Object3D | undefined, boneMap: BoneMap): void;

package/dist/animation/bone-map.js

@@ -1,8 +1,8 @@
-export function applyBoneMap(clip, clipScene, boneMap) {
+export function applyAnimationBoneMap(clip, clipScene, boneMap) {
     for (const track of clip.tracks) {
         const [clipBoneName, propertyName] = track.name.split('.');
         const clipBone = clipScene?.getObjectByName(clipBoneName);
-        const normalizedBoneName = (boneMap?.[clipBoneName] ?? clipBoneName);
+        const normalizedBoneName = boneMap?.[clipBoneName] ?? clipBoneName;
         if (clipBone != null) {
             clipBone.name = normalizedBoneName;
         }

package/dist/animation/index.js

@@ -3,7 +3,7 @@ import { Euler, Quaternion, QuaternionKeyframeTrack, Vector3, VectorKeyframeTrac
 import { BVHLoader } from 'three/examples/jsm/loaders/BVHLoader.js';
 import { FBXLoader } from 'three/examples/jsm/loaders/FBXLoader.js';
 import { GLTFLoader } from 'three/examples/jsm/loaders/GLTFLoader.js';
-import { applyBoneMap } from './bone-map.js';
+import { applyAnimationBoneMap } from './bone-map.js';
 import _bvhBoneMap from './bvh-bone-map.json';
 import { resolveDefaultCharacterAnimationUrl } from './default.js';
 import { applyMask } from './mask.js';
@@ -24,12 +24,25 @@ const position = new Vector3();
 const nonVrmRotationOffset = new Quaternion().setFromEuler(new Euler(0, Math.PI, 0));
 //TODO: currently assumes the model is not yet transformed - loaded for the first time
 export function fixModelAnimationClip(model, clip, clipScene, removeXZMovement) {
+    clip.tracks = clip.tracks.filter((track) => {
+        if (track instanceof QuaternionKeyframeTrack) {
+            return true;
+        }
+        const [clipBoneName, propertyName] = track.name.split('.');
+        if (propertyName != 'position') {
+            return false;
+        }
+        if (clipBoneName == 'hips' || clipBoneName == 'root') {
+            return true;
+        }
+        return false;
+    });
     let restRoot;
     let restRootParent;
     if (!(model instanceof VRM)) {
-        restRoot = model.scene.getObjectByName('rest_root');
+        restRoot = model.scene.getObjectByName('rest_hips')?.parent;
         if (restRoot == null) {
-            throw new Error(`Model rest root not found.`);
+            throw new Error(`Model hips.parent not found.`);
         }
         restRootParent = restRoot?.parent;
         restRoot.parent = null;
@@ -127,12 +140,6 @@ export function fixModelAnimationClip(model, clip, clipScene, removeXZMovement)
             track.name = trackName;
         }
         else if (track instanceof VectorKeyframeTrack) {
-            if (clipBoneName != 'hips' && clipBoneName != 'root') {
-                continue;
-            }
-            if (propertyName != 'position') {
-                continue;
-            }
             for (let i = 0; i < track.values.length; i += 3) {
                 position.fromArray(track.values, i);
                 if (clipSceneHips?.parent != null) {
@@ -143,6 +150,11 @@ export function fixModelAnimationClip(model, clip, clipScene, removeXZMovement)
                         position.multiplyScalar(clipSceneHips.parent.matrixWorld.getMaxScaleOnAxis());
                     }
                 }
+                const modelBone = model.scene.getObjectByName(`rest_${clipBoneName}`);
+                if (modelBone != null) {
+                    modelBone.updateMatrixWorld();
+                    position.divideScalar(modelBone.matrixWorld.getMaxScaleOnAxis());
+                }
                 position.multiplyScalar(positionScale);
                 if (!(model instanceof VRM) && clipBoneName === 'hips') {
                     position.applyQuaternion(nonVrmRotationOffset);
@@ -248,7 +260,7 @@ export async function loadCharacterAnimation(model, url, type, removeXZMovement
     }
     const [clip] = clips;
     if (boneMap != null) {
-        applyBoneMap(clip, clipScene, boneMap);
+        applyAnimationBoneMap(clip, clipScene, boneMap);
     }
     if (mask != null) {
         applyMask(clip, mask);

package/dist/model/index.d.ts

@@ -1,8 +1,11 @@
 import { AnimationAction, AnimationMixer, Object3D, Quaternion } from 'three';
+import type { BoneMap } from '../utils.js';
+import type { VRMHumanBoneName } from '@pixiv/three-vrm';
 export { VRMHumanBoneName } from '@pixiv/three-vrm';
 export * from './vrm.js';
 export type CharacterModelOptions = {
     readonly type?: 'vrm' | 'gltf';
+    readonly boneMap?: Record<string, VRMHumanBoneName>;
     readonly url?: string;
     /**
      * allows to apply an rotation offset when placing objects as children of the character's bones
@@ -25,4 +28,4 @@ export type CharacterModel = {
     currentAnimations: Map<string | undefined, AnimationAction>;
     boneRotationOffset?: Quaternion;
 };
-export declare function loadCharacterModel(url?: string, type?: Exclude<CharacterModelOptions, boolean>['type'], boneRotationOffset?: Quaternion, castShadow?: boolean, receiveShadow?: boolean): Promise<CharacterModel>;
+export declare function loadCharacterModel(url?: string, type?: Exclude<CharacterModelOptions, boolean>['type'], boneRotationOffset?: Quaternion, castShadow?: boolean, receiveShadow?: boolean, boneMap?: BoneMap): Promise<CharacterModel>;

package/dist/model/index.js

@@ -7,9 +7,16 @@ export function flattenCharacterModelOptions(options) {
     if (options == null) {
         return [];
     }
-    return [options.url, options.type, options.boneRotationOffset, options.castShadow, options.receiveShadow];
+    return [
+        options.url,
+        options.type,
+        options.boneRotationOffset,
+        options.castShadow,
+        options.receiveShadow,
+        options.boneMap,
+    ];
 }
-export async function loadCharacterModel(url, type, boneRotationOffset, castShadow = true, receiveShadow = true) {
+export async function loadCharacterModel(url, type, boneRotationOffset, castShadow = true, receiveShadow = true, boneMap) {
     let result;
     if (url == null) {
         //prepare loading the default model
@@ -38,6 +45,7 @@ export async function loadCharacterModel(url, type, boneRotationOffset, castShad
     }
     result.boneRotationOffset = boneRotationOffset;
     result.scene.traverse((obj) => {
+        obj.name = boneMap?.[obj.name] ?? obj.name;
         obj.frustumCulled = false;
         if (castShadow) {
             obj.castShadow = true;

package/dist/model/vrm.d.ts

@@ -1,6 +1,6 @@
 import { VRM } from '@pixiv/three-vrm';
 import { Object3D, Object3DEventMap } from 'three';
-import { GLTFLoader } from 'three/examples/jsm/Addons.js';
+import { GLTFLoader } from 'three/examples/jsm/loaders/GLTFLoader.js';
 export declare const vrmaLoader: GLTFLoader;
 export declare function loadVrmCharacterModel(url: string): Promise<VRM & {
     scene: Object3D<Object3DEventMap & {

package/dist/model/vrm.js

@@ -1,6 +1,6 @@
 import { VRMLoaderPlugin, VRMUtils } from '@pixiv/three-vrm';
 import { VRMAnimationLoaderPlugin } from '@pixiv/three-vrm-animation';
-import { GLTFLoader } from 'three/examples/jsm/Addons.js';
+import { GLTFLoader } from 'three/examples/jsm/loaders/GLTFLoader.js';
 export const vrmaLoader = new GLTFLoader();
 vrmaLoader.register((parser) => new VRMLoaderPlugin(parser, { autoUpdateHumanBones: true }));
 vrmaLoader.register((parser) => new VRMAnimationLoaderPlugin(parser));

package/dist/utils.d.ts

@@ -1,6 +1,7 @@
-import type { CharacterModel } from './model/index.js';
+import type { CharacterModel, VRMHumanBoneName } from './model/index.js';
 import type { BvhCharacterPhysics } from './physics/index.js';
 import type { AnimationAction } from 'three';
+export type BoneMap = Record<string, VRMHumanBoneName>;
 export declare function getIsMobileMediaQuery(): MediaQueryList | undefined;
 export declare function isMobile(): boolean;
 export type StartAnimationOptions = {

package/package.json

@@ -21,7 +21,7 @@
   "peerDependencies": {
     "three": "*"
   },
-  "version": "0.2.6",
+  "version": "0.2.8",
   "type": "module",
   "dependencies": {
     "@pixiv/three-vrm": "^3.4.2",