Class DrawComplete

सीन में कुछ भी ड्रॉ करना: कर्नेल शेप्स, पॉइंट, लाइनें, पॉलीलाइनें, कर्व, मेश और टैग सभी drawAnyAsync से होकर जाते हैं, जो एंटिटी के लिए सही रेंडरर चुनता है और ड्रॉ की गई वस्तु लौटाता है। options मेथड प्रत्येक प्रकार की एंटिटी के लिए डिफ़ॉल्ट के साथ ड्रॉइंग विकल्प बनाते हैं, createPBRMaterial और createTexture फेस स्लॉट के लिए मैटेरियल बनाते हैं, और ड्रॉ की गई वस्तु को वापस पास करके उसी जगह पुनः ड्रॉ किया जा सकता है।

Hierarchy (View Summary)

Bit.Draw
- DrawComplete

Index

Constructors

constructor

new DrawComplete(): DrawComplete
Returns DrawComplete
Inherited from Draw.constructor

draw

drawAnyAsync

drawAnyAsync<E extends any>(inputs: DrawAny<E>): Promise<Drawn<E, Mesh>>
Draws any kind of geometry after all input promises are resolved. Inputs can also be non-promise like.
Type Parameters
- E extends any
Parameters
- inputs: DrawAny<E>
  Contains options and entities to be drawn
Returns Promise<Drawn<E, Mesh>>
BabylonJS Mesh Promise
Overrides Draw.drawAnyAsync
- Defined in bitbybit-docs.d.ts:60791

drawGridMesh

drawGridMesh(inputs: SceneDrawGridMeshDto): Mesh
Draws a grid mesh on the ground plane in 3D space. This helps to orient yourself in the world.
Parameters
- inputs: SceneDrawGridMeshDto
  Describes various parameters of the grid mesh like size, colour, etc.
Returns Mesh
Overrides Draw.drawGridMesh
- Defined in bitbybit-docs.d.ts:60820

draw async

drawAnyAsyncNoReturn

drawAnyAsyncNoReturn(inputs: DrawAny): Promise<void>
Draws any entity into the scene, as drawAnyAsync does, without giving the drawn object back; for the last step of a script that only needs the result to appear.
Parameters
- inputs: DrawAny
  The entity to draw and the optional drawing options
Returns Promise<void>
Example
```
const box = await bitbybit.occt.shapes.solid.createBox({ width: 10, length: 10, height: 10, center: [0, 0, 0] });
await bitbybit.draw.drawAnyAsyncNoReturn({ entity: box });
```
Inherited from Draw.drawAnyAsyncNoReturn
- Defined in bitbybit-docs.d.ts:52528

draw sync

drawAnyNoReturn

drawAnyNoReturn(inputs: DrawAny): void
Draws an entity that needs no kernel work, as drawAny does, without giving the drawn object back; points, lines, polylines and tags qualify, kernel shapes do not.
Parameters
- inputs: DrawAny
  The entity to draw and the optional drawing options
Returns void
Example
```
bitbybit.draw.drawAnyNoReturn({ entity: [[0, 0, 0], [5, 5, 5], [10, 0, 0]] });
```
Inherited from Draw.drawAnyNoReturn
- Defined in bitbybit-docs.d.ts:52575

drawAny

drawAny<E extends any>(inputs: DrawAny<E>): Drawn<E, Mesh>
Draws an entity that needs no kernel work into the scene right away and gives back the drawn object: points, lines, polylines, tags and nodes.

Kernel shapes from OCCT, JSCAD and Manifold must go through drawAnyAsync, which waits for the kernel to mesh them.
Type Parameters
- E extends any
Parameters
- inputs: DrawAny<E>
  The entity to draw, the optional drawing options and the previous result when updating
Returns Drawn<E, Mesh>
What drawing the entity produces: a scene object for geometry, the tag or tags for a tag, an axis triad for a node; undefined for an empty list
Example
```
const options = bitbybit.draw.optionsSimple({ colours: "#00ff00", size: 0.5, opacity: 1, updatable: false, hidden: false, drawTwoSided: true, backFaceColour: "#0000ff", backFaceOpacity: 1, colorMapStrategy: Bit.Inputs.Base.colorMapStrategyEnum.lastColorRemainder, arrowSize: 0, arrowAngle: 15 });
const drawn = bitbybit.draw.drawAny({ entity: [[0, 0, 0], [5, 5, 5], [10, 0, 0]], options });
```
Inherited from Draw.drawAny
- Defined in bitbybit-docs.d.ts:52592

