@pixiv/three-vrm-springbone 2.1.0-beta.2 → 2.1.0-beta.3

package/lib/three-vrm-springbone.js

@@ -1,5 +1,5 @@
 /*!
- * @pixiv/three-vrm-springbone v2.1.0-beta.2
+ * @pixiv/three-vrm-springbone v2.1.0-beta.3
  * Spring bone module for @pixiv/three-vrm
  *
  * Copyright (c) 2020-2024 pixiv Inc.

package/lib/three-vrm-springbone.module.js

@@ -1,5 +1,5 @@
 /*!
- * @pixiv/three-vrm-springbone v2.1.0-beta.2
+ * @pixiv/three-vrm-springbone v2.1.0-beta.3
  * Spring bone module for @pixiv/three-vrm
  *
  * Copyright (c) 2020-2024 pixiv Inc.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pixiv/three-vrm-springbone",
-  "version": "2.1.0-beta.2",
+  "version": "2.1.0-beta.3",
   "description": "Spring bone module for @pixiv/three-vrm",
   "license": "MIT",
   "author": "pixiv",
@@ -50,14 +50,13 @@
     ]
   },
   "dependencies": {
-    "@pixiv/types-vrm-0.0": "2.0.8",
-    "@pixiv/types-vrmc-springbone-1.0": "2.0.8"
+    "@pixiv/types-vrm-0.0": "2.1.0-beta.3",
+    "@pixiv/types-vrmc-springbone-1.0": "2.1.0-beta.3"
   },
   "devDependencies": {
     "three": "^0.160.0"
   },
   "peerDependencies": {
     "three": "^0.160.0"
-  },
-  "gitHead": "22f562d401e2d1e7084e7c9fa0c6e1f23f83edd6"
+  }
 }

package/LICENSE

@@ -1,22 +0,0 @@
-Copyright (c) 2019-2024 pixiv Inc.
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/ts3.4/types/VRMSpringBoneCollider.d.ts

@@ -1,12 +0,0 @@
-import * as THREE from 'three';
-import { VRMSpringBoneColliderShape } from './VRMSpringBoneColliderShape';
-/**
- * Represents a collider of a VRM.
- */
-export declare class VRMSpringBoneCollider extends THREE.Object3D {
-    /**
-     * The shape of the collider.
-     */
-    readonly shape: VRMSpringBoneColliderShape;
-    constructor(shape: VRMSpringBoneColliderShape);
-}

package/ts3.4/types/VRMSpringBoneColliderGroup.d.ts

@@ -1,14 +0,0 @@
-import { VRMSpringBoneCollider } from './VRMSpringBoneCollider';
-/**
- * Represents a collider group of a VRM.
- */
-export interface VRMSpringBoneColliderGroup {
-    /**
-     * The colliders of the collider group.
-     */
-    colliders: VRMSpringBoneCollider[];
-    /**
-     * The name of the collider.
-     */
-    name?: string;
-}

package/ts3.4/types/VRMSpringBoneColliderShape.d.ts

@@ -1,20 +0,0 @@
-/**
- * Represents a shape of a collider.
- */
-export declare abstract class VRMSpringBoneColliderShape {
-    /*
-    * The type of the shape.
-    */
-    abstract readonly type: string;
-    /**
-     * Calculate a distance and a direction from the collider to a target object.
-     * It's hit if the distance is negative.
-     * The direction will be contained in the given target vector.
-     *
-     * @param colliderMatrix A matrix represents the transform of the collider
-     * @param objectPosition A vector represents the position of the target object
-     * @param objectRadius The radius of the object
-     * @param target The result direction will be contained in this vector
-     */
-    abstract calculateCollision(colliderMatrix: THREE.Matrix4, objectPosition: THREE.Vector3, objectRadius: number, target: THREE.Vector3): number;
-}

package/ts3.4/types/VRMSpringBoneColliderShapeCapsule.d.ts

