Class DrawingApi<Change>

Use this API to load and visualize drawings.

Type Parameters

Change extends BimChangeBlob | BimChangeDwg = BimChangeDwg

Index

Constructors

Properties

defaultPosition defaultScale pdfDefaultBackgroundColor

Accessors

boundingInfo drawingParentNode grayscaleDefault invertedBackgroundDefault

Methods

[iterator] clear fitDrawingsToCamera foreach load

Constructors

constructor

new DrawingApi<Change extends BimChangeBlob | BimChangeDwg = BimChangeDwg>(
    _api: BimCoreApi,
    _textureSize?: number,
    _grayscaleDefault?: boolean,
    _invertedBackgroundDefault?: boolean,
): DrawingApi<Change>
Constructor
Type Parameters
- Change extends BimChangeBlob | BimChangeDwg = BimChangeDwg
Parameters
- _api: BimCoreApi
  Api
- _textureSize: number = 1024
  Defines size of texture used to render drawings. Recommended value is power of two. Higher resolution gives better visuals but costs more memory (a pixel takes 4 bytes).
- _grayscaleDefault: boolean = false
  Decides if the DWG drawings are grayscale by default. Onnly applies to dwg drawings.
- _invertedBackgroundDefault: boolean = false
  Decides if the DWG drawings are created with inverted background as default. Only applies to dwg drawings.
Returns DrawingApi<Change>

Properties

`Static` `Readonly`defaultPosition

defaultPosition: DeepImmutableObject<Vector3> = Vector3.ZeroReadOnly

`Static` `Readonly`defaultScale

defaultScale: DeepImmutable<Vector3> = ...

`Static` `Readonly`pdfDefaultBackgroundColor

pdfDefaultBackgroundColor: Color3 = ...

Accessors

boundingInfo

get boundingInfo(): BoundingInfo
Bounding information for the currently loaded DWG's

Returns BoundingInfo

drawingParentNode

get drawingParentNode(): TransformNode
Returns TransformNode

grayscaleDefault

get grayscaleDefault(): boolean
Returns boolean
set grayscaleDefault(value: boolean): void
Parameters
- value: boolean
Returns void

invertedBackgroundDefault

get invertedBackgroundDefault(): boolean
Returns boolean
set invertedBackgroundDefault(value: boolean): void
Parameters
- value: boolean
Returns void

Methods

[iterator]

"[iterator]"(): IterableIterator<DrawingType<Change>>
Returns IterableIterator<DrawingType<Change>>

clear

clear(): void
Remove all loaded drawings

Returns void

fitDrawingsToCamera

fitDrawingsToCamera(camera: ViewerCamera): Promise<void>
Parameters
- camera: ViewerCamera
Returns Promise<void>

foreach

foreach(action: BimDrawingObjectForEachAction<Change>): void
Iterate all loaded drawings.
Parameters
- action: BimDrawingObjectForEachAction<Change>
  Action which is called on each drawing.
Returns void

load

load(
drawings: DrawingApiLoadParameter<Change>,
camera?: ViewerCamera,
): Promise<void>
Load one or more drawings. Only PDF and 2D DWG files are supported. Note that 3D DWG's are not supported.
Parameters
- drawings: DrawingApiLoadParameter<Change>
  Drawings to load
- Optionalcamera: ViewerCamera
Returns Promise<void>
Promise