@splinetool/loader 0.9.19

package/README.md

@@ -0,0 +1,39 @@
+# Spline Loader
+
+> Three.js loader for `.spline` files.
+
+It returns a three.js compatible rapresentation of the file scene.
+
+You should use this package if you want to access your Spline objects and materials from code and manipulate them yourself.
+
+If you want to display your Spline scene with interactions and states matching Spline play mode, we recommend you use [spline-runtime](https://www.npmjs.com/package/@splinetool/runtime) instead.
+
+## Installation
+
+```
+npm install @splinetool/loader
+```
+
+## Usage
+
+```js
+import SplineLoader from '@splinetool/loader';
+
+// Instantiate a loader
+const loader = new SplineLoader();
+
+// Load a .spline file
+loader.load(
+	// path to the .spline file, either from the Spline servers or local
+	'https://prod.spline.design/TRfTj83xgjIdHPmT/scene.spline',
+	// called when the resource is loaded
+	(splineScene) => {
+		scene.add(splineScene);
+	},
+	null,
+	// called when loading has errors
+	(error) => {
+		console.log('An error happened');
+	}
+);
+```

package/build/SplineLoader.d.ts

@@ -0,0 +1,7 @@
+declare module "SplineLoader" {
+    import { Loader, Scene } from 'three';
+    export default class SplineLoader extends Loader {
+        load(url: string, onLoad: (scene: Scene) => void, onProgress?: (event: ProgressEvent) => void, onError?: (event: ErrorEvent) => void): void;
+        parse(buffer: ArrayBuffer): Scene;
+    }
+}