Troika Three.js Utilities

This package provides various utilities for working with Three.js, particularly having to do with shaders. It is used by Troika 3D, but has no dependencies itself other than Three.js, so it can be used outside the Troika framework.

Installation

Get it from NPM:

``sh
npm install troika-three-utils
`

You will also need to install a compatible version of Three.js; see the notes on Three.js versions in the Getting Started docs for details.

`sh
npm install three
`

Provided Utilities

Several utilities are provided; for a full list follow the imports in index.js to their source files, where each is documented in JSDoc comments.

Some of the most useful ones are:

$3

This utility allows you to easily _extend_ existing Three.js materials with your own custom shader code. This is an incredibly powerful tool, and is the secret behind most of Troika's shader-driven tools like troika-three-text, three-instanced-uniforms-mesh, and BezierMesh.

See the createDerivedMaterial documentation page and its source code with JSDoc for details.

$3

This creates a cylindrical mesh and bends it along a 3D cubic bezier path between two points, in a custom derived vertex shader. This is useful for visually connecting objects in 3D space with a line that has thickness to it.

See the BezierMesh documentation page and its source code with JSDoc for details.

$3

> NOTE: InstancedUniformsMesh has been moved to its own three-instanced-uniforms-mesh` package.