@pixiv/three-vrm-core 2.1.2 → 3.0.0-beta.0

package/ts3.4/types/meta/VRM1Meta.d.ts

@@ -1,86 +0,0 @@
-/**
- * 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/ts3.4/types/meta/VRMMeta.d.ts

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

package/ts3.4/types/meta/VRMMetaLoaderPlugin.d.ts

@@ -1,32 +0,0 @@
-import { GLTF, GLTFLoaderPlugin, GLTFParser } from 'three/examples/jsm/loaders/GLTFLoader.js';
-import { 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;
-    readonly name: string;
-    constructor(parser: GLTFParser, options?: VRMMetaLoaderPluginOptions);
-    afterRoot(gltf: GLTF): Promise<void>;
-    private _import;
-    private _v1Import;
-    private _v0Import;
-    private _extractGLTFImage;
-}

package/ts3.4/types/meta/VRMMetaLoaderPluginOptions.d.ts

@@ -1,22 +0,0 @@
-/**
- * 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/ts3.4/types/meta/index.d.ts

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

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

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

@@ -1,22 +0,0 @@
-import * as THREE from 'three';
-import { GLTF } from 'three/examples/jsm/loaders/GLTFLoader.js';
-/**
- * Extract primitives ( `THREE.Mesh[]` ) of a node from a loaded GLTF.
- * The main purpose of this function is to distinguish primitives and children from a node that has both meshes and children.
- *
- * It utilizes the behavior that GLTFLoader adds mesh primitives to the node object ( `THREE.Group` ) first then adds its children.
- *
- * @param gltf A GLTF object taken from GLTFLoader
- * @param nodeIndex The index of the node
- */
-export declare function gltfExtractPrimitivesFromNode(gltf: GLTF, nodeIndex: number): Promise<THREE.Mesh[] | null>;
-/**
- * Extract primitives ( `THREE.Mesh[]` ) of nodes from a loaded GLTF.
- * See {@link gltfExtractPrimitivesFromNode} for more details.
- *
- * It returns a map from node index to extraction result.
- * If a node does not have a mesh, the entry for the node will not be put in the returning map.
- *
- * @param gltf A GLTF object taken from GLTFLoader
- */
-export declare function gltfExtractPrimitivesFromNodes(gltf: GLTF): Promise<Map<number, THREE.Mesh[]>>;

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

@@ -1,10 +0,0 @@
-import * as THREE from 'three';
-import { GLTFParser } from 'three/examples/jsm/loaders/GLTFLoader.js';
-/**
- * Get a material definition index of glTF from associated material.
- * It's basically a comat code between Three.js r133 or above and previous versions.
- * @param parser GLTFParser
- * @param material A material of gltf
- * @returns Material definition index of glTF
- */
-export declare function gltfGetAssociatedMaterialIndex(parser: GLTFParser, material: THREE.Material): number | null;

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

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

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

@@ -1 +0,0 @@
-export declare function renameMaterialProperty(name: string): string;

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

@@ -1,4 +0,0 @@
-/**
- * Yoinked from https://github.com/mrdoob/three.js/blob/master/examples/jsm/loaders/GLTFLoader.js
- */
-export declare function resolveURL(url: string, path: string): string;

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

@@ -1,6 +0,0 @@
-/**
- * Clamp the input value within [0.0 - 1.0].
- *
- * @param value The input value
- */
-export declare function saturate(value: number): number;

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

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

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

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

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

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

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

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

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

@@ -1,10 +0,0 @@
-/// <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

@@ -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;
-        }
-    }
-}