Class GreasedLineTools

Tool functions for GreasedLine

Constructors

constructor

new GreasedLineTools(): GreasedLineTools

Returns GreasedLineTools

Methods

`Static`BooleanToNumber

BooleanToNumber(bool?: boolean): 0 | 1
Converts boolean to number.
Parameters
- Optionalbool: boolean
  the bool value
Returns 0 | 1
1 if true, 0 if false.
- Defined in packages/dev/core/src/Misc/greasedLineTools.ts:589

`Static`Color3toRGBAUint8

Color3toRGBAUint8(colors: Color3[]): Uint8Array
Converts an array of Color3 to Uint8Array
Parameters
- colors: Color3[]
  Arrray of Color3
Returns Uint8Array
Uin8Array of colors [r, g, b, a, r, g, b, a, ...]
- Defined in packages/dev/core/src/Misc/greasedLineTools.ts:522

`Static`ConvertPoints

ConvertPoints(
points: GreasedLinePoints,
options?: GreasedLinePointsOptions,
): number[][]
Converts GreasedLinePoints to number[][]
Parameters
- points: GreasedLinePoints
  GreasedLinePoints
- Optionaloptions: GreasedLinePointsOptions
  GreasedLineToolsConvertPointsOptions
Returns number[][]
number[][] with x, y, z coordinates of the points, like [[x, y, z, x, y, z, ...], [x, y, z, ...]]
- Defined in packages/dev/core/src/Misc/greasedLineTools.ts:24

`Static`CreateColorsTexture

CreateColorsTexture(
    name: string,
    colors: Color3[],
    colorsSampling: number,
    scene: Scene,
): RawTexture
Creates a RawTexture from an RGBA color array and sets it on the plugin material instance.
Parameters
- name: string
  name of the texture
- colors: Color3[]
  Uint8Array of colors
- colorsSampling: number
  sampling mode of the created texture
- scene: Scene
  Scene
Returns RawTexture
the colors texture
- Defined in packages/dev/core/src/Misc/greasedLineTools.ts:542

`Static`DisposeEmptyColorsTexture

DisposeEmptyColorsTexture(): void
Diposes the shared empty colors texture

Returns void
- Defined in packages/dev/core/src/Misc/greasedLineTools.ts:579

`Static`GetArrowCap

GetArrowCap(
    position: Vector3,
    direction: Vector3,
    length: number,
    widthUp: number,
    widthDown: number,
    widthStartUp?: number,
    widthStartDown?: number,
): { points: Vector3[]; widths: number[] }
Parameters
- position: Vector3
  position of the arrow cap (mainly you want to create a triangle, set widthUp and widthDown to the same value and omit widthStartUp and widthStartDown)
- direction: Vector3
  direction which the arrow points to
- length: number
  length (size) of the arrow cap itself
- widthUp: number
  the arrow width above the line
- widthDown: number
  the arrow width belove the line
- widthStartUp: number = 0
  the arrow width at the start of the arrow above the line. In most scenarios this is 0.
- widthStartDown: number = 0
  the arrow width at the start of the arrow below the line. In most scenarios this is 0.
Returns { points: Vector3[]; widths: number[] }
- Defined in packages/dev/core/src/Misc/greasedLineTools.ts:468

`Static`GetBezierLinePoints

GetBezierLinePoints(
    p0: Vector3,
    p1: Vector3,
    p2: Vector3,
    segments: number,
): number[]
Gets line points in a shape of a bezier curve
Parameters
- p0: Vector3
  bezier point0
- p1: Vector3
  bezier point1
- p2: Vector3
  bezier point2
- segments: number
  number of segments in the curve
Returns number[]
- Defined in packages/dev/core/src/Misc/greasedLineTools.ts:451

`Static`GetCircleLinePoints

GetCircleLinePoints(
    radiusX: number,
    segments: number,
    z?: number,
    radiusY?: number,
    segmentAngle?: number,
): Vector3[]
Creates lines in a shape of circle/arc. A segment is a part of the line between it's two points.
Parameters
- radiusX: number
  radiusX of the circle