@@ -1,23 +0,0 @@
-import * as THREE from 'three';
-import { VRMSpringBoneColliderShape } from './VRMSpringBoneColliderShape';
-export declare class VRMSpringBoneColliderShapeCapsule extends VRMSpringBoneColliderShape {
-    readonly type: 'capsule';
-    /**
-     * The offset of the head from the origin.
-     */
-    offset: THREE.Vector3;
-    /**
-     * The offset of the tail from the origin.
-     */
-    tail: THREE.Vector3;
-    /**
-     * The radius.
-     */
-    radius: number;
-    constructor(params?: {
-        radius?: number;
-        offset?: THREE.Vector3;
-        tail?: THREE.Vector3;
-    });
-    calculateCollision(colliderMatrix: THREE.Matrix4, objectPosition: THREE.Vector3, objectRadius: number, target: THREE.Vector3): number;
-}

package/ts3.4/types/VRMSpringBoneColliderShapeSphere.d.ts

@@ -1,18 +0,0 @@
-import * as THREE from 'three';
-import { VRMSpringBoneColliderShape } from './VRMSpringBoneColliderShape';
-export declare class VRMSpringBoneColliderShapeSphere extends VRMSpringBoneColliderShape {
-    readonly type: 'sphere';
-    /**
-     * The offset from the origin.
-     */
-    offset: THREE.Vector3;
-    /**
-     * The radius.
-     */
-    radius: number;
-    constructor(params?: {
-        radius?: number;
-        offset?: THREE.Vector3;
-    });
-    calculateCollision(colliderMatrix: THREE.Matrix4, objectPosition: THREE.Vector3, objectRadius: number, target: THREE.Vector3): number;
-}

package/ts3.4/types/VRMSpringBoneJoint.d.ts

@@ -1,116 +0,0 @@
-import * as THREE from 'three';
-import { VRMSpringBoneColliderGroup } from './VRMSpringBoneColliderGroup';
-import { VRMSpringBoneJointSettings } from './VRMSpringBoneJointSettings';
-/**
- * A class represents a single joint of a spring bone.
- * It should be managed by a [[VRMSpringBoneManager]].
- */
-export declare class VRMSpringBoneJoint {
-    /**
-     * Settings of the bone.
-     */
-    settings: VRMSpringBoneJointSettings;
-    /**
-     * Collider groups attached to this bone.
-     */
-    colliderGroups: VRMSpringBoneColliderGroup[];
-    /**
-     * An Object3D attached to this bone.
-     */
-    readonly bone: THREE.Object3D;
-    /**
-     * An Object3D that will be used as a tail of this spring bone.
-     * It can be null when the spring bone is imported from VRM 0.0.
-     */
-    readonly child: THREE.Object3D | null;
-    /**
-     * Current position of child tail, in center unit. Will be used for verlet integration.
-     */
-    private _currentTail;
-    /**
-     * Previous position of child tail, in center unit. Will be used for verlet integration.
-     */
-    private _prevTail;
-    /**
-     * Initial axis of the bone, in local unit.
-     */
-    private _boneAxis;
-    /**
-     * Length of the bone in world unit.
-     * Will be used for normalization in update loop, will be updated by {@link _calcWorldSpaceBoneLength}.
-     *
-     * It's same as local unit length unless there are scale transformations in the world space.
-     */
-    private _worldSpaceBoneLength;
-    /**
-     * This springbone will be calculated based on the space relative from this object.
-     * If this is `null`, springbone will be calculated in world space.
-     */
-    private _center;
-    center: THREE.Object3D | null;
-    /**
-     * Initial state of the local matrix of the bone.
-     */
-    private _initialLocalMatrix;
-    /**
-     * Initial state of the rotation of the bone.
-     */
-    private _initialLocalRotation;
-    /**
-     * Initial state of the position of its child.
-     */
-    private _initialLocalChildPosition;
-    readonly initialLocalChildPosition: THREE.Vector3;
-    /*
-    * Returns the world matrix of its parent object.
-    * Note that it returns a reference to the matrix. Don't mutate this directly!
-    */
-    private readonly _parentMatrixWorld: any;
-    /**
-     * Create a new VRMSpringBone.
-     *
-     * @param bone An Object3D that will be attached to this bone
-     * @param child An Object3D that will be used as a tail of this spring bone. It can be null when the spring bone is imported from VRM 0.0
-     * @param settings Several parameters related to behavior of the spring bone
-     * @param colliderGroups Collider groups that will be collided with this spring bone
-     */
-    constructor(bone: THREE.Object3D, child: THREE.Object3D | null, settings?: Partial<VRMSpringBoneJointSettings>, colliderGroups?: VRMSpringBoneColliderGroup[]);
-    /**
-     * Set the initial state of this spring bone.
-     * You might want to call {@link VRMSpringBoneManager.setInitState} instead.
-     */
-    setInitState(): void;
-    /**
-     * Reset the state of this bone.
-     * You might want to call [[VRMSpringBoneManager.reset]] instead.
-     */
-    reset(): void;
-    /**
-     * Update the state of this bone.
-     * You might want to call [[VRMSpringBoneManager.update]] instead.
-     *
-     * @param delta deltaTime
-     */
-    update(delta: number): void;
-    /**
-     * Do collision math against every colliders attached to this bone.
-     *
-     * @param tail The tail you want to process
-     */
-    private _collision;
-    /**
-     * Calculate the {@link _worldSpaceBoneLength}.
-     * Intended to be used in {@link update}.
-     */
-    private _calcWorldSpaceBoneLength;
-    /**
-     * Create a matrix that converts center space into world space.
-     * @param target Target matrix
-     */
-    private _getMatrixCenterToWorld;
-    /**
-     * Create a matrix that converts world space into center space.
-     * @param target Target matrix
-     */
-    private _getMatrixWorldToCenter;
-}

