3d-wrapper

@cognite/3d-wrapper-base > WrappedViewer

Class: WrappedViewer

Base Object which wraps and extends the 3D viewer for use in front-end applications. export:

class: WrappedViewer

Hierarchy

WrappedViewer

Index

Constructors

• constructor

Accessors

• CameraInformation
• DOMElement
• InternalViewer
• Model
• onCameraChange
• onClick

Methods

• addModel
• getScreenshot
• setAppliedStyle

---

Constructors

constructor

⊕ new WrappedViewer(options?: Cognite3DViewerOptions): WrappedViewer

Defined in WrappedViewer/WrappedViewer.ts:199

Creates an instance of WrappedViewer. memberof: WrappedViewer

Parameters:

Name	Type
Optional options	Cognite3DViewerOptions

Returns: WrappedViewer

---

Accessors

CameraInformation

getCameraInformation(): CamerasetCameraInformation(value: Camera): void

Defined in WrappedViewer/WrappedViewer.ts:111

Get a cmera object which represents current camera property values. type: {Camera}

memberof: WrappedViewer

Returns: Camera

Defined in WrappedViewer/WrappedViewer.ts:123

Updates the viewer’s camera object to match the camera inputted. memberof: WrappedViewer

Parameters:

Name	Type
value	Camera

Returns: void

---

DOMElement

getDOMElement(): HTMLCanvasElement

Defined in WrappedViewer/WrappedViewer.ts:101

Gets the base HTML element to which the 3D-viewer renders readonly:

type: {HTMLCanvasElement}

memberof: WrappedViewer

Returns: HTMLCanvasElement

---

InternalViewer

getInternalViewer(): Cognite3DViewer

Defined in WrappedViewer/WrappedViewer.ts:79

Gets the internal 3D Viewer which this class wraps readonly:

type: {Cognite3DViewer}

memberof: WrappedViewer

Returns: Cognite3DViewer

---

Model

getModel(): WrappedModel | undefined

Defined in WrappedViewer/WrappedViewer.ts:90

Gets the loaded model if one has been loaded or undefined. readonly:

type: {(WrappedModel

undefined)}

memberof: WrappedViewer

Returns: WrappedModel | undefined

---

onCameraChange

setonCameraChange(handler: * function | undefined*): void

Defined in WrappedViewer/WrappedViewer.ts:170

Sets a camera onclick callback function whenever the camera information changes in the 3d-viewer. memberof: WrappedViewer

Parameters:

Name	Type
handler	function | undefined

Returns: void

---

onClick

setonClick(handler: * function | undefined*): void

Defined in WrappedViewer/WrappedViewer.ts:133

Sets an onclick handler to any click on the 3d-viewers HTML element memberof: WrappedViewer

Parameters:

Name	Type
handler	function | undefined

Returns: void

---

Methods

addModel

▸ addModel(projectName: string, modelId: number, revisionId: number, apiCache: ApiCache, options?: object): Promise<WrappedModel>

Defined in WrappedViewer/WrappedViewer.ts:257

Loads a model into the 3D viewer memberof: WrappedViewer

Parameters:

Name	Type	Default value	Description
projectName	string	-	tenant name of the associated model
modelId	number	-	ModelID of the model to load
revisionId	number	-	RevisionID of the model to load
apiCache	ApiCache	-
Default value options	object	{}

Returns: Promise<WrappedModel>

---

getScreenshot

▸ getScreenshot(width: number, height: number): Promise<string>

Defined in WrappedViewer/WrappedViewer.ts:238

Takes a screenshot of the viewer memberof: WrappedViewer

Parameters:

Name	Type	Description
width	number	width in px of the screenshot
height	number	height in px of the screenshot

Returns: Promise<string>

• blob file URI of the screenshot

---

setAppliedStyle

▸ setAppliedStyle(styles: NodeStyle[]): Promise<void>

Defined in WrappedViewer/WrappedViewer.ts:214

Parameters:

Name	Type
styles	NodeStyle[]

Returns: Promise<void>

---