@pixiv/three-vrm-core 1.0.0-beta.9 → 1.0.1

package/types/lookAt/VRMLookAtTypeName.d.ts

@@ -1,8 +1,8 @@
-/**
- * Represents a type of applier.
- */
-export declare const VRMLookAtTypeName: {
-    Bone: string;
-    Expression: string;
-};
-export declare type VRMLookAtTypeName = typeof VRMLookAtTypeName[keyof typeof VRMLookAtTypeName];
+/**
+ * Represents a type of applier.
+ */
+export declare const VRMLookAtTypeName: {
+    Bone: string;
+    Expression: string;
+};
+export declare type VRMLookAtTypeName = typeof VRMLookAtTypeName[keyof typeof VRMLookAtTypeName];

package/types/lookAt/helpers/VRMLookAtHelper.d.ts

@@ -1,11 +1,11 @@
-import * as THREE from 'three';
-import { VRMLookAt } from '../VRMLookAt';
-export declare class VRMLookAtHelper extends THREE.Group {
-    readonly vrmLookAt: VRMLookAt;
-    private readonly _meshYaw;
-    private readonly _meshPitch;
-    private readonly _lineTarget;
-    constructor(lookAt: VRMLookAt);
-    dispose(): void;
-    updateMatrixWorld(force: boolean): void;
-}
+import * as THREE from 'three';
+import { VRMLookAt } from '../VRMLookAt';
+export declare class VRMLookAtHelper extends THREE.Group {
+    readonly vrmLookAt: VRMLookAt;
+    private readonly _meshYaw;
+    private readonly _meshPitch;
+    private readonly _lineTarget;
+    constructor(lookAt: VRMLookAt);
+    dispose(): void;
+    updateMatrixWorld(force: boolean): void;
+}

package/types/lookAt/helpers/index.d.ts

@@ -1 +1 @@
-export { VRMLookAtHelper } from './VRMLookAtHelper';
+export { VRMLookAtHelper } from './VRMLookAtHelper';

package/types/lookAt/helpers/utils/FanBufferGeometry.d.ts

@@ -1,13 +1,13 @@
-import * as THREE from 'three';
-export declare class FanBufferGeometry extends THREE.BufferGeometry {
-    theta: number;
-    radius: number;
-    private _currentTheta;
-    private _currentRadius;
-    private readonly _attrPos;
-    private readonly _attrIndex;
-    constructor();
-    update(): void;
-    private _buildPosition;
-    private _buildIndex;
-}
+import * as THREE from 'three';
+export declare class FanBufferGeometry extends THREE.BufferGeometry {
+    theta: number;
+    radius: number;
+    private _currentTheta;
+    private _currentRadius;
+    private readonly _attrPos;
+    private readonly _attrIndex;
+    constructor();
+    update(): void;
+    private _buildPosition;
+    private _buildIndex;
+}

package/types/lookAt/helpers/utils/LineAndSphereBufferGeometry.d.ts

@@ -1,13 +1,13 @@
-import * as THREE from 'three';
-export declare class LineAndSphereBufferGeometry extends THREE.BufferGeometry {
-    radius: number;
-    tail: THREE.Vector3;
-    private _currentRadius;
-    private _currentTail;
-    private readonly _attrPos;
-    private readonly _attrIndex;
-    constructor();
-    update(): void;
-    private _buildPosition;
-    private _buildIndex;
-}
+import * as THREE from 'three';
+export declare class LineAndSphereBufferGeometry extends THREE.BufferGeometry {
+    radius: number;
+    tail: THREE.Vector3;
+    private _currentRadius;
+    private _currentTail;
+    private readonly _attrPos;
+    private readonly _attrIndex;
+    constructor();
+    update(): void;
+    private _buildPosition;
+    private _buildIndex;
+}

package/types/lookAt/index.d.ts

@@ -1,8 +1,8 @@
-export * from './helpers';
-export { VRMLookAt } from './VRMLookAt';
-export type { VRMLookAtApplier } from './VRMLookAtApplier';
-export { VRMLookAtBoneApplier } from './VRMLookAtBoneApplier';
-export { VRMLookAtExpressionApplier } from './VRMLookAtExpressionApplier';
-export { VRMLookAtLoaderPlugin } from './VRMLookAtLoaderPlugin';
-export { VRMLookAtRangeMap } from './VRMLookAtRangeMap';
-export { VRMLookAtTypeName } from './VRMLookAtTypeName';
+export * from './helpers';
+export { VRMLookAt } from './VRMLookAt';
+export type { VRMLookAtApplier } from './VRMLookAtApplier';
+export { VRMLookAtBoneApplier } from './VRMLookAtBoneApplier';
+export { VRMLookAtExpressionApplier } from './VRMLookAtExpressionApplier';
+export { VRMLookAtLoaderPlugin } from './VRMLookAtLoaderPlugin';
+export { VRMLookAtRangeMap } from './VRMLookAtRangeMap';
+export { VRMLookAtTypeName } from './VRMLookAtTypeName';