package/ts3.4/types/VRMSpringBoneJointSettings.d.ts

@@ -1,10 +0,0 @@
-export interface VRMSpringBoneJointSettings {
-    /**
-     * Radius of the bone, will be used for collision.
-     */
-    hitRadius: number;
-    stiffness: number;
-    gravityPower: number;
-    gravityDir: THREE.Vector3;
-    dragForce: number;
-}

package/ts3.4/types/VRMSpringBoneLoaderPlugin.d.ts

@@ -1,34 +0,0 @@
-import * as THREE from 'three';
-import { GLTF, GLTFLoaderPlugin, GLTFParser } from 'three/examples/jsm/loaders/GLTFLoader.js';
-import { VRMSpringBoneLoaderPluginOptions } from './VRMSpringBoneLoaderPluginOptions';
-export declare class VRMSpringBoneLoaderPlugin implements GLTFLoaderPlugin {
-    static readonly EXTENSION_NAME = "VRMC_springBone";
-    /**
-     * Specify an Object3D to add {@link VRMSpringBoneJointHelper} s.
-     * If not specified, helper will not be created.
-     * If `renderOrder` is set to the root, helpers will copy the same `renderOrder` .
-     */
-    jointHelperRoot?: THREE.Object3D;
-    /**
-     * Specify an Object3D to add {@link VRMSpringBoneJointHelper} s.
-     * If not specified, helper will not be created.
-     * If `renderOrder` is set to the root, helpers will copy the same `renderOrder` .
-     */
-    colliderHelperRoot?: THREE.Object3D;
-    readonly parser: GLTFParser;
-    readonly name: string;
-    constructor(parser: GLTFParser, options?: VRMSpringBoneLoaderPluginOptions);
-    afterRoot(gltf: GLTF): Promise<void>;
-    /**
-     * Import spring bones from a GLTF and return a {@link VRMSpringBoneManager}.
-     * It might return `null` instead when it does not need to be created or something go wrong.
-     *
-     * @param gltf A parsed result of GLTF taken from GLTFLoader
-     */
-    private _import;
-    private _v1Import;
-    private _v0Import;
-    private _importJoint;
-    private _importSphereCollider;
-    private _importCapsuleCollider;
-}

