Class Draw

Hierarchy

Draw
- DrawComplete

Index

Constructors

constructor

Methods

Constructors

constructor

new Draw(point: Point, line: Line, polyline: Polyline, node: BabylonNode, verbCurve: VerbCurve, verbSurface: VerbSurface, jscad: JSCAD, occt: OCCTW, tag: Tag, context: Context): Draw

- Defined in bitbybit-docs.d.ts:18949
Parameters
- point: Point
- line: Line
- polyline: Polyline
- node: BabylonNode
- verbCurve: VerbCurve
- verbSurface: VerbSurface
- jscad: JSCAD
- occt: OCCTW
- tag: Tag
- context: Context
Returns Draw

Methods

drawAny

drawAny(inputs: DrawAny): Mesh

- Defined in bitbybit-docs.d.ts:19023
Draws any kind of geometry that does not need asynchronous computing, thus it cant be used with shapes coming from occt or jscad

group

draw sync

shortname

draw sync

Parameters
- inputs: DrawAny
  
  Contains options and entities to be drawn
Returns Mesh

BabylonJS Mesh

drawAnyAsync

drawAnyAsync(inputs: DrawAny): Promise<Mesh>

- Defined in bitbybit-docs.d.ts:19006
Draws any kind of geometry and returns the babylon mesh

group

draw async

shortname

draw async

disposableoutput

true

Parameters
- inputs: DrawAny
  
  Contains options and entities to be drawn
Returns Promise<Mesh>

BabylonJS Mesh Promise

drawAnyAsyncNoReturn

drawAnyAsyncNoReturn(inputs: DrawAny): Promise<void>

- Defined in bitbybit-docs.d.ts:18997
Draws any kind of geometry and does not return anything

group

draw async

shortname

draw async void

disposableoutput

true

Parameters
- inputs: DrawAny
  
  Contains options and entities to be drawn
Returns Promise<void>

drawAnyNoReturn

drawAnyNoReturn(inputs: DrawAny): void

- Defined in bitbybit-docs.d.ts:19015
Draws any kind of geometry that does not need asynchronous computing, thus it cant be used with shapes coming from occt or jscad

group

draw sync

shortname

draw sync void

Parameters
- inputs: DrawAny
  
  Contains options and entities to be drawn
Returns void

BabylonJS Mesh

drawGridMesh

drawGridMesh(inputs: SceneDrawGridMeshDto): Mesh

- Defined in bitbybit-docs.d.ts:19040
Draws a grid mesh on the ground plane in 3D space. This helps to orient yourself in the world.

group

grid

shortname

draw grid

disposableoutput

true

Parameters
- inputs: SceneDrawGridMeshDto
  
  Describes various parameters of the grid mesh like size, colour, etc.
Returns Mesh

grid mesh

drawGridMeshNoReturn

drawGridMeshNoReturn(inputs: SceneDrawGridMeshDto): void

- Defined in bitbybit-docs.d.ts:19031
Draws a grid mesh on the ground plane in 3D space. This helps to orient yourself in the world.

group

grid

shortname

draw grid no return

disposableoutput

true

Parameters
- inputs: SceneDrawGridMeshDto
  
  Describes various parameters of the grid mesh like size, colour, etc.
Returns void

optionsBabylonNode

optionsBabylonNode(inputs: DrawNodeOptions): DrawNodeOptions

- Defined in bitbybit-docs.d.ts:19080
Creates draw options for babylon js nodes

group

options

shortname

babylon node

Parameters
- inputs: DrawNodeOptions
  
  option definition
Returns DrawNodeOptions

options

optionsOcctShape

optionsOcctShape(inputs: DrawOcctShapeOptions): DrawOcctShapeOptions

- Defined in bitbybit-docs.d.ts:19056
Creates draw options for occt shape geometry like edges, wires, faces, shells, solids and compounds

group

options

shortname

occt shape

Parameters
- inputs: DrawOcctShapeOptions
  
  option definition
Returns DrawOcctShapeOptions

options

optionsOcctShapeMaterial

optionsOcctShapeMaterial(inputs: DrawOcctShapeMaterialOptions): DrawOcctShapeMaterialOptions

- Defined in bitbybit-docs.d.ts:19072
Creates simple draw options with custom face material for occt shape geometry

group

options

shortname

occt shape with material

Parameters
- inputs: DrawOcctShapeMaterialOptions
  
  option definition
Returns DrawOcctShapeMaterialOptions

options

optionsOcctShapeSimple

optionsOcctShapeSimple(inputs: DrawOcctShapeSimpleOptions): DrawOcctShapeSimpleOptions

- Defined in bitbybit-docs.d.ts:19064
Creates simple draw options for occt shape geometry

group

options

shortname

occt shape simple

Parameters
- inputs: DrawOcctShapeSimpleOptions
  
  option definition
Returns DrawOcctShapeSimpleOptions

options

optionsSimple

optionsSimple(inputs: DrawBasicGeometryOptions): DrawBasicGeometryOptions

- Defined in bitbybit-docs.d.ts:19048
Creates draw options for basic geometry types like points, lines, polylines, surfaces and jscad meshes

group

options

shortname

simple

Parameters
- inputs: DrawBasicGeometryOptions
  
  option definition
Returns DrawBasicGeometryOptions

options

Generated using TypeDoc