Version: Next

Class: Cognite3DViewer

Constructors

constructor

• new Cognite3DViewer(options): Cognite3DViewer

Parameters

Name	Type
`options`	`Cognite3DViewerOptions`

Returns

Cognite3DViewer

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:256

Accessors

cadBudget

• get cadBudget(): CadModelBudget

Gets the current budget for downloading geometry for CAD models. Note that this budget is shared between all added CAD models and not a per-model budget.

Returns

CadModelBudget

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:210

• set cadBudget(budget): void

Sets the current budget for downloading geometry for CAD models. Note that this budget is shared between all added CAD models and not a per-model budget.

Parameters

Name	Type
`budget`	`CadModelBudget`

Returns

void

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:220

cameraManager

• get cameraManager(): CameraManager

Returns

CameraManager

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:659

canvas

• get canvas(): HTMLCanvasElement

Returns the rendering canvas, the DOM element where the renderer draws its output.

Returns

HTMLCanvasElement

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:122

domElement

• get domElement(): HTMLElement

The DOM element the viewer will insert its rendering canvas into. The DOM element can be specified in the options when the viewer is created. If not specified, the DOM element will be created automatically. The DOM element cannot be changed after the viewer has been created.

Returns

HTMLElement

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:132

models

• get models(): CogniteModel[]

Gets a list of models currently added to the viewer.

Returns

CogniteModel[]

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:245

pointCloudBudget

• get pointCloudBudget(): PointCloudBudget

Returns the point cloud budget. The budget is shared between all loaded point cloud models.

Returns

PointCloudBudget

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:230

• set pointCloudBudget(budget): void

Sets the point cloud budget. The budget is shared between all loaded point cloud models.

Parameters

Name	Type
`budget`	`PointCloudBudget`

Returns

void

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:238

renderParameters

• get renderParameters(): RenderParameters

Returns parameters of THREE.WebGLRenderer used by the viewer.

Returns

RenderParameters

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:139

Methods

add360ImageSet

▸ add360ImageSet(datasource, dataModelIdentifier): Promise<Image360Collection>

Adds a set of 360 images to the scene from the /datamodels API in Cognite Data Fusion.

Parameters

Name	Type	Description
`datasource`	`"datamodels"`	The data data source which holds the references to the 360 image sets.
`dataModelIdentifier`	`Image360DataModelIdentifier`	The search parameters to apply when querying Cognite Datamodels that contains the 360 images.

Returns

Promise<Image360Collection>

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:830

▸ add360ImageSet(datasource, eventFilter, add360ImageOptions?): Promise<Image360Collection>

Adds a set of 360 images to the scene from the /events API in Cognite Data Fusion.

Parameters

Name	Type	Description
`datasource`	`"events"`	The CDF data source which holds the references to the 360 image sets.
`eventFilter`	`Object`	The metadata filter to apply when querying events that contains the 360 images.
`add360ImageOptions?`	`AddImage360Options`	Options for behaviours when adding 360 images.

Returns

Promise<Image360Collection>

Example

const eventFilter = { site_id: "12345" };
await viewer.add360ImageSet('events', eventFilter);

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:845

addCadModel

▸ addCadModel(options): Promise<CogniteCadModel>

Add a new CAD 3D model to the viewer. Call Cognite3DViewer.fitCameraToModel to see the model after the model has loaded.

Parameters

Name	Type
`options`	`AddModelOptions`

Returns

Promise<CogniteCadModel>

Example

const options = {
modelId:     'COGNITE_3D_MODEL_ID',
revisionId:  'COGNITE_3D_REVISION_ID',
};
viewer.addCadModel(options).then(model => {
viewer.fitCameraToModel(model, 0);
});

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:754

addCustomObject

▸ addCustomObject(customObject): void

Add a CustomObject to the viewer.

Parameters

Name	Type
`customObject`	`CustomObject`

Returns

void

Example

const sphere = new THREE.Mesh(
new THREE.SphereGeometry(),
new THREE.MeshBasicMaterial()
);
const customObject = CustomObject(sphere);
customObject.isPartOfBoundingBox = false;
viewer.addCustomObject(customObject);

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:1070

addModel

▸ addModel(options): Promise<CogniteModel>

Add a new model to the viewer. Call Cognite3DViewer.fitCameraToModel to see the model after the model has loaded.