package/ts3.4/types/VRMSpringBoneLoaderPluginOptions.d.ts

@@ -1,14 +0,0 @@
-export interface VRMSpringBoneLoaderPluginOptions {
-    /**
-     * Specify an Object3D to add {@link VRMSpringBoneJointHelper} s.
-     * If not specified, helper will not be created.
-     * If `renderOrder` is set to the root, helpers will copy the same `renderOrder` .
-     */
-    jointHelperRoot?: THREE.Object3D;
-    /**
-     * Specify an Object3D to add {@link VRMSpringBoneColliderHelper} s.
-     * If not specified, helper will not be created.
-     * If `renderOrder` is set to the root, helpers will copy the same `renderOrder` .
-     */
-    colliderHelperRoot?: THREE.Object3D;
-}

package/ts3.4/types/VRMSpringBoneManager.d.ts

@@ -1,47 +0,0 @@
-import { VRMSpringBoneJoint } from './VRMSpringBoneJoint';
-import { VRMSpringBoneCollider } from './VRMSpringBoneCollider';
-import { VRMSpringBoneColliderGroup } from './VRMSpringBoneColliderGroup';
-export declare class VRMSpringBoneManager {
-    private _joints;
-    readonly joints: Set<VRMSpringBoneJoint>;
-    /*
-    * @deprecated Use {@link joints} instead.
-    */
-    readonly springBones: Set<VRMSpringBoneJoint>;
-    readonly colliderGroups: VRMSpringBoneColliderGroup[];
-    readonly colliders: VRMSpringBoneCollider[];
-    private _objectSpringBonesMap;
-    addJoint(joint: VRMSpringBoneJoint): void;
-    /**
-     * @deprecated Use {@link addJoint} instead.
-     */
-    addSpringBone(joint: VRMSpringBoneJoint): void;
-    deleteJoint(joint: VRMSpringBoneJoint): void;
-    /**
-     * @deprecated Use {@link deleteJoint} instead.
-     */
-    deleteSpringBone(joint: VRMSpringBoneJoint): void;
-    setInitState(): void;
-    reset(): void;
-    update(delta: number): void;
-    /**
-     * Update a spring bone.
-     * If there are other spring bone that are dependant, it will try to update them recursively.
-     * It updates matrixWorld of all ancestors and myself.
-     * It might throw an error if there are circular dependencies.
-     *
-     * Intended to be used in {@link update} and {@link _processSpringBone} itself recursively.
-     *
-     * @param springBone A springBone you want to update
-     * @param springBonesTried Set of springBones that are already tried to be updated
-     * @param springBonesDone Set of springBones that are already up to date
-     * @param objectUpdated Set of object3D whose matrixWorld is updated
-     */
-    private _processSpringBone;
-    /**
-     * Return a set of objects that are dependant of given spring bone.
-     * @param springBone A spring bone
-     * @return A set of objects that are dependant of given spring bone
-     */
-    private _getDependencies;
-}

package/ts3.4/types/helpers/VRMSpringBoneColliderHelper.d.ts

@@ -1,10 +0,0 @@
-import * as THREE from 'three';
-import { VRMSpringBoneCollider } from '../VRMSpringBoneCollider';
-export declare class VRMSpringBoneColliderHelper extends THREE.Group {
-    readonly collider: VRMSpringBoneCollider;
-    private readonly _geometry;
-    private readonly _line;
-    constructor(collider: VRMSpringBoneCollider);
-    dispose(): void;
-    updateMatrixWorld(force: boolean): void;
-}

package/ts3.4/types/helpers/VRMSpringBoneJointHelper.d.ts

@@ -1,10 +0,0 @@
-import * as THREE from 'three';
-import { VRMSpringBoneJoint } from '../VRMSpringBoneJoint';
-export declare class VRMSpringBoneJointHelper extends THREE.Group {
-    readonly springBone: VRMSpringBoneJoint;
-    private readonly _geometry;
-    private readonly _line;
-    constructor(springBone: VRMSpringBoneJoint);
-    dispose(): void;
-    updateMatrixWorld(force: boolean): void;
-}