grid

drawGridMeshNoReturn

drawGridMeshNoReturn(inputs: SceneDrawGridMeshDto): void
Draws a grid on the ground plane, as drawGridMesh does, without giving the mesh back.
Parameters
- inputs: SceneDrawGridMeshDto
  The size, line spacing, colors and opacity of the grid
Returns void
Example
```
bitbybit.draw.drawGridMeshNoReturn({ width: 400, height: 400, subdivisions: 10, majorUnitFrequency: 10, minorUnitVisibility: 0.45, gridRatio: 0.5, opacity: 0.5, backFaceCulling: false, mainColor: "#ffffff", secondaryColor: "#ffffff" });
```
Inherited from Draw.drawGridMeshNoReturn
- Defined in bitbybit-docs.d.ts:52642

material

createTexture

createTexture(inputs: GenericTextureDto): Texture
Creates an image texture from a URL for the texture slots of createPBRMaterial, with tiling, offset, rotation and filtering that mean the same in every renderer.
Parameters
- inputs: GenericTextureDto
  The image URL and the tiling, offset, rotation, flip and sampling options
Returns Texture
The engine's texture
Example
```
const texture = bitbybit.draw.createTexture({ url: "https://example.com/wood.jpg", name: "wood", uScale: 2, vScale: 2, uOffset: 0, vOffset: 0, wAng: 0, invertY: false, invertZ: false, samplingMode: Bit.Inputs.Draw.samplingModeEnum.trilinear });
```
Inherited from Draw.createTexture
- Defined in bitbybit-docs.d.ts:52753

createPBRMaterial

createPBRMaterial(inputs: GenericPBRMaterialDto): PBRMetallicRoughnessMaterial
Creates a physically based material from settings that mean the same in every renderer: base color, metallic and roughness, opacity, emissive glow, the texture slots and the alpha and side options; put it in the faceMaterial of the drawing options.
Parameters
- inputs: GenericPBRMaterialDto
  The name, colors, metallic and roughness values, opacity, textures and rendering options
Returns PBRMetallicRoughnessMaterial
The engine's material
Example
```
const material = bitbybit.draw.createPBRMaterial({ name: "steel", baseColor: "#c0c0c0", metallic: 1, roughness: 0.4, alpha: 1, emissiveColor: "#000000", emissiveIntensity: 1, zOffset: 0, zOffsetUnits: 0, alphaMode: Bit.Inputs.Draw.alphaModeEnum.opaque, alphaCutoff: 0.5, doubleSided: false, wireframe: false, unlit: false });
const options = bitbybit.draw.optionsOcctShapeMaterial({ precision: 0.01, faceMaterial: material, drawEdges: true, edgeColour: "#ffffff", edgeWidth: 2 });
```
Inherited from Draw.createPBRMaterial
- Defined in bitbybit-docs.d.ts:52769

options

optionsOcctShapeSimple

optionsOcctShapeSimple(
inputs: DrawOcctShapeSimpleOptions,
): DrawOcctShapeSimpleOptions
Builds the most used drawing options for OCCT shapes, precision, face and edge colors and two-sided rendering, with defaults for what is left out.
Parameters
- inputs: DrawOcctShapeSimpleOptions
  The options to start from
Returns DrawOcctShapeSimpleOptions
The drawing options
Example
```
const options = bitbybit.draw.optionsOcctShapeSimple({ precision: 0.01, drawFaces: true, faceColour: "#ff0000", drawEdges: true, edgeColour: "#ffffff", edgeWidth: 2, drawTwoSided: true, backFaceColour: "#0000ff", backFaceOpacity: 1 });
```
Inherited from Draw.optionsOcctShapeSimple
- Defined in bitbybit-docs.d.ts:52697

optionsOcctShapeMaterial

optionsOcctShapeMaterial(
inputs: DrawOcctShapeMaterialOptions,
): DrawOcctShapeMaterialOptions

Builds drawing options for OCCT shapes whose faces use a full engine material, as createPBRMaterial makes one, plus the precision and edge style.

Parameters

inputs: DrawOcctShapeMaterialOptions
The options to start from

Returns DrawOcctShapeMaterialOptions

