@pixiv/types-vrmc-node-constraint-1.0 1.0.0-beta.3

package/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2019-2021 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/README.md

@@ -0,0 +1,9 @@
+# @pixiv/types-vrmc-node-constraint-1.0
+
+Type definitions of VRMC_node_constraint 1.0 schema.
+
+https://github.com/vrm-c/vrm-specification/tree/master/specification/VRMC_node_constraint-1.0_draft
+
+There should not be any implementation in this package. Just type definitions of the schema.
+
+The extension root is named `VRMCNodeConstraint` .

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@pixiv/types-vrmc-node-constraint-1.0",
+  "version": "1.0.0-beta.3",
+  "description": "Type definitions of VRMC_node_constraint 1.0 schema",
+  "license": "MIT",
+  "author": "pixiv",
+  "files": [
+    "/ts*/",
+    "/types/",
+    "LICENSE"
+  ],
+  "main": "",
+  "types": "types/index.d.ts",
+  "typesVersions": {
+    "<3.9": {
+      "*": [
+        "ts3.4/*"
+      ]
+    }
+  },
+  "scripts": {
+    "version": "yarn all",
+    "all": "yarn lint && yarn clean && yarn build && yarn docs",
+    "clean": "rimraf docs/ ts*/ types/",
+    "build": "tsc --declaration --declarationDir ./types --emitDeclarationOnly && downlevel-dts types ts3.4/types",
+    "docs": "typedoc --entryPoints ./src/index.ts --out docs",
+    "lint": "eslint \"src/**/*.{ts,tsx}\" && prettier \"src/**/*.{ts,tsx}\" --check",
+    "lint-fix": "eslint \"src/**/*.{ts,tsx}\" --fix && prettier \"src/**/*.{ts,tsx}\" --write"
+  },
+  "lint-staged": {
+    "./src/**/*.{ts,tsx}": [
+      "eslint --fix",
+      "prettier --write"
+    ]
+  },
+  "gitHead": "fb89b23619d6e4b14aab1be3c482a0d5424ee7d8"
+}

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

@@ -0,0 +1,45 @@
+import { ConstraintObjectSpace } from './ConstraintObjectSpace';
+/**
+ * A constraint that rotates the node to face sources.
+ */
+export interface AimConstraint {
+    /**
+     * The index of the node constrains the node.
+     */
+    source: number;
+    /**
+     * The source node will be evaluated in this space.
+     */
+    sourceSpace?: ConstraintObjectSpace;
+    /**
+     * The destination node will be evaluated in this space.
+     */
+    destinationSpace?: ConstraintObjectSpace;
+    /**
+     * An axis which faces the direction of its sources.
+     */
+    aimVector?: [
+        number,
+        number,
+        number
+    ];
+    /**
+     * An up axis of the constraint.
+     */
+    upVector?: [
+        number,
+        number,
+        number
+    ];
+    /**
+     * Axes be constrained by this constraint, in Yaw-Pitch order.
+     */
+    freezeAxes?: [
+        boolean,
+        boolean
+    ];
+    /**
+     * The weight of the constraint.
+     */
+    weight?: number;
+}

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

@@ -0,0 +1 @@
+export declare type ConstraintObjectSpace = 'model' | 'local';

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

@@ -0,0 +1,30 @@
+import { ConstraintObjectSpace } from './ConstraintObjectSpace';
+/**
+ * A constraint that links the position with sources.
+ */
+export interface PositionConstraint {
+    /**
+     * The index of the node constrains the node.
+     */
+    source: number;
+    /**
+     * The source node will be evaluated in this space.
+     */
+    sourceSpace?: ConstraintObjectSpace;
+    /**
+     * The destination node will be evaluated in this space.
+     */
+    destinationSpace?: ConstraintObjectSpace;
+    /**
+     * Axes be constrained by this constraint, in X-Y-Z order.
+     */
+    freezeAxes?: [
+        boolean,
+        boolean,
+        boolean
+    ];
+    /**
+     * The weight of the constraint.
+     */
+    weight?: number;
+}

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

@@ -0,0 +1,30 @@
+import { ConstraintObjectSpace } from './ConstraintObjectSpace';
+/**
+ * A constraint that links the rotation with sources.
+ */
+export interface RotationConstraint {
+    /**
+     * The index of the node constrains the node.
+     */
+    source: number;
+    /**
+     * The source node will be evaluated in this space.
+     */
+    sourceSpace?: ConstraintObjectSpace;
+    /**
+     * The destination node will be evaluated in this space.
+     */
+    destinationSpace?: ConstraintObjectSpace;
+    /**
+     * Axes be constrained by this constraint, in X-Y-Z order.
+     */
+    freezeAxes?: [
+        boolean,
+        boolean,
+        boolean
+    ];
+    /**
+     * The weight of the constraint.
+     */
+    weight?: number;
+}

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