Parameters

Name	Type
`options`	`AddModelOptions`

Returns

Promise<CogniteModel>

Example

const options = {
modelId:     'COGNITE_3D_MODEL_ID',
revisionId:  'COGNITE_3D_REVISION_ID',
};
viewer.addModel(options).then(model => {
viewer.fitCameraToModel(model, 0);
});

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:712

addObject3D

▸ addObject3D(object): void

Add a THREE.Object3D to the viewer.

Parameters

Name	Type
`object`	`Object3D`<`Object3DEventMap`>

Returns

void

Example

const sphere = new THREE.Mesh(
new THREE.SphereGeometry(),
new THREE.MeshBasicMaterial()
);
viewer.addObject3D(sphere);

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:1044

addPointCloudModel

▸ addPointCloudModel(options): Promise<CognitePointCloudModel>

Add a new pointcloud 3D model to the viewer. Call Cognite3DViewer.fitCameraToModel to see the model after the model has loaded.

Parameters

Name	Type
`options`	`AddModelOptions`

Returns

Promise<CognitePointCloudModel>

Example

const options = {
modelId:     'COGNITE_3D_MODEL_ID',
revisionId:  'COGNITE_3D_REVISION_ID',
};
viewer.addPointCloudModel(options).then(model => {
viewer.fitCameraToModel(model, 0);
});

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:797

determineModelType

▸ determineModelType(modelId, revisionId): Promise<"" | SupportedModelTypes>

Use to determine of which type the model is.

Parameters

Name	Type	Description
`modelId`	`number`	The model's id.
`revisionId`	`number`	The model's revision id.

Returns

Promise<"" | SupportedModelTypes>

Empty string if type is not supported.

Example

const viewer = new Cognite3DViewer(...);
const type = await viewer.determineModelType(options.modelId, options.revisionId)
let model: CogniteModel
switch (type) {
  case 'cad':
    model = await viewer.addCadModel(options);
    break;
  case 'pointcloud':
    model = await viewer.addPointCloudModel(options);
    break;
  default:
    throw new Error('Model is not supported');
}
viewer.fitCameraToModel(model);

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:1002

dispose

▸ dispose(): void

Dispose of WebGL resources. Can be used to free up memory when the viewer is no longer in use.

Returns

void

See

https://threejs.org/docs/#manual/en/introduction/How-to-dispose-of-objects

// Viewer is no longer in use, free up memory
viewer.dispose();

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:442

enter360Image

▸ enter360Image(image360, revision?): Promise<void>

Enter visualization of a 360 image.

Parameters

Name	Type	Description
`image360`	`Image360`	The 360 image to enter.
`revision?`	`Image360Revision`	The image revision to use. If not provided the newest revision will be shown.

Returns

Promise<void>

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:920

exit360Image

▸ exit360Image(): void

Exit visualization of the 360 image.

Returns

void

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:930

fitCameraToBoundingBox

▸ fitCameraToBoundingBox(box, duration?, radiusFactor?): void

Move camera to a place where the content of a bounding box is visible to the camera.

Parameters

Name	Type	Default value	Description
`box`	`Box3`	`undefined`	The bounding box in world space.
`duration?`	`number`	`undefined`	The duration of the animation moving the camera. Set this to 0 (zero) to disable animation.
`radiusFactor`	`number`	`2`	The ratio of the distance from camera to center of box and radius of the box.

Returns

void

Example

// Fit camera to bounding box over 500 milliseconds
viewer.fitCameraToBoundingBox(boundingBox, 500);

// Fit camera to bounding box instantaneously
viewer.fitCameraToBoundingBox(boundingBox, 0);

// Place the camera closer to the bounding box
viewer.fitCameraToBoundingBox(boundingBox, 500, 2);

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:1287

fitCameraToModel

▸ fitCameraToModel(model, duration?): void

Move camera to a place where the 3D model is visible. It uses the bounding box of the 3D model and calls Cognite3DViewer.fitCameraToBoundingBox.

Parameters

Name	Type	Description
`model`	`CogniteModel`	The 3D model.
`duration?`	`number`	The duration of the animation moving the camera. Set this to 0 (zero) to disable animation.

Returns

void

Example

// Fit camera to model
viewer.fitCameraToModel(model);

