npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@depasquale/three-wizard

v0.0.14

Published

Create a Three.js scene without the boilerplate

Downloads

189

Readme

Three.js Wizard

This tool does all the magical incantations necessary for creating a scene with Three.js:

  • Create camera, renderer, and scene instances
  • Size the renderer's DOM element to fill the browser window, with the appropriate pixel ratio
  • Add the renderer's DOM element to the DOM
  • Apply CSS to the page
  • Add an event listener to resize the renderer's DOM element and update the camera when the browser window is resized
  • Add your choice of controls
  • Set up the animation loop with your render routine
  • Update the controls each frame

Installation

npm install @depasquale/three-wizard

Usage

import Wizard from '@depasquale/three-wizard';

const wizard = new Wizard({
  // Choose from `ImmersiveControls`, `OrbitControls`, and `static` (more options coming soon)
  controls: 'OrbitControls',
});

// You can access these if necessary
const { scene, camera, renderer, controls } = wizard;

// Add things to the scene
// ...

Define the render loop in which things are updated each frame. (Three.js Wizard takes care of updating the controls and telling the renderer to render, so there's no need to include this boilerplate code.) Then start the animation.

const render = () => {
  // Update things in the scene
  // ...
};

wizard.start(render);

Options

  • controls: 'ImmersiveControls' | 'OrbitControls' | 'static'

    • The type of controls to be used in the scene. Default is static.
  • initialPosition: THREE.Vector3

    • The camera's initial position in the scene. Default is new THREE.Vector3(0, 1.6, 5).
  • css: true | false

    • Apply CSS to the page. Default is true.
  • If using ImmersiveControls, the options for these controls can be included here as well.

Example

A full example is provided in the example directory. To try it locally in your browser, run:

npm run example

Or try it here.

To do

  • Add more controls options
  • Add option to specify a target for the renderer's DOM element, instead of the full browser window