- segments: number
  number of segments in the circle
- z: number = 0
  z coordinate of the points. Defaults to 0.
- radiusY: number = radiusX
  radiusY of the circle - you can draw an oval if using different values
- segmentAngle: number = ...
  angle offset of the segments. Defaults to Math.PI * 2 / segments. Change this value to draw a part of the circle.
Returns Vector3[]
line points
- Defined in packages/dev/core/src/Misc/greasedLineTools.ts:435

`Static`GetLineLength

GetLineLength(data: number[] | Vector3[]): number
Gets the length of the line counting all it's segments length
Parameters
- data: number[] | Vector3[]
  array of line points
Returns number
length of the line
- Defined in packages/dev/core/src/Misc/greasedLineTools.ts:247

`Static`GetLineLengthArray

GetLineLengthArray(data: number[], buf?: ArrayBuffer): Float32Array
Gets the length from the beginning to each point of the line as array.
Parameters
- data: number[]
  array of line points
- Optionalbuf: ArrayBuffer
  optional pre-allocated buffer to reduce memory pressure, should be at least data.length * 4 / 3 bytes
Returns Float32Array
length array of the line
- Defined in packages/dev/core/src/Misc/greasedLineTools.ts:275

`Static`GetLineSegments

GetLineSegments(
points: Vector3[],
): { length: number; point1: Vector3; point2: Vector3 }[]
Gets line segments. A segment is a part of the line between it's two points.
Parameters
- points: Vector3[]
  line points
Returns { length: number; point1: Vector3; point2: Vector3 }[]
segments information of the line segment including starting point, ending point and the distance between them
- Defined in packages/dev/core/src/Misc/greasedLineTools.ts:365

`Static`GetMinMaxSegmentLength

GetMinMaxSegmentLength(points: Vector3[]): { max: number; min: number }
Gets the minimum and the maximum length of a line segment in the line. A segment is a part of the line between it's two points.
Parameters
- points: Vector3[]
  line points
Returns { max: number; min: number }
- Defined in packages/dev/core/src/Misc/greasedLineTools.ts:383

`Static`GetPointsCountInfo

GetPointsCountInfo(points: number[][]): { counts: number[]; total: number }
Calculates the sum of points of every line and the number of points in each line. This function is useful when you are drawing multiple lines in one mesh and you want to know the counts. For example for creating an offsets table.
Parameters
- points: number[][]
  point array
Returns { counts: number[]; total: number }
points count info
- Defined in packages/dev/core/src/Misc/greasedLineTools.ts:232

`Static`GetPointsFromText

GetPointsFromText(
    text: string,
    size: number,
    resolution: number,
    fontData: IFontData,
    z?: number,
    includeInner?: boolean,
): number[][]
Gets 3D positions of points from a text and font
Parameters
- text: string
  Text
- size: number
  Size of the font
- resolution: number
  Resolution of the font