package/types/lookAt/tests/VRMLookAt.test.d.ts

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

package/types/lookAt/tests/VRMLookAtBoneApplier.test.d.ts

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

package/types/lookAt/utils/calcAzimuthAltitude.d.ts

@@ -0,0 +1,13 @@
+import * as THREE from 'three';
+/**
+ * Calculate azimuth / altitude angles from a vector.
+ *
+ * This returns a difference of angles from (1, 0, 0).
+ * Azimuth represents an angle around Y axis.
+ * Altitude represents an angle around Z axis.
+ * It is rotated in intrinsic Y-Z order.
+ *
+ * @param vector The vector
+ * @returns A tuple contains two angles, `[ azimuth, altitude ]`
+ */
+export declare function calcAzimuthAltitude(vector: THREE.Vector3): [azimuth: number, altitude: number];

package/types/lookAt/utils/sanitizeAngle.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Make sure the angle is within -PI to PI.
+ *
+ * @example
+ * ```js
+ * sanitizeAngle(1.5 * Math.PI) // -0.5 * PI
+ * ```
+ *
+ * @param angle An input angle
+ */
+export declare function sanitizeAngle(angle: number): number;

package/types/lookAt/utils/tests/calcAzimuthAltitude.test.d.ts

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

package/types/lookAt/utils/tests/sanitizeAngle.test.d.ts

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

package/types/meta/VRM0Meta.d.ts

@@ -1,62 +1,62 @@
-import * as THREE from 'three';
-/**
- * Interface represents metadata of a VRM 0.0 model.
- */
-export interface VRM0Meta {
-    /**
-     * The version of meta.
-     */
-    metaVersion: '0';
-    /**
-     * Enum indicates a condition who can perform with this avatar.
-     */
-    allowedUserName?: 'Everyone' | 'ExplicitlyLicensedPerson' | 'OnlyAuthor';
-    /**
-     * Author of the model.
-     */
-    author?: string;
-    /**
-     * Enum indicates allow or disallow commercial use.
-     */
-    commercialUssageName?: 'Allow' | 'Disallow';
-    /**
-     * Contact Information of its author.
-     */
-    contactInformation?: string;
-    /**
-     * Enum indicates a license type.
-     */
-    licenseName?: 'CC0' | 'CC_BY' | 'CC_BY_NC' | 'CC_BY_NC_ND' | 'CC_BY_NC_SA' | 'CC_BY_ND' | 'CC_BY_SA' | 'Other' | 'Redistribution_Prohibited';
-    /**
-     * If `Other` is selected for {@link licenseName}, put the URL link of the license document here.
-     */
-    otherLicenseUrl?: string;
-    /**
-     * If there are any conditions not mentioned in {@link licenseName} or {@link otherLicenseUrl}, put the URL link of the license document here.
-     */
-    otherPermissionUrl?: string;
-    /**
-     * Reference of the model.
-     */
-    reference?: string;
-    /**
-     * Enum indicates allow or disallow sexual expressions.
-     */
-    sexualUssageName?: 'Allow' | 'Disallow';
-    /**
-     * Thumbnail of the model.
-     */
-    texture?: THREE.Texture;
-    /**
-     * Title of the model.
-     */
-    title?: string;
-    /**
-     * Version of the model.
-     */
-    version?: string;
-    /**
-     * Enum indicates allow or disallow violent expressions.
-     */
-    violentUssageName?: 'Allow' | 'Disallow';
-}
+import * as THREE from 'three';
+/**
+ * Interface represents metadata of a VRM 0.0 model.
+ */
+export interface VRM0Meta {
+    /**
+     * The version of meta.
+     */
+    metaVersion: '0';
+    /**
+     * Enum indicates a condition who can perform with this avatar.
+     */
+    allowedUserName?: 'Everyone' | 'ExplicitlyLicensedPerson' | 'OnlyAuthor';
+    /**
+     * Author of the model.
+     */
+    author?: string;
+    /**
+     * Enum indicates allow or disallow commercial use.
+     */
+    commercialUssageName?: 'Allow' | 'Disallow';
+    /**
+     * Contact Information of its author.
+     */
+    contactInformation?: string;
+    /**
+     * Enum indicates a license type.
+     */
+    licenseName?: 'CC0' | 'CC_BY' | 'CC_BY_NC' | 'CC_BY_NC_ND' | 'CC_BY_NC_SA' | 'CC_BY_ND' | 'CC_BY_SA' | 'Other' | 'Redistribution_Prohibited';
+    /**
+     * If `Other` is selected for {@link licenseName}, put the URL link of the license document here.
+     */
+    otherLicenseUrl?: string;
+    /**
+     * If there are any conditions not mentioned in {@link licenseName} or {@link otherLicenseUrl}, put the URL link of the license document here.
+     */
+    otherPermissionUrl?: string;
+    /**
+     * Reference of the model.
+     */
+    reference?: string;
+    /**
+     * Enum indicates allow or disallow sexual expressions.
+     */
+    sexualUssageName?: 'Allow' | 'Disallow';
+    /**
+     * Thumbnail of the model.
+     */
+    texture?: THREE.Texture;
+    /**
+     * Title of the model.
+     */
+    title?: string;
+    /**
+     * Version of the model.
+     */
+    version?: string;
+    /**
+     * Enum indicates allow or disallow violent expressions.
+     */
+    violentUssageName?: 'Allow' | 'Disallow';
+}