// Fit camera to model over 500 milliseconds
viewer.fitCameraToModel(model, 500);

// Fit camera to model instantly
viewer.fitCameraToModel(model, 0);

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:1242

fitCameraToModels

▸ fitCameraToModels(models?, duration?, restrictToMostGeometry?): void

Move camera to a place where a set of 3D models are visible.

Parameters

Name	Type	Default value	Description
`models?`	`CogniteModel`[]	`undefined`	Optional 3D models to focus the camera on. If no models are provided the camera will fit to all models.
`duration?`	`number`	`undefined`	The duration of the animation moving the camera. Set this to 0 (zero) to disable animation.
`restrictToMostGeometry`	`boolean`	`false`	If true, attempt to remove junk geometry from the bounds to allow setting a good camera position.

Returns

void

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:1253

get360AnnotationIntersectionFromPixel

▸ get360AnnotationIntersectionFromPixel(offsetX, offsetY): Promise<null | Image360AnnotationIntersection>

Check for intersections with 360 annotations through the given pixel. Similar to {getIntersectionFromPixel}, but checks 360 image annotations instead of models.

Parameters

Name	Type
`offsetX`	`number`
`offsetY`	`number`

Returns

Promise<null | Image360AnnotationIntersection>

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:1528

get360ImageCollections

▸ get360ImageCollections(): Image360Collection[]

Returns a list of added 360 image collections.

Returns

Image360Collection[]

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:884

getActive360ImageInfo

▸ getActive360ImageInfo(): undefined | Image360WithCollection

Returns the currently entered 360 image.

Returns

undefined | Image360WithCollection

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:891

getClippingPlanes

▸ getClippingPlanes(): Plane[]

Returns the current active global clipping planes.

Returns

Plane[]

Deprecated

Use Cognite3DViewer.getGlobalClippingPlanes instead.

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:1193

getGlobalClippingPlanes

▸ getGlobalClippingPlanes(): Plane[]

Returns the current active global clipping planes.

Returns

Plane[]

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:1200

getIntersectionFromPixel

▸ getIntersectionFromPixel(offsetX, offsetY): Promise<null | Intersection>

Raycasting model(s) for finding where the ray intersects with the model.

Parameters

Name	Type	Description
`offsetX`	`number`	X coordinate in pixels (relative to the domElement).
`offsetY`	`number`	Y coordinate in pixels (relative to the domElement).

Returns

Promise<null | Intersection>

A promise that if there was an intersection then return the intersection object - otherwise it returns null if there were no intersections.

See

https://en.wikipedia.org/wiki/Ray_casting For more details on Ray casting.

Example

const offsetX = 50 // pixels from the left
const offsetY = 100 // pixels from the top
const intersection = await viewer.getIntersectionFromPixel(offsetX, offsetY);
if (intersection) // it was a hit
  console.log(
  'You hit model ', intersection.model,
  ' at the node with tree index ', intersection.treeIndex,
  ' at this exact point ', intersection.point
  );

Example

const offsetX = 50 // pixels from the left
const offsetY = 100 // pixels from the top
const intersection = await viewer.getIntersectionFromPixel(offsetX, offsetY);
if (intersection) // it was a hit
  console.log(
  'You hit model ', intersection.model,
  ' at the point index ', intersection.pointIndex,
  ' at this exact point ', intersection.point
  );

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:1511

getScreenshot

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

Take a screenshot from the current camera position. When drawing UI, only the viewer DOM element and its children will be included in the image. The DOM is scaled to fit any provided resolution, and as a result some elements can be positioned incorrectly in regards to the 3D render.

html2canvas is used to draw UI and this has some limitations on what CSS properties it is able to render. See the html2canvas documentation for details.

Parameters

Name	Type	Default value	Description
`width`	`number`	`undefined`	Width of the final image. Default is current canvas size.
`height`	`number`	`undefined`	Height of the final image. Default is current canvas size.
`includeUI`	`boolean`	`true`	If false the screenshot will include only the rendered 3D. Default is true.

Returns

Promise<string>

A Data URL of the image ('image/png').

Example

// Take a screenshot with custom resolution
const url = await viewer.getScreenshot(1920, 1080);

// Add a screenshot with resolution of the canvas to the page
const url = await viewer.getScreenshot();
const image = document.createElement('img');
image.src = url;
document.body.appendChild(image);

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:1381

