feat: Add type definition of the draft VRMC_springBone_limit extension

See: vrm-c/vrm-specification#496

Author: 0b5vr

packages/types-vrmc-springbone-limit-1.0/.gitignore

@@ -0,0 +1 @@
+!types

packages/types-vrmc-springbone-limit-1.0/README.md

@@ -0,0 +1,13 @@
+# @pixiv/types-vrmc-springbone-limit-1.0
+
+Type definitions of VRMC_springBone_limit 1.0 schema.
+
+https://github.com/vrm-c/vrm-specification/tree/master/specification/VRMC_springBone_limit-1.0
+
+There should not be any implementation in this package. Just type definitions of the schema.
+
+The extension root is named `VRMCSpringBoneLimit` .
+
+[GitHub Repository](https://github.com/pixiv/three-vrm/tree/dev/packages/types-vrmc-springbone-limit-1.0)
+
+[API Reference](https://pixiv.github.io/three-vrm/docs/modules/types-vrmc-springbone-limit-1.0)

packages/types-vrmc-springbone-limit-1.0/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@pixiv/types-vrmc-springbone-limit-1.0",
+  "version": "3.4.0",
+  "description": "Type definitions of VRMC_springBone_limit 1.0 schema",
+  "license": "MIT",
+  "author": "pixiv",
+  "files": [
+    "/types/",
+    "LICENSE"
+  ],
+  "main": "",
+  "types": "types/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pixiv/three-vrm.git",
+    "directory": "packages/types-vrmc-springbone-limit-1.0"
+  },
+  "scripts": {
+    "version": "yarn clean",
+    "clean": "rimraf docs/",
+    "lint": "eslint \"types/**/*.{ts,tsx}\" && prettier \"types/**/*.{ts,tsx}\" --check",
+    "lint-fix": "eslint \"types/**/*.{ts,tsx}\" --fix && prettier \"types/**/*.{ts,tsx}\" --write"
+  },
+  "lint-staged": {
+    "./types/**/*.{ts,tsx}": [
+      "eslint --fix",
+      "prettier --write"
+    ]
+  }
+}

packages/types-vrmc-springbone-limit-1.0/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": [
+    "./types"
+  ]
+}

packages/types-vrmc-springbone-limit-1.0/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "name": "types-vrmc-springbone-limit-1.0",
+  "entryPoints": ["types/index.d.ts"]
+}

packages/types-vrmc-springbone-limit-1.0/types/SpringBoneLimitLimit.d.ts

@@ -0,0 +1,26 @@
+import type { SpringBoneLimitLimitCone } from './SpringBoneLimitLimitCone';
+import type { SpringBoneLimitLimitHinge } from './SpringBoneLimitLimitHinge';
+import type { SpringBoneLimitLimitSpherical } from './SpringBoneLimitLimitSpherical';
+
+/**
+ * Describes a limit apply to the spring. Either cone, hinge, or spherical must be present.
+ */
+export interface SpringBoneLimitLimit {
+  /**
+   * A limit that restricts the orientation of the spring in a cone shape.
+   */
+  cone?: SpringBoneLimitLimitCone;
+
+  /**
+   * A limit that restricts the orientation of the spring in a hinge shape.
+   */
+  hinge?: SpringBoneLimitLimitHinge;
+
+  /**
+   * A limit that restricts the orientation of the spring in a spherical coordinate shape.
+   */
+  spherical?: SpringBoneLimitLimitSpherical;
+
+  extensions?: { [name: string]: any };
+  extras?: any;
+}

packages/types-vrmc-springbone-limit-1.0/types/SpringBoneLimitLimitCone.d.ts

@@ -0,0 +1,17 @@
+/**
+ * A limit that restricts the orientation of the spring in a cone shape.
+ */
+export interface SpringBoneLimitLimitCone {
+  /**
+   * The angle of the cone limit in radians. If the angle is set to π or greater, the angle will be interpreted as π by the implementation. When the angle is set to π, the cone shape becomes a sphere.
+   */
+  angle: number;
+
+  /**
+   * The rotation from the default orientation of the cone limit. The rotation is represented as a quaternion (x, y, z, w), where w is the scalar.
+   */
+  rotation?: [number, number, number, number];
+
+  extensions?: { [name: string]: any };
+  extras?: any;
+}

packages/types-vrmc-springbone-limit-1.0/types/SpringBoneLimitLimitHinge.d.ts

@@ -0,0 +1,17 @@
+/**
+ * A limit that restricts the orientation of the spring in a hinge shape.
+ */
+export interface SpringBoneLimitLimitHinge {
+  /**
+   * The angle of the hinge limit in radians. If the angle is set to π or greater, the angle will be interpreted as π by the implementation. When the angle is set to 180, the hinge shape becomes a full disc.
+   */
+  angle: number;
+
+  /**
+   * The rotation from the default orientation of the hinge limit. The rotation is represented as a quaternion (x, y, z, w), where w is the scalar.
+   */
+  rotation?: [number, number, number, number];
+
+  extensions?: { [name: string]: any };
+  extras?: any;
+}

packages/types-vrmc-springbone-limit-1.0/types/SpringBoneLimitLimitSpherical.d.ts

@@ -0,0 +1,22 @@
+/**
+ * A limit that restricts the orientation of the spring in a spherical coordinate shape.
+ */
+export interface SpringBoneLimitLimitSpherical {
+  /**
+   * The theta angle of the spherical limit in radians. If the theta angle is set to π or greater, the angle will be interpreted as π by the implementation.
+   */
+  theta: number;
+
+  /**
+   * The phi angle of the spherical limit in radians. If the phi angle is set to π/2 or greater, the angle will be interpreted as π/2 by the implementation.
+   */
+  phi: number;
+
+  /**
+   * The rotation from the default orientation of the spherical limit. The rotation is represented as a quaternion (x, y, z, w), where w is the scalar.
+   */
+  rotation?: [number, number, number, number];
+
+  extensions?: { [name: string]: any };
+  extras?: any;
+}

packages/types-vrmc-springbone-limit-1.0/types/VRMCSpringBoneLimit.d.ts

@@ -0,0 +1,19 @@
+import type { SpringBoneLimitLimit } from './SpringBoneLimitLimit';
+
+/**
+ * An angle limit for VRMC_springBone.
+ */
+export interface VRMCSpringBoneLimit {
+  /**
+   * Specification version of VRMC_springBone_limit.
+   */
+  specVersion: '1.0-draft';
+
+  /**
+   * Describes a limit apply to the spring.
+   */
+  limit: SpringBoneLimitLimit;
+
+  extensions?: { [name: string]: any };
+  extras?: any;
+}