package/types/meta/VRM1Meta.d.ts

@@ -1,86 +1,86 @@
-/**
- * Interface represents metadata of a VRM 1.0 model.
- */
-export interface VRM1Meta {
-    /**
-     * The version of meta.
-     */
-    metaVersion: '1';
-    /**
-     * The name of the model.
-     */
-    name: string;
-    /**
-     * The version of the model.
-     */
-    version?: string;
-    /**
-     * Authors of the model.
-     */
-    authors: string[];
-    /**
-     * An information that describes the copyright of the model.
-     */
-    copyrightInformation?: string;
-    /**
-     * An information that describes the contact information of the author.
-     */
-    contactInformation?: string;
-    /**
-     * References / original works of the model.
-     */
-    references?: string[];
-    /**
-     * Third party licenses of the model, if required. You can use line breaks.
-     */
-    thirdPartyLicenses?: string;
-    /**
-     * An image of the thumbnail image of the model.
-     * This is for the application to use as an icon.
-     */
-    thumbnailImage?: HTMLImageElement;
-    /**
-     * A URL towards the license document this model refers to
-     */
-    licenseUrl: string;
-    /**
-     * A person who can perform as an avatar with this model.
-     */
-    avatarPermission?: 'onlyAuthor' | 'onlySeparatelyLicensedPerson' | 'everyone';
-    /**
-     * A flag that permits to use this model in excessively violent contents.
-     */
-    allowExcessivelyViolentUsage?: boolean;
-    /**
-     * A flag that permits to use this model in excessively sexual contents.
-     */
-    allowExcessivelySexualUsage?: boolean;
-    /**
-     * An option that permits to use this model in commercial products.
-     */
-    commercialUsage?: 'personalNonProfit' | 'personalProfit' | 'corporation';
-    /**
-     * A flag that permits to use this model in political or religious contents.
-     */
-    allowPoliticalOrReligiousUsage?: boolean;
-    /**
-     * A flag that permits to use this model in contents contain anti-social activities or hate speeches.
-     */
-    allowAntisocialOrHateUsage?: boolean;
-    /**
-     * An option that forces or abandons to display the credit of this model.
-     */
-    creditNotation?: 'required' | 'unnecessary';
-    /**
-     * A flag that permits to redistribute this model.
-     */
-    allowRedistribution?: boolean;
-    /**
-     * An option that controls the condition to modify this model.
-     */
-    modification?: 'prohibited' | 'allowModification' | 'allowModificationRedistribution';
-    /**
-     * Describe the URL links of other license.
-     */
-    otherLicenseUrl?: string;
-}
+/**
+ * Interface represents metadata of a VRM 1.0 model.
+ */
+export interface VRM1Meta {
+    /**
+     * The version of meta.
+     */
+    metaVersion: '1';
+    /**
+     * The name of the model.
+     */
+    name: string;
+    /**
+     * The version of the model.
+     */
+    version?: string;
+    /**
+     * Authors of the model.
+     */
+    authors: string[];
+    /**
+     * An information that describes the copyright of the model.
+     */
+    copyrightInformation?: string;
+    /**
+     * An information that describes the contact information of the author.
+     */
+    contactInformation?: string;
+    /**
+     * References / original works of the model.
+     */
+    references?: string[];
+    /**
+     * Third party licenses of the model, if required. You can use line breaks.
+     */
+    thirdPartyLicenses?: string;
+    /**
+     * An image of the thumbnail image of the model.
+     * This is for the application to use as an icon.
+     */
+    thumbnailImage?: HTMLImageElement;
+    /**
+     * A URL towards the license document this model refers to
+     */
+    licenseUrl: string;
+    /**
+     * A person who can perform as an avatar with this model.
+     */
+    avatarPermission?: 'onlyAuthor' | 'onlySeparatelyLicensedPerson' | 'everyone';
+    /**
+     * A flag that permits to use this model in excessively violent contents.
+     */
+    allowExcessivelyViolentUsage?: boolean;
+    /**
+     * A flag that permits to use this model in excessively sexual contents.
+     */
+    allowExcessivelySexualUsage?: boolean;
+    /**
+     * An option that permits to use this model in commercial products.
+     */
+    commercialUsage?: 'personalNonProfit' | 'personalProfit' | 'corporation';
+    /**
+     * A flag that permits to use this model in political or religious contents.
+     */
+    allowPoliticalOrReligiousUsage?: boolean;
+    /**
+     * A flag that permits to use this model in contents contain anti-social activities or hate speeches.
+     */
+    allowAntisocialOrHateUsage?: boolean;
+    /**
+     * An option that forces or abandons to display the credit of this model.
+     */
+    creditNotation?: 'required' | 'unnecessary';
+    /**
+     * A flag that permits to redistribute this model.
+     */
+    allowRedistribution?: boolean;
+    /**
+     * An option that controls the condition to modify this model.
+     */
+    modification?: 'prohibited' | 'allowModification' | 'allowModificationRedistribution';
+    /**
+     * Describe the URL links of other license.
+     */
+    otherLicenseUrl?: string;
+}