@@ -0,0 +1,19 @@
+import { AimConstraint } from './AimConstraint';
+import { PositionConstraint } from './PositionConstraint';
+import { RotationConstraint } from './RotationConstraint';
+/**
+ * glTF extension that defines a node constraint.
+ */
+export interface VRMCNodeConstraint {
+    /**
+     * Specification version of VRMC_node_constraint
+     */
+    specVersion: '1.0-draft';
+    position?: PositionConstraint;
+    rotation?: RotationConstraint;
+    aim?: AimConstraint;
+    extensions?: {
+        [name: string]: any;
+    };
+    extras?: any;
+}

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

@@ -0,0 +1,5 @@
+export { AimConstraint } from './AimConstraint';
+export { ConstraintObjectSpace } from './ConstraintObjectSpace';
+export { PositionConstraint } from './PositionConstraint';
+export { RotationConstraint } from './RotationConstraint';
+export { VRMCNodeConstraint } from './VRMCNodeConstraint';

package/types/AimConstraint.d.ts

@@ -0,0 +1,34 @@
+import type { ConstraintObjectSpace } from './ConstraintObjectSpace';
+/**
+ * A constraint that rotates the node to face sources.
+ */
+export interface AimConstraint {
+    /**
+     * The index of the node constrains the node.
+     */
+    source: number;
+    /**
+     * The source node will be evaluated in this space.
+     */
+    sourceSpace?: ConstraintObjectSpace;
+    /**
+     * The destination node will be evaluated in this space.
+     */
+    destinationSpace?: ConstraintObjectSpace;
+    /**
+     * An axis which faces the direction of its sources.
+     */
+    aimVector?: [number, number, number];
+    /**
+     * An up axis of the constraint.
+     */
+    upVector?: [number, number, number];
+    /**
+     * Axes be constrained by this constraint, in Yaw-Pitch order.
+     */
+    freezeAxes?: [boolean, boolean];
+    /**
+     * The weight of the constraint.
+     */
+    weight?: number;
+}

package/types/ConstraintObjectSpace.d.ts

@@ -0,0 +1 @@
+export declare type ConstraintObjectSpace = 'model' | 'local';

package/types/PositionConstraint.d.ts

@@ -0,0 +1,26 @@
+import type { ConstraintObjectSpace } from './ConstraintObjectSpace';
+/**
+ * A constraint that links the position with sources.
+ */
+export interface PositionConstraint {
+    /**
+     * The index of the node constrains the node.
+     */
+    source: number;
+    /**
+     * The source node will be evaluated in this space.
+     */
+    sourceSpace?: ConstraintObjectSpace;
+    /**
+     * The destination node will be evaluated in this space.
+     */
+    destinationSpace?: ConstraintObjectSpace;
+    /**
+     * Axes be constrained by this constraint, in X-Y-Z order.
+     */
+    freezeAxes?: [boolean, boolean, boolean];
+    /**
+     * The weight of the constraint.
+     */
+    weight?: number;
+}

package/types/RotationConstraint.d.ts

@@ -0,0 +1,26 @@
+import type { ConstraintObjectSpace } from './ConstraintObjectSpace';
+/**
+ * A constraint that links the rotation with sources.
+ */
+export interface RotationConstraint {
+    /**
+     * The index of the node constrains the node.
+     */
+    source: number;
+    /**
+     * The source node will be evaluated in this space.
+     */
+    sourceSpace?: ConstraintObjectSpace;
+    /**
+     * The destination node will be evaluated in this space.
+     */
+    destinationSpace?: ConstraintObjectSpace;
+    /**
+     * Axes be constrained by this constraint, in X-Y-Z order.
+     */
+    freezeAxes?: [boolean, boolean, boolean];
+    /**
+     * The weight of the constraint.
+     */
+    weight?: number;
+}

package/types/VRMCNodeConstraint.d.ts

@@ -0,0 +1,19 @@
+import type { AimConstraint } from './AimConstraint';
+import type { PositionConstraint } from './PositionConstraint';
+import type { RotationConstraint } from './RotationConstraint';
+/**
+ * glTF extension that defines a node constraint.
+ */
+export interface VRMCNodeConstraint {
+    /**
+     * Specification version of VRMC_node_constraint
+     */
+    specVersion: '1.0-draft';
+    position?: PositionConstraint;
+    rotation?: RotationConstraint;
+    aim?: AimConstraint;
+    extensions?: {
+        [name: string]: any;
+    };
+    extras?: any;
+}

package/types/index.d.ts

@@ -0,0 +1,5 @@
+export type { AimConstraint } from './AimConstraint';
+export type { ConstraintObjectSpace } from './ConstraintObjectSpace';
+export type { PositionConstraint } from './PositionConstraint';
+export type { RotationConstraint } from './RotationConstraint';
+export type { VRMCNodeConstraint } from './VRMCNodeConstraint';