3d-scene-creator

WORK IN PROGRESS

:construction: This package may change heavily in upcoming releases :construction:

Features

• The SceneCreator class wraps Three.js and gsap to provide a simple API to load models, animate object, and setup the 3D scene.
• Optimized render function: only calls the render function when something is moving.

Usage

install

npm install 3d-scene-creator

Import & initialize SceneCreator

import { SceneCreator } from "3d-scene-creator";

// create a container div
const container = document.createElement('div');
container.style.height= '100vh';
container.style.width= '100%';
document.body.append('container')

// create scene and append canvas to the container element
const sceneCreator = new SceneCreator(container);

Load 3D models

await sceneCreator.loadModel("/examples/scene.json");
console.log("Scene loaded!");

Add camera controls

sceneCreator.addControls();

Add default lighting (2 directional lights and an ambient light)

sceneCreator.addLighting();

Animate camera

sceneCreator.moveCamera(new THREE.Vector3(10, 20, 20));

Animate 3D object position, color and opacity

const obj = await sceneCreator.loadModel("/examples/model.json");
obj.name = "Octa";
sceneCreator
  .animateModelColor("Octa", "red")
  .animateModelPosition("Octa", new THREE.Vector3(-1, 2, -2))
  .animateModelOpacity("Octa", 0.3, 10);

Add skybox from url (360° Images)

sceneCreator.addSkybox("my360image.jpg");