getVersion

▸ getVersion(): string

Returns reveal version installed.

Returns

string

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:415

getViewState

▸ getViewState(): ViewerState

Gets the current viewer state which includes the camera pose as well as applied styling.

Returns

ViewerState

JSON object containing viewer state.

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:676

loadCameraFromModel

▸ loadCameraFromModel(model): void

Attempts to load the camera settings from the settings stored for the provided model. See https://docs.cognite.com/api/v1/#operation/get3DRevision and https://docs.cognite.com/api/v1/#operation/update3DRevisions for information on how this setting is retrieved and stored. This setting can also be changed through the 3D models management interface in Cognite Fusion. If no camera configuration is stored in CDF, Cognite3DViewer.fitCameraToModel is used as a fallback.

Parameters

Name	Type	Description
`model`	`CogniteModel`	The model to load camera settings from.

Returns

void

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:1214

off

▸ off(event, callback): void

Parameters

Name	Type
`event`	`"click"` \| `"hover"`
`callback`	`PointerEventDelegate`

Returns

void

Example

viewer.off('click', onClick);

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:578

▸ off(event, callback): void

Parameters

Name	Type
`event`	`"cameraChange"`
`callback`	`CameraChangeDelegate`

Returns

void

Example

viewer.off('cameraChange', onCameraChange);

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:585

▸ off(event, callback): void

Parameters

Name	Type
`event`	`"cameraStop"`
`callback`	`CameraStopDelegate`

Returns

void

Example

viewer.off('cameraStop', onCameraStop);

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:592

▸ off(event, callback): void

Unsubscribe the 'beforeSceneRendered'-event previously subscribed with Cognite3DViewer.on.

Parameters

Name	Type
`event`	`"beforeSceneRendered"`
`callback`	`BeforeSceneRenderedDelegate`

Returns

void

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:596

▸ off(event, callback): void

Parameters

Name	Type
`event`	`"sceneRendered"`
`callback`	`SceneRenderedDelegate`

Returns

void

Example

viewer.off('sceneRendered', updateStats);

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:603

▸ off(event, callback): void

Parameters

Name	Type
`event`	`"disposed"`
`callback`	`DisposedDelegate`

Returns

void

Example

viewer.off('disposed', clearAll);

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:610

on

▸ on(event, callback): void

Triggered when the viewer is disposed. Listeners should clean up any resources held and remove the reference to the viewer.

Parameters

Name	Type
`event`	`"disposed"`
`callback`	`DisposedDelegate`

Returns

void

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:485

▸ on(event, callback): void

Parameters

Name	Type
`event`	`"click"` \| `"hover"`
`callback`	`PointerEventDelegate`

Returns

void

Example

const onClick = (event) => { console.log(event.offsetX, event.offsetY) };
viewer.on('click', onClick);

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:494

▸ on(event, callback): void

Parameters

Name	Type
`event`	`"cameraChange"`
`callback`	`CameraChangeDelegate`

Returns

void

Example

viewer.on('cameraChange', (position, target) => {
  console.log('Camera changed: ', position, target);
});

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:503

▸ on(event, callback): void

Parameters

Name	Type
`event`	`"cameraStop"`
`callback`	`CameraStopDelegate`

Returns

void

Example

viewer.on('cameraStop', () => {
  console.log('Camera stopped');
});

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:512

▸ on(event, callback): void

Event that is triggered immediately before the scene is rendered.

Parameters

Name	Type	Description
`event`	`"beforeSceneRendered"`	Metadata about the rendering frame.
`callback`	`BeforeSceneRenderedDelegate`	Callback to trigger when event occurs.

Returns

void

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:518

▸ on(event, callback): void

Event that is triggered immediately after the scene has been rendered.

Parameters

Name	Type	Description
`event`	`"sceneRendered"`	Metadata about the rendering frame.
`callback`	`SceneRenderedDelegate`	Callback to trigger when the event occurs.

Returns

void

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:524

remove360ImageSet

▸ remove360ImageSet(imageCollection): void

Removes a previously added 360 image collection from the viewer.

Parameters

Name	Type	Description
`imageCollection`	`Image360Collection`	Collection to remove.

Returns

void

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:911

remove360Images