package/types/meta/VRMMeta.d.ts

@@ -1,6 +1,6 @@
-import type { VRM0Meta } from './VRM0Meta';
-import type { VRM1Meta } from './VRM1Meta';
-/**
- * VRMMeta can be either {@link VRM0Meta} or {@link VRM1Meta}.
- */
-export declare type VRMMeta = VRM0Meta | VRM1Meta;
+import type { VRM0Meta } from './VRM0Meta';
+import type { VRM1Meta } from './VRM1Meta';
+/**
+ * VRMMeta can be either {@link VRM0Meta} or {@link VRM1Meta}.
+ */
+export declare type VRMMeta = VRM0Meta | VRM1Meta;

package/types/meta/VRMMetaLoaderPlugin.d.ts

@@ -1,32 +1,32 @@
-import type { GLTF, GLTFLoaderPlugin, GLTFParser } from 'three/examples/jsm/loaders/GLTFLoader.js';
-import type { VRMMetaLoaderPluginOptions } from './VRMMetaLoaderPluginOptions';
-/**
- * A plugin of GLTFLoader that imports a {@link VRM1Meta} from a VRM extension of a GLTF.
- */
-export declare class VRMMetaLoaderPlugin implements GLTFLoaderPlugin {
-    readonly parser: GLTFParser;
-    /**
-     * If `false`, it won't load its thumbnail image ({@link VRM1Meta.thumbnailImage}).
-     * `true` by default.
-     */
-    needThumbnailImage: boolean;
-    /**
-     * A list of license urls.
-     * This meta loader will accept these `licenseUrl`s.
-     * Otherwise it won't be loaded.
-     */
-    acceptLicenseUrls: string[];
-    /**
-     * Whether it should accept VRM0.X meta or not.
-     * Note that it might load {@link VRM0Meta} instead of {@link VRM1Meta} when this is `true`.
-     * `true` by default.
-     */
-    acceptV0Meta: boolean;
-    get name(): string;
-    constructor(parser: GLTFParser, options?: VRMMetaLoaderPluginOptions);
-    afterRoot(gltf: GLTF): Promise<void>;
-    private _import;
-    private _v1Import;
-    private _v0Import;
-    private _extractGLTFImage;
-}
+import type { GLTF, GLTFLoaderPlugin, GLTFParser } from 'three/examples/jsm/loaders/GLTFLoader.js';
+import type { VRMMetaLoaderPluginOptions } from './VRMMetaLoaderPluginOptions';
+/**
+ * A plugin of GLTFLoader that imports a {@link VRM1Meta} from a VRM extension of a GLTF.
+ */
+export declare class VRMMetaLoaderPlugin implements GLTFLoaderPlugin {
+    readonly parser: GLTFParser;
+    /**
+     * If `false`, it won't load its thumbnail image ({@link VRM1Meta.thumbnailImage}).
+     * `true` by default.
+     */
+    needThumbnailImage: boolean;
+    /**
+     * A list of license urls.
+     * This meta loader will accept these `licenseUrl`s.
+     * Otherwise it won't be loaded.
+     */
+    acceptLicenseUrls: string[];
+    /**
+     * Whether it should accept VRM0.0 meta or not.
+     * Note that it might load {@link VRM0Meta} instead of {@link VRM1Meta} when this is `true`.
+     * `true` by default.
+     */
+    acceptV0Meta: boolean;
+    get name(): string;
+    constructor(parser: GLTFParser, options?: VRMMetaLoaderPluginOptions);
+    afterRoot(gltf: GLTF): Promise<void>;
+    private _import;
+    private _v1Import;
+    private _v0Import;
+    private _extractGLTFImage;
+}

