MeshLine

Mesh replacement for THREE.Line

Fork of THREE.meshline as the repo no longer appears to be maintained.

Changes:

Includes PR from axon014 to correct line widths (should now work with orthographic camera)
BufferGeometry now supported
New setVertices and setBufferArray functions so you no longer need to create a geometry prior to a MeshLine
MeshLine now extends THREE.BufferGeometry and can be used in a mesh as a geometry
Raycast now exposed as MeshLineRaycast and can be used like mesh.raycast = MeshLineRaycast
Raycast updated to account for line width!
Extra setters and getters to help with declaritive libraries like react-three-fiber
Old api should still work as expected

NOTE: I'm still very new to three.js, esepcially glsl and shaders.

If you like to help maintain this library, please let me know!

Instead of using GL_LINE, it uses a strip of triangles billboarded. Some examples:

Demo: play with the different settings of materials
Graph: example of using MeshLine to plot graphs
Spinner: example of dynamic MeshLine with texture
SVG: example of MeshLine rendering SVG Paths
Shape: example of MeshLine created from a mesh
Birds: example of MeshLine.advance() by @caramelcode (Jared Sprague) and @mwcz (Michael Clayton)

How to use

Include script
Create and populate a geometry
Create a MeshLine and assign the geometry
Create a MeshLineMaterial
Use MeshLine and MeshLineMaterial to create a THREE.Mesh

Include the script

Include script after THREE is included

<script src="THREE.MeshLine.js"></script>

or use npm to install it

npm i threejs-meshline

and include it in your code (don't forget to require three.js)

var THREE = require( 'three' );
var MeshLine = require( 'threejs-meshline' );

import * as THREE from "three";
import { MeshLine, MeshLineMaterial } from 'threejs-meshline'

Create and populate a geometry

First, create the list of vertices that will define the line. MeshLine accepts THREE.Geometry (looking up the .vertices in it) and Array/Float32Array. THREE.BufferGeometry coming soon, and may be others like Array of THREE.Vector3.

var vertices = [];
for( var j = 0; j < Math.PI; j += 2 * Math.PI / 100 ) {
	var v = new THREE.Vector3( Math.cos( j ), Math.sin( j ), 0 );
	vertices.push( v );
}

Create a MeshLine and assign the geometry

Once you have that, you can create a new MeshLine, and call .setVertices() passing the vertices.

var line = new MeshLine();
line.setVertices( vertices );

Note: .setVertices accepts a second parameter, which is a function to define the width in each point along the line. By default that value is 1, making the line width 1 * lineWidth.

line.setGeometry( geometry, function( p ) { return 2; } ); // makes width 2 * lineWidth
line.setGeometry( geometry, function( p ) { return 1 - p; } ); // makes width taper
line.setGeometry( geometry, function( p ) { return 2 + Math.sin( 50 * p ); } ); // makes width sinusoidal

Create a MeshLineMaterial

A MeshLine needs a MeshLineMaterial:

var material = new MeshLineMaterial(OPTIONS);

By default it's a white material of width 1 unit.

MeshLineMaterial has several attributes to control the appereance of the MeshLine:

map - a THREE.Texture to paint along the line (requires useMap set to true)
useMap - tells the material to use map (0 - solid color, 1 use texture)
alphaMap - a THREE.Texture to use as alpha along the line (requires useAlphaMap set to true)
useAlphaMap - tells the material to use alphaMap (0 - no alpha, 1 modulate alpha)
repeat - THREE.Vector2 to define the texture tiling (applies to map and alphaMap - MIGHT CHANGE IN THE FUTURE)
color - THREE.Color to paint the line width, or tint the texture with
opacity - alpha value from 0 to 1 (requires transparent set to true)
alphaTest - cutoff value from 0 to 1
dashArray - the length and space between dashes. (0 - no dash)
dashOffset - defines the location where the dash will begin. Ideal to animate the line.
dashRatio - defines the ratio between that is visible or not (0 - more visible, 1 - more invisible).
resolution - THREE.Vector2 specifying the canvas size (REQUIRED)
sizeAttenuation - makes the line width constant regardless distance (1 unit is 1px on screen) (0 - attenuate, 1 - don't attenuate)
lineWidth - float defining width (if sizeAttenuation is true, it's world units; else is screen pixels)
near - camera near clip plane distance (REQUIRED if sizeAttenuation set to false)
far - camera far clip plane distance (REQUIRED if sizeAttenuation set to false)

If you're rendering transparent lines or using a texture with alpha map, you should set depthTest to false, transparent to true and blending to an appropriate blending mode, or use alphaTest.

Use MeshLine and MeshLineMaterial to create a THREE.Mesh

Finally, we create a mesh and add it to the scene:

var mesh = new THREE.Mesh( line, material ); // this syntax could definitely be improved!
scene.add( mesh );

TODO

Better miters

Support

Tested successfully on

Chrome OSX, Windows, Android
Firefox OSX, Windows, Anroid
Safari OSX, iOS
Internet Explorer 11 (SVG and Shape demo won't work because they use Promises)
Opera OSX, Windows

References

License

MIT licensed

w12594822/threejs-meshline