use-cannon

• Fix useRaycastVehicle, getUUID was receiving unintended index values (@bjornstar)
• [README.md] Update demos to point to cannon.pmnd.rs (@bjornstar)

• Update default gravity value from -10 to -9.81 (@alexandernanberg)
• [devDependencies] Update to latest versions (@bjornstar)
• [CHANGELOG.md] Start writing a changelog (@bjornstar)
• [README.md] Replace boxBufferGeometry with boxGeometry and planeBufferGeometry with planeGeometry (@drcmda)
• [examples/devDependencies] Update to latest version (@bjornstar)

• Rebuild package (@stockHuman)

• Fix an bug where multiple rotations shared an array (@bjornstar)

⚠️ There is a breaking change to the useSphere API ⚠️

Previously, the args property for useSphere was a single number, but this has caused a lot of confusion as many people expected it to be an array. We have standardized the format of the args property to be an array for all hooks.

Before v4:

useSphere((index) => ({ args: 10, mass: 10, position: [0, 0.5, 0] }))

From v4 onwards:

useSphere((index) => ({ args: [10], mass: 10, position: [0, 0.5, 0] }))

If you are calling useSphere you'll need to modify your code to use an array instead of a number. If you update to v4 and don't change, you will receive runtime errors saying: 'useSphere args must be an array`.

We have also included a bug fix for the rotation subscription API and added a quaternion API for direct access to the quaternions that Cannon is using behind the scenes.

What's Changed

• Add quaternion API, convert from quaternion to rotation correctly by @bjornstar in https://github.com/pmndrs/use-cannon/pull/289
• useSphere args must be an array by @bjornstar in https://github.com/pmndrs/use-cannon/pull/291
• [Typescript] Add types for world messages (like setGravity) by @bjornstar in https://github.com/pmndrs/use-cannon/pull/282
• Prefer CannonEvent over global Event type name by @bjornstar in https://github.com/pmndrs/use-cannon/pull/283
• [TypeScript] Improve set and subscribe API by @bjornstar in https://github.com/pmndrs/use-cannon/pull/285

Full Changelog: https://github.com/pmndrs/use-cannon/compare/v3.1.2...v4.0.0

• [Examples] Convert Kinematic Cube to TypeScript (#262) (@bjornstar)
• [Examples] Convert Heightmap to TypeScript (#264) (@bjornstar)
• [Examples] Convert SphereDebug to TypeScript (#261) (@bjornstar)
• [Examples] Convert Hinge Motor to TypeScript (#263) (@bjornstar)
• [Examples] Convert Cube Heap to TypeScript (#265) (@bjornstar)
• [Examples] Convert Convex Polyhedron to TypeScript (#266) (@bjornstar)
• [Examples] Convert Compound Body to TypeScript (#268) (@bjornstar)
• [Examples] Convert Constraints to TypeScript (#267) (@bjornstar)
• [Examples] Convert Raycast Vehicle to TypeScript (#270) (@bjornstar)
• [Examples] Convert Chain to TypeScript (#269) (@bjornstar)
• [Examples] Convert Raycast to TypeScript (#271) (@bjornstar)
• [Examples] Convert Ping Pong to TypeScript (@bjornstar)
• [readme.md] Switch build badge from travis to github (@bjornstar)
• Use Ref to allow for forwarded refs (@bjornstar)
• Use React.DependencyList instead of any[] for deps (@bjornstar)
• [CI] Test on node v14 as vercel doesn't support 16 yet (@bjornstar)

• Switch from CRA to vite (@bjornstar)
• feat: add applyTorque API to body (@a-type)

• Add shouldInvalidate to readme code (@aunyks)
• [Examples] CubeHeap, click to change to spheres (@bjornstar)
• Expose WakeUp & Sleep API (stockHuman)

• Remove dead code (@Gusted)
• Setup automated hygiene (@bjornstar)
• Add prepare script (@bjornstar)
• Run CI on the master branch (@bjornstar)
• Don't build examples (@bjornstar)
• Add 'shouldInvalidate' prop to Physics provider component to allow for pausing the simulation (@aunyks)
• Update bug_report.md (@stockHuman)
• Integrate pausing functionality (@stockHuman)
• Set printWidth to 110 (@bjornstar)

This and past point releases include bug fixes, and notably a change to physics objects now setting the target mesh's rotation rather than its quaternion. See #209

The unsung hero of many recent fixes: @drcmda. Thank you.

This release contains improvements to types and documentation, notably using Triplet instead of number[] (#206)
Thanks, @bjornstar!

Fixes undefined world in event listeners added for granular collision events.

Use-cannon 2.x is compatible with (and the cause of) react-three-fiber v7.

The integrated debugger has been improved and made optional and modular, integrate it into your scene and pass parameters as follows, where scale visually scales the physics mesh representation to better see it against your geometry.

<Physics>
  <Debug scale={1.1} color='black'>
    {/* children */}
  </Debug>
</Physics>

This release also includes more granular, detailed collision events! (#133)
See collideBegin and collideEnd events.
Thanks, @a-type

This release contains the ability to display a built-in visualization of the physics colliders in your scene, using cannon-es-debugger! (#190)

Pass the debug prop to your Physics component to view.

Thanks, @elisherer!

This release contains the perhaps long-awaited ability to dynamically alter the world's physics, including setting gravity! Thanks, @hazem3500. See the ConvexPolyhedron demo.

• make Physics provider props dynamic! (#202)
• Removes use of Nullish coalescing operator to improve compatibility with the default Create-React-App setup (#198)

Fix subscriptions on component disposal (#195)

This release adds triggers, allowing for easy-to-use implementations of common game mechanics within the physics world. (#193)

useBox(() => ({ isTrigger: true, ... })

Thanks, @age2pierre!

useConstraint now returns an API as follows: (#180)

type SpringApi = [
  React.MutableRefObject<THREE.Object3D | undefined>,
  React.MutableRefObject<THREE.Object3D | undefined>,
  {
    setStiffness: (value: number) => void
    setRestLength: (value: number) => void
    setDamping: (value: number) => void
  }
]

Allowing more complex and expressive physics constraints. Thanks @brunnolou!

This release brings use-cannon in line with r3f v6, updating demos to match.

• Disabled source maps in production build (#167)