package/ts3.4/types/helpers/index.d.ts

@@ -1,2 +0,0 @@
-export { VRMSpringBoneColliderHelper } from './VRMSpringBoneColliderHelper';
-export { VRMSpringBoneJointHelper } from './VRMSpringBoneJointHelper';

package/ts3.4/types/helpers/utils/ColliderShapeBufferGeometry.d.ts

@@ -1,5 +0,0 @@
-import * as THREE from 'three';
-export interface ColliderShapeBufferGeometry extends THREE.BufferGeometry {
-    worldScale: number;
-    update: () => void;
-}

package/ts3.4/types/helpers/utils/ColliderShapeCapsuleBufferGeometry.d.ts

@@ -1,16 +0,0 @@
-import * as THREE from 'three';
-import { VRMSpringBoneColliderShapeCapsule } from '../../VRMSpringBoneColliderShapeCapsule';
-import { ColliderShapeBufferGeometry } from './ColliderShapeBufferGeometry';
-export declare class ColliderShapeCapsuleBufferGeometry extends THREE.BufferGeometry implements ColliderShapeBufferGeometry {
-    worldScale: number;
-    private readonly _attrPos;
-    private readonly _attrIndex;
-    private readonly _shape;
-    private _currentRadius;
-    private readonly _currentOffset;
-    private readonly _currentTail;
-    constructor(shape: VRMSpringBoneColliderShapeCapsule);
-    update(): void;
-    private _buildPosition;
-    private _buildIndex;
-}

package/ts3.4/types/helpers/utils/ColliderShapeSphereBufferGeometry.d.ts

@@ -1,15 +0,0 @@
-import * as THREE from 'three';
-import { VRMSpringBoneColliderShapeSphere } from '../../VRMSpringBoneColliderShapeSphere';
-import { ColliderShapeBufferGeometry } from './ColliderShapeBufferGeometry';
-export declare class ColliderShapeSphereBufferGeometry extends THREE.BufferGeometry implements ColliderShapeBufferGeometry {
-    worldScale: number;
-    private readonly _attrPos;
-    private readonly _attrIndex;
-    private readonly _shape;
-    private _currentRadius;
-    private readonly _currentOffset;
-    constructor(shape: VRMSpringBoneColliderShapeSphere);
-    update(): void;
-    private _buildPosition;
-    private _buildIndex;
-}

package/ts3.4/types/helpers/utils/SpringBoneBufferGeometry.d.ts

@@ -1,14 +0,0 @@
-import * as THREE from 'three';
-import { VRMSpringBoneJoint } from '../../VRMSpringBoneJoint';
-export declare class SpringBoneBufferGeometry extends THREE.BufferGeometry {
-    worldScale: number;
-    private readonly _attrPos;
-    private readonly _attrIndex;
-    private readonly _springBone;
-    private _currentRadius;
-    private readonly _currentTail;
-    constructor(springBone: VRMSpringBoneJoint);
-    update(): void;
-    private _buildPosition;
-    private _buildIndex;
-}

package/ts3.4/types/index.d.ts

@@ -1,10 +0,0 @@
-export * from './helpers';
-export * from './VRMSpringBoneCollider';
-export * from './VRMSpringBoneColliderGroup';
-export * from './VRMSpringBoneColliderShape';
-export * from './VRMSpringBoneColliderShapeCapsule';
-export * from './VRMSpringBoneColliderShapeSphere';
-export * from './VRMSpringBoneJoint';
-export * from './VRMSpringBoneLoaderPlugin';
-export * from './VRMSpringBoneManager';
-export * from './VRMSpringBoneJointSettings';

package/ts3.4/types/tests/VRMSpringBoneColliderShapeCapsule.test.d.ts

@@ -1 +0,0 @@
-export {};

