vue-use-three v2.0.7

vue-use-three

A set of composition functions and utilities to integrate Vue.js with Three.js.

Warning: This project is very experimental, things may change at any time.

Project outline

The primary goal of this library is to ease the pain in creating apps with Vue.js and Three.js. Several frameworks have demonstrated that component frameworks are great for organizing 3D scene graphs, but have a couple of drawbacks.

1. Components are often too high-level. This is fine for common things like scenes, lighting, and cameras, but becomes a pain when building custom components. With composition functions, we hope to solve this by providing behaviors that can be spread into components as needed, rather than proving the entire component itself.
2. It's too easy to make mistakes. A good example of this is disposing of 3D objects. With composition functions, these mental burdens can be abstracted away and managed within component lifecycles.

Behaviors

Note: These composition functions don't exist yet. These are currently in a brainstorming phase.

• useDisposable — Bind a disposable object to a component's lifecycle
• usePosition — Sync an object's local position with a vector
• useRotation — Sync an object's local rotation using Euler angles
• Etc...

useDisposable

This function binds disposable objects to the lifecycle of a component. When the component is destroyed, the object will be disposed of.

import { useDisposable } from `vue-use-three`;

export default {
  setup() {
    const geometry = useDisposable(new Geometry());
  }
}

usePosition

Sync an object's local position with a vector

import { usePosition } from 'vue-use-three';

export default {
  setup() {
    // ...
  }
};

useRotation

Sync an object's local rotation using Euler angles

import { useRotation } from 'vue-use-three';

export default {
  setup() {
    // ...
  }
};

Components

These components will cover common use cases for working with Three.js, and will primarily be built with the above composition functions.

• <Group>
• <PerspectiveCamera>
• <Renderer>
• <Scene>

<Group>

A component to group child objects.

<Group>
  <!-- ... -->
</Group>

<PerspectiveCamera>

Create a PerspectiveCamera to render a scene with.

<Scene>
  <PerspectiveCamera />
</Scene>

<Renderer>

This component will be responsible for managing the WebGLRenderer context. It will also be responsible for managing child Scene components and all rendering. The renderer will also be responsible for the actual <canvas> DOM element.

<Renderer>
  <!-- ... -->
</Renderer>

<Scene>

Scenes will mark a line in the sand between the DOM and our canvas. They will be "abstract" components, and will not render any child DOM elements. We'll use the bounding box of an outer <div> element to determine where to render out content. If the <div> is not within the viewport, the scene will not be rendered. This will allow for many scenes to exist within a single renderer.

<Renderer>
  <Scene>
    <!-- ... -->
  </Scene>
</Renderer>

License

MIT

Copyright (c) 2020-present, Scott Bedard