Import
LineMaterial is an addon, and must be imported explicitly, see Installation#Addons.
import { LineMaterial } from 'three/addons/lines/LineMaterial.js';Constructor
new LineMaterial( parameters : Object )
Constructs a new line segments geometry.
| parameters |
An object with one or more properties defining the material's appearance. Any property of the material (including any property from inherited materials) can be passed in here. Color values can be passed any type of value accepted by Color#set. |
Properties
.alphaToCoverage : boolean
Whether to use alphaToCoverage or not. When enabled, this can improve the anti-aliasing of line edges when using MSAA.
- Overrides: ShaderMaterial#alphaToCoverage
.dashOffset : number
Where in the dash cycle the dash starts.
Default is 0.
.dashScale : number
The scale of the dashes and gaps.
Default is 1.
.dashSize : number
The size of the dash.
Default is 1.
.dashed : boolean
Whether the line is dashed, or solid.
Default is false.
.gapSize : number
The size of the gap.
Default is 0.
.isLineMaterial : boolean (readonly)
This flag can be used for type testing.
Default is true.
.linewidth : number
Controls line thickness in CSS pixel units when worldUnits is false (default),
or in world units when worldUnits is true.
Default is 1.
- Overrides: ShaderMaterial#linewidth
.resolution : Vector2
The size of the viewport, in screen pixels. This must be kept updated to make
screen-space rendering accurate.The LineSegments2.onBeforeRender callback
performs the update for visible objects.
.worldUnits : boolean
Whether the material's sizes (width, dash gaps) are in world units.
Default is false.