package/ts3.4/types/tests/VRMSpringBoneColliderShapeSphere.test.d.ts

@@ -1 +0,0 @@
-export {};

package/ts3.4/types/tests/matchers/toBeCloseToArray.d.ts

@@ -1,9 +0,0 @@
-/// <reference types="jest" />
-export declare function toBeCloseToArray(received: number[], expected: number[], precision?: number): jest.CustomMatcherResult;
-declare global {
-    namespace jest {
-        interface Matchers<R> {
-            toBeCloseToArray(expected: number[], precision?: number): R;
-        }
-    }
-}

package/ts3.4/types/tests/matchers/toBeCloseToVector3.d.ts

@@ -1,10 +0,0 @@
-/// <reference types="jest" />
-import * as THREE from 'three';
-export declare function toBeCloseToVector3(received: THREE.Vector3, expected: THREE.Vector3, precision?: number): jest.CustomMatcherResult;
-declare global {
-    namespace jest {
-        interface Matchers<R> {
-            toBeCloseToVector3(expected: THREE.Vector3, precision?: number): R;
-        }
-    }
-}

package/ts3.4/types/utils/Matrix4InverseCache.d.ts

@@ -1,28 +0,0 @@
-import * as THREE from 'three';
-export declare class Matrix4InverseCache {
-    /**
-     * The target matrix.
-     */
-    readonly matrix: THREE.Matrix4;
-    /**
-     * A cache of inverse of current matrix.
-     */
-    private readonly _inverseCache;
-    /**
-     * A flag that makes it want to recalculate its {@link _inverseCache}.
-     * Will be set `true` when `elements` are mutated and be used in `getInverse`.
-     */
-    private _shouldUpdateInverse;
-    /**
-     * The original of `matrix.elements`
-     */
-    private readonly _originalElements;
-    /*
-    * Inverse of given matrix.
-    * Note that it will return its internal private instance.
-    * Make sure copying this before mutate this.
-    */
-    readonly inverse: THREE.Matrix4;
-    constructor(matrix: THREE.Matrix4);
-    revert(): void;
-}

package/ts3.4/types/utils/getWorldQuaternionLite.d.ts

@@ -1,10 +0,0 @@
-import * as THREE from 'three';
-/**
- * A replacement of `Object3D.getWorldQuaternion`.
- * Extract the world quaternion of an object from its world space matrix, without calling `Object3D.updateWorldMatrix`.
- * Use this when you're sure that the world matrix is up-to-date.
- *
- * @param object The object
- * @param out A target quaternion
- */
-export declare function getWorldQuaternionLite(object: THREE.Object3D, out: THREE.Quaternion): THREE.Quaternion;

package/ts3.4/types/utils/mat4InvertCompat.d.ts

@@ -1,8 +0,0 @@
-import * as THREE from 'three';
-/**
- * A compat function for `Matrix4.invert()` / `Matrix4.getInverse()`.
- * `Matrix4.invert()` is introduced in r123 and `Matrix4.getInverse()` emits a warning.
- * We are going to use this compat for a while.
- * @param target A target matrix
- */
-export declare function mat4InvertCompat<T extends THREE.Matrix4>(target: T): T;

package/ts3.4/types/utils/traverseAncestorsFromRoot.d.ts

@@ -1,2 +0,0 @@
-import * as THREE from 'three';
-export declare function traverseAncestorsFromRoot(object: THREE.Object3D, callback: (object: THREE.Object3D) => void): void;

package/ts3.4/types/utils/traverseChildrenUntilConditionMet.d.ts

@@ -1,8 +0,0 @@
-/**
- * Traverse children of given object and execute given callback.
- * The given object itself wont be given to the callback.
- * If the return value of the callback is `true`, it will halt the traversal of its children.
- * @param object A root object
- * @param callback A callback function called for each children
- */
-export declare function traverseChildrenUntilConditionMet(object: THREE.Object3D, callback: (object: THREE.Object3D) => boolean): void;