package/types/meta/VRMMetaLoaderPluginOptions.d.ts

@@ -1,22 +1,22 @@
-/**
- * A set of options for a {@link VRMMetaLoaderPlugin} instance.
- */
-export interface VRMMetaLoaderPluginOptions {
-    /**
-     * If `false`, it won't load its thumbnail image ({@link VRM1Meta.thumbnailImage}).
-     * `true` by default.
-     */
-    needThumbnailImage?: boolean;
-    /**
-     * A list of license urls.
-     * This meta loader will accept these `licenseUrl`s.
-     * Otherwise it will throw an error.
-     */
-    acceptLicenseUrls?: string[];
-    /**
-     * Whether it should accept VRM0.X meta or not.
-     * Note that it might load {@link VRM0Meta} instead of {@link VRM1Meta} when this is `true`.
-     * `true` by default.
-     */
-    acceptV0Meta?: boolean;
-}
+/**
+ * A set of options for a {@link VRMMetaLoaderPlugin} instance.
+ */
+export interface VRMMetaLoaderPluginOptions {
+    /**
+     * If `false`, it won't load its thumbnail image ({@link VRM1Meta.thumbnailImage}).
+     * `true` by default.
+     */
+    needThumbnailImage?: boolean;
+    /**
+     * A list of license urls.
+     * This meta loader will accept these `licenseUrl`s.
+     * Otherwise it will throw an error.
+     */
+    acceptLicenseUrls?: string[];
+    /**
+     * Whether it should accept VRM0.0 meta or not.
+     * Note that it might load {@link VRM0Meta} instead of {@link VRM1Meta} when this is `true`.
+     * `true` by default.
+     */
+    acceptV0Meta?: boolean;
+}

package/types/meta/index.d.ts

@@ -1,5 +1,5 @@
-export type { VRM0Meta } from './VRM0Meta';
-export type { VRM1Meta } from './VRM1Meta';
-export type { VRMMeta } from './VRMMeta';
-export type { VRMMetaLoaderPluginOptions as VRMMetaImporterOptions } from './VRMMetaLoaderPluginOptions';
-export { VRMMetaLoaderPlugin } from './VRMMetaLoaderPlugin';
+export type { VRM0Meta } from './VRM0Meta';
+export type { VRM1Meta } from './VRM1Meta';
+export type { VRMMeta } from './VRMMeta';
+export type { VRMMetaLoaderPluginOptions as VRMMetaImporterOptions } from './VRMMetaLoaderPluginOptions';
+export { VRMMetaLoaderPlugin } from './VRMMetaLoaderPlugin';

package/types/tests/matchers/toBeCloseToQuaternion.d.ts

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

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

@@ -0,0 +1,10 @@
+/// <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/types/utils/getWorldQuaternionLite.d.ts

@@ -1,8 +1,8 @@
-import * as THREE from 'three';
-/**
- * Extract world rotation of an object from its world space matrix, in cheaper way.
- *
- * @param object The object
- * @param out Target vector
- */
-export declare function getWorldQuaternionLite(object: THREE.Object3D, out: THREE.Quaternion): THREE.Quaternion;
+import * as THREE from 'three';
+/**
+ * Extract world rotation of an object from its world space matrix, in cheaper way.
+ *
+ * @param object The object
+ * @param out Target vector
+ */
+export declare function getWorldQuaternionLite(object: THREE.Object3D, out: THREE.Quaternion): THREE.Quaternion;