three.js/docs/pages/Flow.html.md

Flow

A modifier for making meshes bend around curves.

This module can only be used with WebGLRenderer. When using WebGPURenderer, import the class from CurveModifierGPU.js.

Import

Flow is an addon, and must be imported explicitly, see Installation#Addons.

import { Flow } from 'three/addons/modifiers/CurveModifier.js';

Constructor

new Flow( mesh : Mesh, numberOfCurves : number )

Constructs a new Flow instance.

mesh

The mesh to clone and modify to bend around the curve.

numberOfCurves

The amount of space that should preallocated for additional curves.

Default is 1.

Classes

Flow

Methods

.moveAlongCurve( amount : number )

Moves the mesh along the curve.

amount

The offset.

.updateCurve( index : number, curve : Curve )

Updates the curve for the given curve index.

index

The curve index.

curve

The curve that should be used to bend the mesh.

Source

examples/jsm/modifiers/CurveModifier.js