Class LinesBuilder
Hierarchy
- LinesBuilder
Index
Methods
Static Create Dashed LinesSearch playground for CreateDashedLines
-
Creates a dashed line mesh
- A dashed line mesh is considered as a parametric shape since it has no predefined original shape. Its shape is determined by the passed array of points as an input parameter
- Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
- The parameter
points
is an array successive Vector3 - The parameter
dashNb
is the intended total number of dashes (positive integer, default 200) - The parameter
dashSize
is the size of the dashes relatively the dash number (positive float, default 3) - The parameter
gapSize
is the size of the gap between two successive dashes relatively the dash number (positive float, default 1) - The optional parameter
instance
is an instance of an existing LineMesh object to be updated with the passedpoints
parameter : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#lines-and-dashedlines - The optional parameter
useVertexAlpha
is to be set tofalse
(defaulttrue
) when you don't need the alpha blending (faster) - When updating an instance, remember that only point positions can change, not the number of points
- The mesh can be set to updatable with the boolean parameter
updatable
(default false) if its internal geometry is supposed to change once created
Parameters
-
name: string
defines the name of the mesh
-
options: { dashNb?: number; dashSize?: number; gapSize?: number; instance?: LinesMesh; points: Vector3[]; updatable?: boolean; useVertexAlpha?: boolean }
defines the options used to create the mesh
-
Optional scene: Nullable<Scene>
defines the hosting scene
Returns LinesMesh
the dashed line mesh
Static Create Line SystemSearch playground for CreateLineSystem
-
Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
- A line system mesh is considered as a parametric shape since it has no predefined original shape. Its shape is determined by the passed array of lines as an input parameter
- Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
- The parameter
lines
is an array of lines, each line being an array of successive Vector3 - The optional parameter
instance
is an instance of an existing LineSystem object to be updated with the passedlines
parameter - The optional parameter
colors
is an array of line colors, each line colors being an array of successive Color4, one per line point - The optional parameter
useVertexAlpha
is to be set tofalse
(defaulttrue
) when you don't need the alpha blending (faster) - Updating a simple Line mesh, you just need to update every line in the
lines
array : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#lines-and-dashedlines - When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
- The mesh can be set to updatable with the boolean parameter
updatable
(default false) if its internal geometry is supposed to change once created
Parameters
-
name: string
defines the name of the new line system
-
options: { colors?: Nullable<Color4[][]>; instance?: Nullable<LinesMesh>; lines: Vector3[][]; updatable?: boolean; useVertexAlpha?: boolean }
defines the options used to create the line system
-
scene: Nullable<Scene>
defines the hosting scene
Returns LinesMesh
a new line system mesh
Static Create LinesSearch playground for CreateLines
-
Creates a line mesh A line mesh is considered as a parametric shape since it has no predefined original shape. Its shape is determined by the passed array of points as an input parameter
- Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
- The parameter
points
is an array successive Vector3 - The optional parameter
instance
is an instance of an existing LineMesh object to be updated with the passedpoints
parameter : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#lines-and-dashedlines - The optional parameter
colors
is an array of successive Color4, one per line point - The optional parameter
useVertexAlpha
is to be set tofalse
(defaulttrue
) when you don't need alpha blending (faster) - When updating an instance, remember that only point positions can change, not the number of points
- The mesh can be set to updatable with the boolean parameter
updatable
(default false) if its internal geometry is supposed to change once created
Parameters
-
name: string
defines the name of the new line system
-
options: { colors?: Color4[]; instance?: Nullable<LinesMesh>; points: Vector3[]; updatable?: boolean; useVertexAlpha?: boolean }
defines the options used to create the line system
-
Optional scene: Nullable<Scene>
defines the hosting scene
Returns LinesMesh
a new line mesh
Class containing static functions to help procedurally build meshes