Klasse DrawComplete

Zeichnet alles in die Szene: Kernel-Formen, Punkte, Linien, Polylinien, Kurven, Meshes und Tags laufen alle über drawAnyAsync, das den passenden Renderer für die Entität wählt und das gezeichnete Objekt zurückgibt. Die options-Methoden bauen die Zeichenoptionen mit Standardwerten für jede Art von Entität, createPBRMaterial und createTexture erstellen Materialien für die Flächenslots, und ein gezeichnetes Objekt kann an Ort und Stelle neu gezeichnet werden, indem es zurückgegeben wird.

Hierarchie (Zusammenfassung anzeigen)

Bit.Draw
- DrawComplete

Index

Konstruktoren

constructor

new DrawComplete(): DrawComplete
Rückgabewert DrawComplete
Geerbt von 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.
Typenparameter
- E extends any
Parameter
- inputs: DrawAny<E>
  Contains options and entities to be drawn
Rückgabewert Promise<Drawn<E, Mesh>>
BabylonJS Mesh Promise
Überschreibt Draw.drawAnyAsync
- Definiert 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.
Parameter
- inputs: SceneDrawGridMeshDto
  Describes various parameters of the grid mesh like size, colour, etc.
Rückgabewert Mesh
Überschreibt Draw.drawGridMesh
- Definiert 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.
Parameter
- inputs: DrawAny
  The entity to draw and the optional drawing options
Rückgabewert 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 });
```
Geerbt von Draw.drawAnyAsyncNoReturn
- Definiert 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.
Parameter
- inputs: DrawAny
  The entity to draw and the optional drawing options
Rückgabewert void
Example
```
bitbybit.draw.drawAnyNoReturn({ entity: [[0, 0, 0], [5, 5, 5], [10, 0, 0]] });
```
Geerbt von Draw.drawAnyNoReturn
- Definiert 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.
Typenparameter
- E extends any
Parameter
- inputs: DrawAny<E>
  The entity to draw, the optional drawing options and the previous result when updating
Rückgabewert 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 });
```
Geerbt von Draw.drawAny
- Definiert 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.
Parameter
- inputs: SceneDrawGridMeshDto
  The size, line spacing, colors and opacity of the grid
Rückgabewert 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" });
```
Geerbt von Draw.drawGridMeshNoReturn
- Definiert 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.
Parameter
- inputs: GenericTextureDto
  The image URL and the tiling, offset, rotation, flip and sampling options
Rückgabewert 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 });
```
Geerbt von Draw.createTexture
- Definiert 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.
Parameter
- inputs: GenericPBRMaterialDto
  The name, colors, metallic and roughness values, opacity, textures and rendering options
Rückgabewert 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 });
```
Geerbt von Draw.createPBRMaterial
- Definiert 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.
Parameter
- inputs: DrawOcctShapeSimpleOptions
  The options to start from
Rückgabewert 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 });
```
Geerbt von Draw.optionsOcctShapeSimple
- Definiert 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.

Parameter

inputs: DrawOcctShapeMaterialOptions
The options to start from

Rückgabewert 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.
Parameter
- inputs: DrawManifoldOrCrossSectionOptions
  The options to start from
Rückgabewert 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 });
```
Geerbt von Draw.optionsManifoldShapeMaterial
- Definiert 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
Parameter
- inputs: DrawBasicGeometryOptions
  option definition
Rückgabewert DrawBasicGeometryOptions
options
Überschreibt Draw.optionsSimple
- Definiert 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
Parameter
- inputs: DrawOcctShapeOptions
  option definition
Rückgabewert DrawOcctShapeOptions
options
Überschreibt Draw.optionsOcctShape
- Definiert in bitbybit-docs.d.ts:60836

optionsBabylonNode

optionsBabylonNode(inputs: DrawNodeOptions): DrawNodeOptions
Creates draw options for babylon js nodes
Parameter
- inputs: DrawNodeOptions
  option definition
Rückgabewert DrawNodeOptions
options
Überschreibt Draw.optionsBabylonNode
- Definiert in bitbybit-docs.d.ts:60844

Klasse DrawComplete

Hierarchie (Zusammenfassung anzeigen)

Index

Konstruktoren

draw

draw async

draw sync

grid

material

options

Konstruktoren

constructor

Rückgabewert DrawComplete

draw

drawAnyAsync

Typenparameter

Parameter

Rückgabewert Promise<Drawn<E, Mesh>>

drawGridMesh

Parameter

Rückgabewert Mesh

draw async

drawAnyAsyncNoReturn

Parameter

Rückgabewert Promise<void>

Example

draw sync

drawAnyNoReturn

Parameter

Rückgabewert void

Example

drawAny

Typenparameter

Parameter

Rückgabewert Drawn<E, Mesh>

Example

grid

drawGridMeshNoReturn

Parameter

Rückgabewert void

Example

material

createTexture

Parameter

Rückgabewert Texture

Example

createPBRMaterial

Parameter

Rückgabewert PBRMetallicRoughnessMaterial

Example

options

optionsOcctShapeSimple

Parameter

Rückgabewert DrawOcctShapeSimpleOptions

Example

optionsOcctShapeMaterial

Parameter

Rückgabewert DrawOcctShapeMaterialOptions

Example

optionsManifoldShapeMaterial

Parameter

Rückgabewert DrawManifoldOrCrossSectionOptions

Example

optionsSimple

Parameter

Rückgabewert DrawBasicGeometryOptions

optionsOcctShape

Parameter

Rückgabewert DrawOcctShapeOptions

optionsBabylonNode

Parameter

Rückgabewert DrawNodeOptions

Einstellungen

Auf dieser Seite