Skip to main content

Object3D →

Line

A continuous line.

This is nearly the same as LineSegments; the only difference is that it is rendered using gl.LINE_STRIP instead of gl.LINES

Code Example​

const material = new THREE.LineBasicMaterial({ color: 0x0000ff }); const
points = []; points.push( new THREE.Vector3( - 10, 0, 0 ) ); points.push( new
THREE.Vector3( 0, 10, 0 ) ); points.push( new THREE.Vector3( 10, 0, 0 ) );
const geometry = new THREE.BufferGeometry().setFromPoints( points ); const
line = new THREE.Line( geometry, material ); scene.add( line );

Constructor​

Line​

function Line( geometry: BufferGeometry, material: Material ): void;

geometry — vertices representing the line segment(s). Default is a new BufferGeometry.
material — material for the line. Default is a new LineBasicMaterial.

Properties​

See the base Object3D class for common properties.

geometry​

geometry: BufferGeometry;

Vertices representing the line segment(s).

isLine​

isLine: Boolean;

Read-only flag to check if a given object is of type Line.

material​

material: Material;

Material for the line.

morphTargetInfluences​

morphTargetInfluences: Array;

An array of weights typically from 0-1 that specify how much of the morph is applied. Undefined by default, but reset to a blank array by .updateMorphTargets().

morphTargetDictionary​

morphTargetDictionary: Object;

A dictionary of morphTargets based on the morphTarget.name property. Undefined by default, but rebuilt .updateMorphTargets().

Methods​

See the base Object3D class for common methods.

computeLineDistances​

function computeLineDistances( ): this;

Computes an array of distance values which are necessary for LineDashedMaterial. For each vertex in the geometry, the method calculates the cumulative length from the current point to the very beginning of the line.

raycast​

function raycast( raycaster: Raycaster, intersects: Array ): undefined;

Get intersections between a casted Ray and this Line. Raycaster.intersectObject will call this method.

clone​

function clone( ): Line;

Returns a clone of this Line object and its descendants.

updateMorphTargets​

function updateMorphTargets( ): undefined;

Updates the morphTargets to have no influence on the object. Resets the .morphTargetInfluences and .morphTargetDictionary properties.

Source​

src/objects/Line.js