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

cannon-es-debugger

v1.0.0

Published

Wireframe debugger for use with cannon-es https://github.com/pmndrs/cannon-es

Downloads

40,929

Readme

cannon-es-debugger

Demo Image

This is a debugger for use with cannon-es. It was adapted from the original cannon.js debugger written by Stefan Hedman @schteppe.

Note: This debugger is included in use-cannon directly.

Installation

yarn add cannon-es-debugger

Make sure you also have three and cannon-es as dependencies.

yarn add three cannon-es

Usage

Give cannon-es-debugger references to your three.js scene object and cannon-es world:

import { Scene } from 'three'
import { World } from 'cannon-es'
import CannonDebugger from 'cannon-es-debugger'

const scene = new Scene()
const world = new World()
const cannonDebugger = new CannonDebugger(scene, world, {
  // options...
})

// ...

function animate() {
  requestAnimationFrame(animate)

  world.step(timeStep) // Update cannon-es physics
  cannonDebugger.update() // Update the CannonDebugger meshes
  renderer.render(scene, camera) // Render the three.js scene
}
animate()

New meshes with wireframe material will be generated from your physics body shapes and added into the scene. The position of the meshes will be synched with the Cannon physics body simulation on every animation frame.

API

import type { Scene, Color } from 'three'
import type { Body } from 'cannon-es'

type DebugOptions = {
  color?: string | number | Color
  scale?: number
  onInit?: (body: Body, mesh: Mesh, shape: Shape) => void
  onUpdate?: (body: Body, mesh: Mesh, shape: Shape) => void
}

export default class CannonDebugger {
  constructor(scene: Scene, world: World, options: DebugOptions): void

  update(): void
}

The available properties of the options object are:

  • color - a Three Color argument that sets the wireframe color, defaults to 0x00ff00

  • scale - scale factor for all the wireframe meshes, defaults to 1

  • onInit - callback function that runs once, right after a new wireframe mesh is added

  • onUpdate - callback function that runs on every subsequent animation frame

The update() method needs to be called in a requestAnimationFrame loop to keep updating the wireframe meshes after the bodies have been updated.