API

Type Alias GreasedLineRibbonOptions

type GreasedLineRibbonOptions = {
    closePath?: boolean;
    directions?: Vector3[] | Vector3;
    directionsAutoMode?: GreasedLineRibbonAutoDirectionMode;
    facesMode?: GreasedLineRibbonFacesMode;
    pointsMode?: GreasedLineRibbonPointsMode;
    smoothShading?: boolean;
    width?: number;
}
Index
closePath?: boolean

If true, the path will be closed.

directions?: Vector3[] | Vector3

Normalized directions of the slopes of the non camera facing lines.

Defines the calculation mode of the directions which the line will be thickened to.

Controls how the faces are created. GreasedLineRibbonFacesMode.FACES_MODE_SINGLE_SIDED = single sided with back face culling. Default value. GreasedLineRibbonFacesMode.FACES_MODE_SINGLE_SIDED_NO_BACKFACE_CULLING = single sided without back face culling GreasedLineRibbonFacesMode.FACES_MODE_DOUBLE_SIDED = extra back faces are created. This doubles the amount of faces of the mesh.

Defines how the points are processed. In GreasedLineRibbonPointsMode.POINTS_MODE_POINTS every array of points will become the center of the ribbon. The ribbon will be expanded by width/2 to +direction and -direction as well. In GreasedLineRibbonPointsMode.POINTS_MODE_PATHS every array of points is one path. These will be used to buuid one ribbon.

smoothShading?: boolean

If true, normals will be computed when creating the vertex buffers. This results to smooth shading of the mesh.

width?: number

Width of the ribbon.