▸ remove360Images(...image360Entities): Promise<void>

Remove a set of 360 images.

Parameters

Name	Type
`...image360Entities`	`Image360`[]

Returns

Promise<void>

Deprecated

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:900

removeCustomObject

▸ removeCustomObject(customObject): void

Remove a CustomObject from the viewer.

Parameters

Name	Type
`customObject`	`CustomObject`

Returns

void

Example

const sphere = new THREE.Mesh(new THREE.SphereGeometry(), new THREE.MeshBasicMaterial());
const customObject = CustomObject(sphere);
viewer.addCustomObject(sphere);
viewer.removeCustomObject(sphere);

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:1113

removeModel

▸ removeModel(model): void

Removes a model that was previously added using Cognite3DViewer.addModel, Cognite3DViewer.addCadModel or Cognite3DViewer.addPointCloudModel .

Parameters

Name	Type
`model`	`CogniteModel`

Returns

void

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:943

removeObject3D

▸ removeObject3D(object): void

Remove a THREE.Object3D from the viewer.

Parameters

Name	Type
`object`	`Object3D`<`Object3DEventMap`>

Returns

void

Example

const sphere = new THREE.Mesh(new THREE.SphereGeometry(), new THREE.MeshBasicMaterial());
viewer.addObject3D(sphere);
viewer.removeObject3D(sphere);

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:1092

requestRedraw

▸ requestRedraw(): void

Typically used when you perform some changes and can't see them unless you move camera.

Returns

void

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:1294

setBackgroundColor

▸ setBackgroundColor(backgroundColor): void

Sets the color used as the clear color of the renderer.

Parameters

Name	Type
`backgroundColor`	`Object`
`backgroundColor.alpha?`	`number`
`backgroundColor.color?`	`Color`

Returns

void

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:1130

setCameraManager

▸ setCameraManager(cameraManager): void

Sets the active camera manager instance for current Cognite3Dviewer.

Parameters

Name	Type	Description
`cameraManager`	`CameraManager`	Camera manager instance.

Returns

void

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:667

setClippingPlanes

▸ setClippingPlanes(clippingPlanes): void

Sets per-pixel clipping planes. Pixels behind any of the planes will be sliced away.

Parameters

Name	Type
`clippingPlanes`	`Plane`[]

Returns

void

Deprecated

Use Cognite3DViewer.setGlobalClippingPlanes instead.

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:1185

setGlobalClippingPlanes

▸ setGlobalClippingPlanes(clippingPlanes): void

Sets per-pixel clipping planes. Pixels behind any of the planes will be sliced away.

Parameters

Name	Type	Description
`clippingPlanes`	`Plane`[]	The planes to use for clipping.

Returns

void

Example

// Hide pixels with values less than 0 in the x direction
const plane = new THREE.Plane(new THREE.Vector3(1, 0, 0), 0);
viewer.setGlobalClippingPlanes([plane]);

// Hide pixels with values greater than 20 in the x direction
 const plane = new THREE.Plane(new THREE.Vector3(-1, 0, 0), 20);
viewer.setGlobalClippingPlanes([plane]);

// Hide pixels with values less than 0 in the x direction or greater than 0 in the y direction
const xPlane = new THREE.Plane(new THREE.Vector3(1, 0, 0), 0);
const yPlane = new THREE.Plane(new THREE.Vector3(0, -1, 0), 0);
viewer.setGlobalClippingPlanes([xPlane, yPlane]);

// Hide pixels behind an arbitrary, non axis-aligned plane
 const plane = new THREE.Plane(new THREE.Vector3(1.5, 20, -19), 20);
viewer.setGlobalClippingPlanes([plane]);

// Disable clipping planes
 viewer.setGlobalClippingPlanes([]);

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:1175

setLogLevel

▸ setLogLevel(level): void

Sets the log level. Used for debugging. Defaults to 'none' (which is identical to 'silent').

Parameters

Name	Type
`level`	`"error"` \| `"none"` \| `"debug"` \| `"trace"` \| `"info"` \| `"warn"` \| `"silent"`

Returns

void

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:424

setResolutionOptions

▸ setResolutionOptions(options): void

Set options to control resolution of the viewer. This includes settings for max resolution and limiting resolution when moving the camera.

Parameters

Name	Type	Description
`options`	`ResolutionOptions`	Options to apply.