- fontData: IFontData
  defines the font data (can be generated with http://gero3.github.io/facetype.js/)
- z: number = 0
  z coordinate
- includeInner: boolean = true
  include the inner parts of the font in the result. Default true. If false, only the outlines will be returned.
Returns number[][]
number[][] of 3D positions
- Defined in packages/dev/core/src/Misc/greasedLineTools.ts:488

`Static`GetPositionOnLineByVisibility

GetPositionOnLineByVisibility(
    lineSegments: { length: number; point1: Vector3; point2: Vector3 }[],
    lineLength: number,
    visbility: number,
    localSpace?: boolean,
): Vector3
Finds the last visible position in world space of the line according to the visibility parameter
Parameters
- lineSegments: { length: number; point1: Vector3; point2: Vector3 }[]
  segments of the line
- lineLength: number
  total length of the line
- visbility: number
  normalized value of visibility
- localSpace: boolean = false
  if true the result will be in local space (default is false)
Returns Vector3
world space coordinate of the last visible piece of the line
- Defined in packages/dev/core/src/Misc/greasedLineTools.ts:400

`Static`MeshesToLines

MeshesToLines(
    meshes: AbstractMesh[],
    predicate?: (
        p1: Vector3,
        p2: Vector3,
        p3: Vector3,
        points: Vector3[][],
        indiceIndex: number,
        vertexIndex: number,
        mesh: AbstractMesh,
        meshIndex: number,
        vertices: FloatArray,
        indices: IndicesArray,
    ) => Vector3[][],
): Vector3[][]
Gets mesh triangles as line positions
Parameters
- meshes: AbstractMesh[]
  array of meshes
- Optionalpredicate: (
      p1: Vector3,
      p2: Vector3,
      p3: Vector3,
      points: Vector3[][],
      indiceIndex: number,
      vertexIndex: number,
      mesh: AbstractMesh,
      meshIndex: number,
      vertices: FloatArray,
      indices: IndicesArray,
  ) => Vector3[][]
  predicate function which decides whether to include the mesh triangle/face in the ouput
Returns Vector3[][]
array of arrays of points
- Defined in packages/dev/core/src/Misc/greasedLineTools.ts:140

`Static`OmitDuplicatesPredicate

OmitDuplicatesPredicate(
    p1: Vector3,
    p2: Vector3,
    p3: Vector3,
    points: Vector3[][],
): Vector3[][] | null
Omit duplicate lines predicate for the MeshesToLines function
Parameters
- p1: Vector3
  point1 position of the face
- p2: Vector3
  point2 position of the face
- p3: Vector3
  point3 position of the face
- points: Vector3[][]
  array of points to search in
Returns Vector3[][] | null
original points or null if any edge length is zero
- Defined in packages/dev/core/src/Misc/greasedLineTools.ts:102

`Static`OmitZeroLengthPredicate

OmitZeroLengthPredicate(
    p1: Vector3,
    p2: Vector3,
    p3: Vector3,
): Vector3[][] | null
Omit zero length lines predicate for the MeshesToLines function
Parameters
- p1: Vector3
  point1 position of the face
- p2: Vector3
  point2 position of the face
- p3: Vector3
  point3 position of the face
Returns Vector3[][] | null
original points or null if any edge length is zero
- Defined in packages/dev/core/src/Misc/greasedLineTools.ts:77

`Static`PrepareEmptyColorsTexture

PrepareEmptyColorsTexture(scene: Scene): RawTexture
A minimum size texture for the colors sampler2D when there is no colors texture defined yet. For fast switching using the useColors property without the need to use defines.
Parameters
- scene: Scene
  Scene
Returns RawTexture
empty colors texture
- Defined in packages/dev/core/src/Misc/greasedLineTools.ts:561

`Static`SegmentizeLineBySegmentCount

SegmentizeLineBySegmentCount(
what: number[] | Vector3[],
segmentCount: number,
): Vector3[]
Divides a line into segments. A segment is a part of the line between it's two points.
Parameters
- what: number[] | Vector3[]
  line points
- segmentCount: number
  number of segments
Returns Vector3[]
line point
- Defined in packages/dev/core/src/Misc/greasedLineTools.ts:354

`Static`SegmentizeLineBySegmentLength

SegmentizeLineBySegmentLength(
    what:
        | number[]
        | Vector3[]
        | { length: number; point1: Vector3; point2: Vector3 }[],
    segmentLength: number,
): Vector3[]
Divides a line into segments. A segment is a part of the line between it's two points.
Parameters
- what: number[] | Vector3[] | { length: number; point1: Vector3; point2: Vector3 }[]
  line points
- segmentLength: number
  length of each segment of the resulting line (distance between two line points)
Returns Vector3[]
line point
- Defined in packages/dev/core/src/Misc/greasedLineTools.ts:325

`Static`SegmentizeSegmentByCount

SegmentizeSegmentByCount(
    point1: Vector3,
    point2: Vector3,
    segmentCount: number,
): Vector3[]
Divides a segment into smaller segments. A segment is a part of the line between it's two points.
Parameters
- point1: Vector3
  first point of the line
- point2: Vector3
  second point of the line
- segmentCount: number
  number of segments we want to have in the divided line
Returns Vector3[]
- Defined in packages/dev/core/src/Misc/greasedLineTools.ts:300

`Static`ToNumberArray

ToNumberArray(points: Vector3[]): number[]
Gets a number array from a Vector3 array. You can you for example to convert your Vector3[] offsets to the required number[] for the offsets option.
Parameters
- points: Vector3[]
  Vector3 array
Returns number[]
an array of x, y, z coordinates as numbers [x, y, z, x, y, z, x, y, z, ....]
- Defined in packages/dev/core/src/Misc/greasedLineTools.ts:221

`Static`ToVector3Array

ToVector3Array(points: number[] | number[][]): Vector3[] | Vector3[][]
Converts number coordinates to Vector3s
Parameters
- points: number[] | number[][]
  number array of x, y, z, x, y z, ... coordinates
Returns Vector3[] | Vector3[][]
Vector3 array
- Defined in packages/dev/core/src/Misc/greasedLineTools.ts:193

Class GreasedLineTools

Index

Constructors

Methods

Constructors

constructor

Returns GreasedLineTools

Methods

StaticBooleanToNumber

Parameters

Returns 0 | 1

StaticColor3toRGBAUint8

Parameters

Returns Uint8Array

StaticConvertPoints

Parameters

Returns number[][]

StaticCreateColorsTexture

Parameters

Returns RawTexture

StaticDisposeEmptyColorsTexture

Returns void

StaticGetArrowCap

Parameters

Returns { points: Vector3[]; widths: number[] }

StaticGetBezierLinePoints

Parameters

Returns number[]

StaticGetCircleLinePoints

Parameters

Returns Vector3[]

StaticGetLineLength

Parameters

Returns number

StaticGetLineLengthArray

Parameters

Returns Float32Array

StaticGetLineSegments

Parameters

Returns { length: number; point1: Vector3; point2: Vector3 }[]

StaticGetMinMaxSegmentLength

Parameters

Returns { max: number; min: number }

StaticGetPointsCountInfo

Parameters

Returns { counts: number[]; total: number }

StaticGetPointsFromText

Parameters

Returns number[][]

StaticGetPositionOnLineByVisibility

Parameters

Returns Vector3

StaticMeshesToLines

Parameters

Returns Vector3[][]

StaticOmitDuplicatesPredicate

Parameters

Returns Vector3[][] | null

StaticOmitZeroLengthPredicate

Parameters

Returns Vector3[][] | null

StaticPrepareEmptyColorsTexture

Parameters

Returns RawTexture

StaticSegmentizeLineBySegmentCount

Parameters

Returns Vector3[]

StaticSegmentizeLineBySegmentLength

Parameters

Returns Vector3[]

StaticSegmentizeSegmentByCount

Parameters

Returns Vector3[]

StaticToNumberArray

Parameters

Returns number[]

StaticToVector3Array

Parameters

Returns Vector3[] | Vector3[][]

`Static`BooleanToNumber

`Static`Color3toRGBAUint8

`Static`ConvertPoints

`Static`CreateColorsTexture

`Static`DisposeEmptyColorsTexture

`Static`GetArrowCap

`Static`GetBezierLinePoints

`Static`GetCircleLinePoints

`Static`GetLineLength

`Static`GetLineLengthArray

`Static`GetLineSegments

`Static`GetMinMaxSegmentLength

`Static`GetPointsCountInfo

`Static`GetPointsFromText

`Static`GetPositionOnLineByVisibility

`Static`MeshesToLines

`Static`OmitDuplicatesPredicate

`Static`OmitZeroLengthPredicate

`Static`PrepareEmptyColorsTexture

`Static`SegmentizeLineBySegmentCount

`Static`SegmentizeLineBySegmentLength

`Static`SegmentizeSegmentByCount

`Static`ToNumberArray

`Static`ToVector3Array