The drawing options

Example

const material = bitbybit.draw.createPBRMaterial({ name: "steel", baseColor: "#c0c0c0", metallic: 1, roughness: 0.4, alpha: 1, emissiveColor: "#000000", emissiveIntensity: 1, zOffset: 0, zOffsetUnits: 0, alphaMode: Bit.Inputs.Draw.alphaModeEnum.opaque, alphaCutoff: 0.5, doubleSided: false, wireframe: false, unlit: false });
const options = bitbybit.draw.optionsOcctShapeMaterial({ precision: 0.01, faceMaterial: material, drawEdges: true, edgeColour: "#ffffff", edgeWidth: 2 });

optionsManifoldShapeMaterial

optionsManifoldShapeMaterial(
inputs: DrawManifoldOrCrossSectionOptions,
): DrawManifoldOrCrossSectionOptions
Builds drawing options for Manifold solids and cross-sections: face color or a full engine material, the line style of cross-sections, normals and the two-sided rendering.
Parameters
- inputs: DrawManifoldOrCrossSectionOptions
  The options to start from
Returns DrawManifoldOrCrossSectionOptions
The drawing options
Example
```
const options = bitbybit.draw.optionsManifoldShapeMaterial({ faceOpacity: 1, faceColour: "#ff0000", faceMaterial: material, crossSectionColour: "#ff00ff", crossSectionWidth: 2, crossSectionOpacity: 1, computeNormals: false, drawTwoSided: true, backFaceColour: "#0000ff", backFaceOpacity: 1 });
const drawn = await bitbybit.draw.drawAnyAsync({ entity: solid, options });
```
Inherited from Draw.optionsManifoldShapeMaterial
- Defined in bitbybit-docs.d.ts:52725

optionsSimple

optionsSimple(inputs: DrawBasicGeometryOptions): DrawBasicGeometryOptions
Creates draw options for basic geometry types like points, lines, polylines, surfaces and jscad meshes
Parameters
- inputs: DrawBasicGeometryOptions
  option definition
Returns DrawBasicGeometryOptions
options
Overrides Draw.optionsSimple
- Defined in bitbybit-docs.d.ts:60828

optionsOcctShape

optionsOcctShape(inputs: DrawOcctShapeOptions): DrawOcctShapeOptions
Creates draw options for occt shape geometry like edges, wires, faces, shells, solids and compounds
Parameters
- inputs: DrawOcctShapeOptions
  option definition
Returns DrawOcctShapeOptions
options
Overrides Draw.optionsOcctShape
- Defined in bitbybit-docs.d.ts:60836

optionsBabylonNode

optionsBabylonNode(inputs: DrawNodeOptions): DrawNodeOptions
Creates draw options for babylon js nodes
Parameters
- inputs: DrawNodeOptions
  option definition
Returns DrawNodeOptions
options
Overrides Draw.optionsBabylonNode
- Defined in bitbybit-docs.d.ts:60844

Class DrawComplete

Hierarchy (View Summary)

Index

Constructors

draw

draw async

draw sync

grid

material

options

Constructors

constructor

Returns DrawComplete

draw

drawAnyAsync

Type Parameters

Parameters

Returns Promise<Drawn<E, Mesh>>

drawGridMesh

Parameters

Returns Mesh

draw async

drawAnyAsyncNoReturn

Parameters

Returns Promise<void>

Example

draw sync

drawAnyNoReturn

Parameters

Returns void

Example

drawAny

Type Parameters

Parameters

Returns Drawn<E, Mesh>

Example

grid

drawGridMeshNoReturn

Parameters

Returns void

Example

material

createTexture

Parameters

Returns Texture

Example

createPBRMaterial

Parameters

Returns PBRMetallicRoughnessMaterial

Example

options

optionsOcctShapeSimple

Parameters

Returns DrawOcctShapeSimpleOptions

Example

optionsOcctShapeMaterial

Parameters

Returns DrawOcctShapeMaterialOptions

Example

optionsManifoldShapeMaterial

Parameters

Returns DrawManifoldOrCrossSectionOptions

Example

optionsSimple

Parameters

Returns DrawBasicGeometryOptions

optionsOcctShape

Parameters

Returns DrawOcctShapeOptions

optionsBabylonNode

Parameters

Returns DrawNodeOptions

Settings

On This Page