Returns

void

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:402

setViewState

▸ setViewState(state): Promise<void>

Restores camera settings from the state provided, and clears all current styled node collections and applies the state object.

Parameters

Name	Type	Description
`state`	`ViewerState`	Viewer state retrieved from Cognite3DViewer.getViewState.

Returns

Promise<void>

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:686

worldToScreen

▸ worldToScreen(point, normalize?): null | Vector2

Convert a point in world space to its coordinates in the canvas. This can be used to place HTML objects near 3D objects on top of the 3D viewer.

Parameters

Name	Type	Description
`point`	`Vector3`	World space coordinate.
`normalize?`	`boolean`	Optional. If true, coordinates are normalized into [0,1]. If false, the values are in the range [0, <canvas_size>).

Returns

null | Vector2

Returns 2D coordinates if the point is visible on screen, or null if object is outside screen.

See

https://www.w3schools.com/graphics/canvas_coordinates.asp For details on HTML Canvas Coordinates.

Example

const boundingBoxCenter = new THREE.Vector3();
// Find center of bounding box in world space
model.getBoundingBox(nodeId).getCenter(boundingBoxCenter);
// Screen coordinates of that point
const screenCoordinates = viewer.worldToScreen(boundingBoxCenter);

const boundingBoxCenter = new THREE.Vector3();
// Find center of bounding box in world space
model.getBoundingBox(nodeId).getCenter(boundingBoxCenter);
// Screen coordinates of that point normalized in the range [0,1]
const screenCoordinates = viewer.worldToScreen(boundingBoxCenter, true);

const boundingBoxCenter = new THREE.Vector3();
// Find center of bounding box in world space
model.getBoundingBox(nodeId).getCenter(boundingBoxCenter);
// Screen coordinates of that point
const screenCoordinates = viewer.worldToScreen(boundingBoxCenter);
if (screenCoordinates == null) {
  // Object not visible on screen
} else {
  // Object is visible on screen
}

Defined in

packages/api/src/public/migration/Cognite3DViewer.ts:1332

Constructors​

constructor​

Parameters​

Returns​

Defined in​

Accessors​

cadBudget​

Returns​

Defined in​

Parameters​

Returns​

Defined in​

cameraManager​

Returns​

Defined in​

canvas​

Returns​

Defined in​

domElement​

Returns​

Defined in​

models​

Returns​

Defined in​

pointCloudBudget​

Returns​

Defined in​

Parameters​

Returns​

Defined in​

renderParameters​

Returns​

Defined in​

Methods​

add360ImageSet​

Parameters​

Returns​

Defined in​

Parameters​

Returns​

Defined in​

addCadModel​

Parameters​

Returns​

Defined in​

addCustomObject​

Parameters​

Returns​

Defined in​

addModel​

Parameters​

Returns​

Defined in​

addObject3D​

Parameters​

Returns​

Defined in​

addPointCloudModel​

Parameters​

Returns​

Defined in​

determineModelType​

Parameters​

Returns​

Defined in​

dispose​

Returns​

Defined in​

enter360Image​

Parameters​

Returns​

Defined in​

exit360Image​

Returns​

Defined in​

fitCameraToBoundingBox​

Parameters​

Returns​

Defined in​

fitCameraToModel​

Constructors

constructor

Parameters

Returns

Defined in

Accessors

cadBudget

Returns

Defined in

Parameters

Returns

Defined in

cameraManager

Returns

Defined in

canvas

Returns

Defined in

domElement

Returns

Defined in

models

Returns

Defined in

pointCloudBudget

Returns

Defined in

Parameters

Returns

Defined in

renderParameters

Returns

Defined in

Methods

add360ImageSet

Parameters

Returns

Defined in

Parameters

Returns

Defined in

addCadModel

Parameters

Returns

Defined in

addCustomObject

Parameters

Returns

Defined in

addModel

Parameters

Returns

Defined in

addObject3D

Parameters

Returns

Defined in

addPointCloudModel

Parameters

Returns

Defined in

determineModelType

Parameters

Returns

Defined in

dispose

Returns

Defined in

enter360Image

Parameters

Returns

Defined in

exit360Image

Returns

Defined in

fitCameraToBoundingBox

Parameters

Returns

Defined in

fitCameraToModel