Version: Next

Module: @cognite/reveal

Enumerations

Classes

Interfaces

Type Aliases

AddImage360Options

Ƭ AddImage360Options: Object

Type declaration

Name	Type	Description
`annotationFilter?`	`Image360AnnotationFilterOptions`	Annotation options.
`collectionTransform?`	`Matrix4`	An optional transformation which will be applied to all 360 images that are fetched.
`preMultipliedRotation?`	`boolean`	Set this to false if the 360 images' rotation is not pre-multiplied to fit the given model. `Default` `ts true`

AssetAnnotationImage360Info

Ƭ AssetAnnotationImage360Info: Object

Asset search return type, including information about the image in which the asset is found

Type declaration

Name	Type	Description
`annotationInfo`	`ImageAssetLinkAnnotationInfo`	Reference to the relevant asset
`imageEntity`	`Image360`	The image entity in which the asset was found
`imageRevision`	`Image360Revision`	The image revision in which the asset was found

Defined in

packages/360-images/src/collection/Image360Collection.ts:28

BeforeSceneRenderedDelegate

Ƭ BeforeSceneRenderedDelegate: (event: { camera: PerspectiveCamera ; frameNumber: number ; renderer: WebGLRenderer }) => void

Delegate for event triggered when scene is about to be rendered.

Type declaration

▸ (event): void

Parameters

Name	Type
`event`	`Object`
`event.camera`	`PerspectiveCamera`
`event.frameNumber`	`number`
`event.renderer`	`WebGLRenderer`

Returns

void

Defined in

packages/utilities/src/events/types.ts:27

CadIntersection

Ƭ CadIntersection: Object

Type declaration

Name	Type	Description
`distanceToCamera`	`number`	Distance from the camera to the intersection.
`model`	`CogniteCadModel`	The model that was intersected.
`point`	`Vector3`	Coordinate of the intersection.
`treeIndex`	`number`	Tree index of the intersected 3D node.
`type`	`"cad"`	The intersection type.

Defined in

packages/api/src/public/migration/types.ts:234

CadModelBudget

Ƭ CadModelBudget: Object

Represents a measurement of how much geometry can be loaded.

Type declaration

Name	Type	Description
`highDetailProximityThreshold`	`number`	Sectors within this distance from the camera will always be loaded in high details. `Deprecated` This is only used for 3D models processed prior to the Reveal 3.0 release (Q1 2022).
`maximumRenderCost`	`number`	Maximum render cost. This number can be thought of as triangle count, although the number doesn't match this directly.

Defined in

packages/cad-geometry-loaders/src/CadModelBudget.ts:10

CameraChangeDelegate

Ƭ CameraChangeDelegate: (position: Vector3, target: Vector3) => void

Type declaration

▸ (position, target): void

Parameters

Name	Type
`position`	`Vector3`
`target`	`Vector3`

Returns

void

Defined in

packages/camera-manager/src/types.ts:62

CameraConfiguration

Ƭ CameraConfiguration: Object

Represents a camera configuration, consisting of a camera position and target.

Type declaration

Name	Type
`position`	`Vector3`
`target`	`Vector3`

Defined in

packages/utilities/src/CameraConfiguration.ts:10

CameraControlsOptions

Ƭ CameraControlsOptions: Object

Type declaration

Name	Type	Description
`changeCameraPositionOnDoubleClick?`	`boolean`	Enables or disables change of camera position on mouse doubke click. New target is then set to the point of the model under current cursor position and the a camera position is set half way to this point Default is false.
`changeCameraTargetOnClick?`	`boolean`	Enables or disables change of camera target on mouse click. New target is then set to the point of the model under current cursor position. Default is false.
`mouseWheelAction?`	`"zoomToTarget"` \| `"zoomPastCursor"` \| `"zoomToCursor"`	Sets mouse wheel initiated action. Modes: 'zoomToTarget' - zooms just to the current target (center of the screen) of the camera. 'zoomPastCursor' - zooms in the direction of the ray coming from camera through cursor screen position, allows going through objects. 'zoomToCursor' - mouse wheel scroll zooms towards the point on the model where cursor is hovering over, doesn't allow going through objects. Default is 'zoomPastCursor'.

Defined in

packages/camera-manager/src/CameraControlsOptions.ts:5

CameraEventDelegate

Ƭ CameraEventDelegate: CameraChangeDelegate | CameraStopDelegate

Union type of all camera event delegates

Defined in

packages/camera-manager/src/types.ts:73

CameraManagerEventType

Ƭ CameraManagerEventType: typeof CAMERA_MANAGER_EVENT_TYPE_LIST[number]

Union type of the supported camera manager event types

Defined in

packages/camera-manager/src/types.ts:108

CameraState

Ƭ CameraState: Object

Type declaration

Name	Type	Description
`position?`	`Vector3`	Camera position in world space.
`rotation?`	`Quaternion`	Camera local rotation in quaternion form.
`target?`	`Vector3`	Camera target in world space. *

Defined in

packages/camera-manager/src/types.ts:43

CameraStopDelegate

Ƭ CameraStopDelegate: () => void

Type declaration

▸ (): void

Returns

void

Defined in

packages/camera-manager/src/types.ts:68

ClippingPlanesState

Ƭ ClippingPlanesState: Object

Type declaration

Name	Type
`constant`	`number`
`nx`	`number`
`ny`	`number`
`nz`	`number`

Defined in

packages/api/src/utilities/ViewStateHelper.ts:28

CogniteModel

Ƭ CogniteModel: CogniteCadModel | CognitePointCloudModel

Type abstraction for CogniteCadModel or CognitePointCloudModel;.

Defined in

packages/api/src/public/types.ts:12

ComboControlsEventType

Ƭ ComboControlsEventType: Object

The event type for events emitted by ComboControls.

Type declaration

Name	Type
`cameraChange`	{ `camera`: { `position`: `Vector3` ; `target`: `Vector3` } }
`cameraChange.camera`	{ `position`: `Vector3` ; `target`: `Vector3` }
`cameraChange.camera.position`	`Vector3`
`cameraChange.camera.target`	`Vector3`

Defined in

packages/camera-manager/src/ComboControls.ts:31

ComboControlsOptions

Ƭ ComboControlsOptions: Object

Exposed options for Combo Controls

Type declaration

Name	Type	Description
`EPSILON`	`number`	-
`dampingFactor`	`number`	-
`dollyFactor`	`number`	-
`dynamicTarget`	`boolean`	-
`enableDamping`	`boolean`	-
`enableKeyboardNavigation`	`boolean`	-
`firstPersonRotationFactor`	`number`	-
`keyboardDollySpeed`	`number`	-
`keyboardPanSpeed`	`number`	-
`keyboardRotationSpeedAzimuth`	`number`	-
`keyboardRotationSpeedPolar`	`number`	-
`keyboardSpeedFactor`	`number`	How much quicker keyboard navigation will be with 'shift' pressed
`lookAtViewTarget`	`boolean`	-
`maxAzimuthAngle`	`number`	Radians
`maxDeltaDownscaleCoefficient`	`number`	-
`maxDeltaRatio`	`number`	-
`maxPolarAngle`	`number`	Radians
`maxZoom`	`number`	-
`minAzimuthAngle`	`number`	Radians
`minDeltaDownscaleCoefficient`	`number`	-
`minDeltaRatio`	`number`	-
`minDistance`	`number`	-
`minPolarAngle`	`number`	Radians
`minZoom`	`number`	-
`minZoomDistance`	`number`	-
`mouseFirstPersonRotationSpeed`	`number`	-
`orthographicCameraDollyFactor`	`number`	-
`panDollyMinDistanceFactor`	`number`	-
`pinchEpsilon`	`number`	-
`pinchPanSpeed`	`number`	-
`pointerRotationSpeedAzimuth`	`number`	Radians per pixel
`pointerRotationSpeedPolar`	`number`	Radians per pixel
`useScrollTarget`	`boolean`	-
`zoomToCursor`	`boolean`	-

Defined in

packages/camera-manager/src/ComboControlsOptions.ts:8

CompletePointCloudAppearance

Ƭ CompletePointCloudAppearance: Required<PointCloudAppearance>

Defined in

packages/pointcloud-styling/src/PointCloudAppearance.ts:12

CustomObjectIntersection

Ƭ CustomObjectIntersection: Object

This class is used as output intersecting custom objects

Type declaration

Name	Type	Description
`boundingBox?`	`Box3`	The bounding box of the part of the CustomObject that was intersected.
`customObject`	`ICustomObject`	The CustomObject that was intersected.
`distanceToCamera`	`number`	Distance from the camera to the intersection.
`point`	`Vector3`	Coordinate of the intersection.
`type`	`"customObject"`	The intersection type.
`userData?`	`any`	Additional info, for instance which part of the CustomObject was intersected.

Defined in

packages/utilities/src/customObject/CustomObjectIntersection.ts:12

DefaultOverlay3DContentType

Ƭ DefaultOverlay3DContentType: Object

The default metadata type contained in Overlays

Index signature

▪ [key: string]: string

Defined in

packages/3d-overlays/src/OverlayCollection.ts:11

DisposedDelegate

Ƭ DisposedDelegate: () => void

Type declaration

▸ (): void

Returns

void

Defined in

packages/utilities/src/events/types.ts:22

EdlOptions

Ƭ EdlOptions: Object

Configuration parameters for Eye Dome Lighting (EDL) point cloud post-processing effect.

Type declaration

Name	Type	Description
`radius`	`number`	Radius of sampled points in pixels. Determines thickness of edges addet on top of points.
`strength`	`number`	Determines how pronounced the effect is. Lower values result in more transparent edges.

Defined in

packages/rendering/src/rendering/types.ts:22

FlexibleControlsTypeChangeDelegate

Ƭ FlexibleControlsTypeChangeDelegate: (controlsType: FlexibleControlsType) => void

Type declaration

▸ (controlsType): void

Parameters

Name	Type
`controlsType`	`FlexibleControlsType`

Returns

void

Defined in

packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts:12

GeometryFilter

Ƭ GeometryFilter: Object

Type declaration

Name	Type	Description
`boundingBox?`	`Box3`	The bounds to load geometry within. By default this box is in CDF coordinate space which will be transformed into coordinates relative to the model using the the model transformation which can be specified using the CDF API, or set in Cognite Fusion. `See` GeometryFilter.isBoundingBoxInModelCoordinates.
`isBoundingBoxInModelCoordinates?`	`boolean`	When set, the geometry filter `boundingBox` will be considered to be in "Reveal/ThreeJS space". Rather than CDF space which is the default. When using Reveal space, the model transformation which can be specified using the CDF API, or set in Cognite Fusion.

Defined in

packages/cad-model/src/types.ts:24

Image360AnnotationAppearance

Ƭ Image360AnnotationAppearance: Object

The appearance of a 360 image annotation

Type declaration

Name	Type	Description
`color?`	`Color`	The color of the annotation. Default: Random, based on annotation label
`visible?`	`boolean`	Whether the annotation is visible. Default: true

Defined in

packages/360-images/src/annotation/types.ts:11

Image360AnnotationAssetFilter

Ƭ Image360AnnotationAssetFilter: Object

Filter for finding annotations related to an asset

Type declaration

Name	Type	Description
`assetRef`	`IdEither`	Reference to the wanted asset

Defined in

packages/360-images/src/collection/Image360Collection.ts:18

Image360AnnotationAssetQueryResult

Ƭ Image360AnnotationAssetQueryResult: Object

Result item from an asset annotation query

Type declaration

Name	Type	Description
`annotation`	`Image360Annotation`	The found annotation
`image`	`Image360`	The Image360 to which the result annotation belongs
`revision`	`Image360Revision`	The image revision to which the result annotation belongs

Defined in

packages/360-images/src/collection/Image360Collection.ts:46

Image360AnnotationFilterOptions

Ƭ Image360AnnotationFilterOptions: Object

Options for loading annotations in 360 images

Type declaration

Name	Type	Description
`status?`	`"all"` \| `AnnotationStatus` \| `AnnotationStatus`[]	Allow annotations matching this/these statuses. 'all' will match all annotations `Default` `ts 'approved'`

Defined in

packages/360-images/src/annotation/types.ts:26

Image360AnnotationIntersection

Ƭ Image360AnnotationIntersection: Object

Describes an intersection with a 360 image annotation

Type declaration

Name	Type	Description
`annotation`	`Image360Annotation`	The intersected annotation
`direction`	`Vector3`	The world direction from the camera to the intersection point
`type`	`"image360Annotation"`	The intersection type.

Defined in

packages/360-images/src/annotation/Image360AnnotationIntersection.ts:11

Image360DataModelIdentifier

Ƭ Image360DataModelIdentifier: Object

An identifier uniquely determining an instance of a Cognite Data Model

Type declaration

Name	Type
`image360CollectionExternalId`	`string`
`space`	`string`

Defined in

packages/data-providers/src/image-360-data-providers/descriptor-providers/datamodels/Cdf360DataModelsDescriptorProvider.ts:26

Image360EnteredDelegate

Ƭ Image360EnteredDelegate: (image360: Image360, revision: Image360Revision) => void

Delegate for 360 image mode entered events.

Type declaration

▸ (image360, revision): void

Parameters

Name	Type
`image360`	`Image360`
`revision`	`Image360Revision`

Returns

void

Defined in

packages/360-images/src/types.ts:11

Image360ExitedDelegate

Ƭ Image360ExitedDelegate: () => void

Delegate for 360 image mode exited events.

Type declaration

▸ (): void

Returns

void

Defined in

packages/360-images/src/types.ts:16

Image360IconStyle

Ƭ Image360IconStyle: Object

Image360 icon style

Type declaration

Name	Type	Description
`color?`	`Color`	A color tint to apply to the 360 icon

Defined in

packages/360-images/src/entity/Image360.ts:13

Image360WithCollection

Ƭ Image360WithCollection: Object

A tuple of a 360 image and its collection.

Type declaration

Name	Type
`image360`	`Image360`
`image360Collection`	`Image360Collection`

Defined in

packages/api/src/public/types.ts:21

ImageAssetLinkAnnotationInfo

Ƭ ImageAssetLinkAnnotationInfo: Omit<AnnotationModel, "data"> & { data: AnnotationsCogniteAnnotationTypesImagesAssetLink }

A CDF AnnotationModel with a narrower type representing an image asset link

Defined in

packages/data-providers/src/types.ts:46

Intersection

Ƭ Intersection: CadIntersection | PointCloudIntersection

Defined in

packages/api/src/public/migration/types.ts:287

ModelState

Ƭ ModelState: Object

Type declaration

Name	Type
`defaultNodeAppearance`	`SerializableNodeAppearance`
`modelId`	`number`
`revisionId`	`number`
`styledSets`	{ `appearance`: `SerializableNodeAppearance` ; `options?`: `any` ; `state`: `any` ; `token`: `string` }[]

Defined in

packages/api/src/utilities/ViewStateHelper.ts:35

NodeAppearance

Ƭ NodeAppearance: Object

Type for defining node appearance profiles to style a 3D CAD model.

See

DefaultNodeAppearance

Type declaration

Name	Type	Description
`color?`	`Color`	Overrides the default color of the node in RGB. Black, or `new Color(0, 0, 0)` means no override.
`outlineColor?`	`NodeOutlineColor`	When set, an outline is drawn around the node to make it stand out.
`prioritizedForLoadingHint?`	`number`	When provided, this value can be used to prioritize certain areas of the 3D model to be loaded. This can be useful to prioritize key objects in the 3D model to always be loaded. When non-zero, sectors containing geometry in the vicinity of the prioritized sectors are given an extra priority. Recommended values are in range 1 (somewhat higher priority to be loaded) to 10 (very likely to be loaded). Usually values around 4-5 is recommended. Prioritized nodes are loaded at the expense of non-prioritized areas. There are no guarantees that the nodes are actually loaded, and the more prioritized areas/nodes provided, the less likely it is that the hint is obeyed. Extra priority doesn't accumulate when sectors are prioritized because they intersect/contain several nodes. This is an advanced feature and not recommended for most users `Version` Only works with 3D models converted later than Q4 2021.
`renderGhosted?`	`boolean`	When set to true, the node is rendered ghosted, i.e. transparent with a fixed color. This has no effect if NodeAppearance.renderInFront is `true`.
`renderInFront?`	`boolean`	When set to true, the node is rendered in front of all other nodes even if it's occluded. Note that this take precedence over NodeAppearance.renderGhosted.
`visible?`	`boolean`	Overrides the visibility of the node.

Defined in

packages/cad-styling/src/NodeAppearance.ts:22

NodeCollectionSerializationContext

Ƭ NodeCollectionSerializationContext: Object

Type declaration

Name	Type
`client`	`CogniteClient`
`model`	`CdfModelNodeCollectionDataProvider`

Defined in

packages/cad-styling/src/NodeCollectionDeserializer.ts:22

OnLoadingCallback

Ƭ OnLoadingCallback: (itemsLoaded: number, itemsRequested: number, itemsCulled: number) => void

Type declaration

▸ (itemsLoaded, itemsRequested, itemsCulled): void

Parameters

Name	Type
`itemsLoaded`	`number`
`itemsRequested`	`number`
`itemsCulled`	`number`

Returns

void

Defined in

packages/api/src/public/migration/types.ts:30

OverlayInfo

Ƭ OverlayInfo<ContentType>: Object

Data used in creating an overlay.

Type parameters

Name	Type
`ContentType`	`DefaultOverlay3DContentType`

Type declaration

Name	Type	Description
`color?`	`Color`	The color of this overlay. Will be set by collection if undefined
`content`	`ContentType`	The data contained in this overlay
`position`	`Vector3`	Position of the overlay

Defined in

packages/3d-overlays/src/OverlayCollection.ts:18

PointCloudAppearance

Ƭ PointCloudAppearance: Object

Type declaration

Name	Type
`color?`	`Color`
`visible?`	`boolean`

Defined in

packages/pointcloud-styling/src/PointCloudAppearance.ts:7

PointCloudBudget

Ƭ PointCloudBudget: Object

Represents a budget of how many point from point clouds can be loaded at the same time.

Type declaration

Name	Type	Description
`numberOfPoints`	`number`	Total number of points that can be loaded for all point clouds models accumulated.

Defined in

packages/pointclouds/src/PointCloudBudget.ts:10

PointCloudIntersection

Ƭ PointCloudIntersection: Object

Type declaration

Name	Type	Description
`annotationId`	`number`	Annotation Id of the intersected object within a pointcloud. (0 if not applicable)
`assetRef?`	`AnnotationsAssetRef`	Reference to the asset associated to the intersected point cloud object, if any.
`distanceToCamera`	`number`	Distance from the camera to the intersection.
`model`	`CognitePointCloudModel`	The model that was intersected.
`point`	`Vector3`	Coordinate of the intersection.
`pointIndex`	`number`	The index of the point that was intersected.
`type`	`"pointcloud"`	The intersection type.

Defined in

packages/pointclouds/src/PointCloudIntersection.ts:8

PointCloudObjectMetadata

Ƭ PointCloudObjectMetadata: Object

Metadata for a single point cloud object

Type declaration

Name	Type	Description
`annotationId`	`number`	The CDF Annotation ID associated with the point cloud object.
`assetId?`	`number`	The CDF Asset ID associated with the point cloud object, if any. `Deprecated` Use PointCloudObjectMetadata.assetRef instead.
`assetRef?`	`AnnotationsAssetRef`	Asset identifiers for asset associated with this point cloud object, if any.
`boundingBox`	`Box3`	The bounding box of this annotation

Defined in

packages/data-providers/src/pointcloud-stylable-object-providers/types.ts:21

PointerEventData

Ƭ PointerEventData: Object

Type declaration

Name	Type
`button?`	`number`
`offsetX`	`number`
`offsetY`	`number`

Defined in

packages/utilities/src/events/types.ts:17

PointerEventDelegate

Ƭ PointerEventDelegate: (event: PointerEventData) => void

Type declaration

▸ (event): void

Parameters

Name	Type
`event`	`PointerEventData`

Returns

void

Defined in

packages/utilities/src/events/types.ts:11

PropertyFilterNodeCollectionOptions

Ƭ PropertyFilterNodeCollectionOptions: Object

Options for PropertyFilterNodeCollection.

Type declaration

Name	Type	Description
`requestPartitions?`	`number`	How many partitions to split the request into. More partitions can yield better performance for queries with very large result set (in order of magnitude 100.000 plus). Defaults to 1.

Defined in

packages/cad-styling/src/PropertyFilterNodeCollection.ts:18

RenderParameters

Ƭ RenderParameters: Object

Some parameters of WebGLRenderer initialized with Cognite3DViewer.

Type declaration

Name	Type	Description
`renderSize`	`Vector2`	Current width and height of the renderer's output canvas, in pixels.

Defined in

packages/api/src/public/migration/types.ts:35

ResolutionOptions

Ƭ ResolutionOptions: Object

Type declaration

Name	Type	Description
`maxRenderResolution?`	`number`	Generally Reveal will follow the resolution given by the size of the encapsulating DOM element of the Canvas Cognite3DViewerOptions.domElement. To ensure managable performance, Reveal will by default set an upper threshold to limit the resolution. The `maxRenderResolution` option will directly control this upper limit. It corresponds to the number of pixels in the render target.
`movingCameraResolutionFactor?`	`number`	A factor that will scale down the resolution when moving the camera. This can be used to achieve a better user experience on devices with limited hardware. Values must be greater than 0 and at most 1. This factor is applied to the number of physical pixels of the canvas. A value of e.g. 0.25 will approximately divide the number of pixels rendered on the screen by four.

Defined in

packages/api/src/public/migration/types.ts:263

SceneRenderedDelegate

Ƭ SceneRenderedDelegate: (event: { camera: PerspectiveCamera ; frameNumber: number ; renderTime: number ; renderer: WebGLRenderer }) => void

Type declaration

▸ (event): void

Parameters

Name	Type
`event`	`Object`
`event.camera`	`PerspectiveCamera`
`event.frameNumber`	`number`
`event.renderTime`	`number`
`event.renderer`	`WebGLRenderer`

Returns

void

Defined in

packages/utilities/src/events/types.ts:37

SerializableNodeAppearance

Ƭ SerializableNodeAppearance: Object

Type that represents a NodeAppearance in a serializable format

Type declaration

Name	Type	Description
`color?`	[`number`, `number`, `number`]	Color as an RGB number tuple, with values in the range [0, 255]
`outlineColor?`	`NodeOutlineColor`	Outline color, `See` NodeAppearance
`prioritizedForLoadingHint?`	`number`	Prioritized loading hint, `See` NodeAppearance
`renderGhosted?`	`boolean`	Whether to render ghosted, `See` NodeAppearance
`renderInFront?`	`boolean`	Whether to render in front, `See` NodeAppearance
`visible?`	`boolean`	Visibility, `See` NodeAppearance

Defined in

packages/cad-styling/src/NodeAppearance.ts:77

SerializedNodeCollection

Ƭ SerializedNodeCollection: Object

Type declaration

Name	Type
`options?`	`any`
`state`	`any`
`token`	`string`

Defined in

packages/cad-styling/src/SerializedNodeCollection.ts:4

SupportedModelTypes

Ƭ SupportedModelTypes: "pointcloud" | "cad"

Defined in

packages/model-base/src/SupportedModelTypes.ts:4

ViewerState

Ƭ ViewerState: Object

Type declaration

Name	Type
`camera?`	{ `position`: { `x`: `number` ; `y`: `number` ; `z`: `number` } ; `target`: { `x`: `number` ; `y`: `number` ; `z`: `number` } }
`camera.position`	{ `x`: `number` ; `y`: `number` ; `z`: `number` }
`camera.position.x`	`number`
`camera.position.y`	`number`
`camera.position.z`	`number`
`camera.target`	{ `x`: `number` ; `y`: `number` ; `z`: `number` }
`camera.target.x`	`number`
`camera.target.y`	`number`
`camera.target.z`	`number`
`clippingPlanes?`	`ClippingPlanesState`[]
`models?`	`ModelState`[]

Defined in

packages/api/src/utilities/ViewStateHelper.ts:19

WellKnownUnit

Units supported by CogniteCadModel.

Defined in

packages/cad-model/src/types.ts:11

Variables

CAMERA_MANAGER_EVENT_TYPE_LIST

• Const CAMERA_MANAGER_EVENT_TYPE_LIST: readonly ["cameraChange", "cameraStop"]

List of supported event types (adapted from https://stackoverflow.com/questions/44480644/string-union-to-string-array)

Defined in

packages/camera-manager/src/types.ts:103

CDF_TO_VIEWER_TRANSFORMATION

• Const CDF_TO_VIEWER_TRANSFORMATION: Matrix4 = cadFromCdfToThreeMatrix

The transformation matrix from CDF coordinates to ThreeJS/Reveal. Note that this is already applied to Reveal models.

Defined in

packages/utilities/src/constants.ts:14

DefaultNodeAppearance

• Const DefaultNodeAppearance: Object

A set of default node appearances used in Reveal.

Type declaration

Name	Type
`Default`	`NodeAppearance`
`Ghosted`	`NodeAppearance`
`Hidden`	`NodeAppearance`
`Highlighted`	{ `color?`: `Color` ; `outlineColor?`: `NodeOutlineColor` ; `prioritizedForLoadingHint?`: `number` ; `renderGhosted?`: `boolean` ; `renderInFront?`: `boolean` ; `visible?`: `boolean` }
`Highlighted.color?`	`Color`
`Highlighted.outlineColor?`	`NodeOutlineColor`
`Highlighted.prioritizedForLoadingHint?`	`number`
`Highlighted.renderGhosted?`	`boolean`
`Highlighted.renderInFront?`	`boolean`
`Highlighted.visible?`	`boolean`
`InFront`	`NodeAppearance`
`Outlined`	`NodeAppearance`

Defined in

packages/cad-styling/src/NodeAppearance.ts:142

DefaultPointCloudAppearance

• Const DefaultPointCloudAppearance: CompletePointCloudAppearance

Defined in

packages/pointcloud-styling/src/PointCloudAppearance.ts:14

REVEAL_VERSION

• Const REVEAL_VERSION: string = process.env.VERSION

Defined in

packages/api/index.ts:11

Functions

getNormalizedPixelCoordinates

▸ getNormalizedPixelCoordinates(domElement, pixelX, pixelY): THREE.Vector2

Parameters

Name	Type
`domElement`	`HTMLElement`
`pixelX`	`number`
`pixelY`	`number`

Returns

THREE.Vector2

Defined in

packages/utilities/src/worldToViewport.ts:82

getNormalizedPixelCoordinatesBySize

▸ getNormalizedPixelCoordinatesBySize(pixelX, pixelY, width, height): THREE.Vector2

Converts a pixel coordinate to normalized device coordinate (in range [-1, 1])

Parameters

Name	Type
`pixelX`	`number`
`pixelY`	`number`
`width`	`number`
`height`	`number`

Returns

THREE.Vector2

Defined in

packages/utilities/src/worldToViewport.ts:73

isFlexibleCameraManager

▸ isFlexibleCameraManager(manager): manager is IFlexibleCameraManager

Check id the CameraManager is a IFlexibleCameraManager

Parameters

Name	Type
`manager`	`CameraManager`

Returns

manager is IFlexibleCameraManager

Defined in

packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts:105

registerNodeCollectionType

▸ registerNodeCollectionType<T>(nodeCollectionTypeName, deserializer): void

Type parameters

Name	Type
`T`	extends `NodeCollection`

Parameters

Name	Type
`nodeCollectionTypeName`	`string`
`deserializer`	(`descriptor`: `SerializedNodeCollection`, `context`: `NodeCollectionSerializationContext`) => `Promise`<`T`>

Returns

void

Defined in

packages/cad-styling/src/NodeCollectionDeserializer.ts:156

Enumerations​

Classes​

Interfaces​

Type Aliases​

AddImage360Options​

Type declaration​

Defined in​

AnyIntersection​

Defined in​

AssetAnnotationImage360Info​

Type declaration​

Defined in​

BeforeSceneRenderedDelegate​

Type declaration​

Parameters​

Returns​

Defined in​

CadIntersection​

Type declaration​

Defined in​

CadModelBudget​

Type declaration​

Defined in​

CameraChangeDelegate​

Type declaration​

Parameters​

Returns​

Defined in​

CameraConfiguration​

Type declaration​

Defined in​

CameraControlsOptions​

Type declaration​

Defined in​

CameraEventDelegate​

Defined in​

CameraManagerEventType​

Defined in​

CameraState​

Type declaration​

Defined in​

CameraStopDelegate​

Type declaration​

Returns​

Defined in​

ClippingPlanesState​

Type declaration​

Defined in​

CogniteModel​

Defined in​

ComboControlsEventType​

Type declaration​

Defined in​

ComboControlsOptions​

Type declaration​

Defined in​

CompletePointCloudAppearance​

Defined in​

CustomObjectIntersection​

Type declaration​

Defined in​

DefaultOverlay3DContentType​

Index signature​

Defined in​

DisposedDelegate​

Type declaration​

Returns​

Defined in​

EdlOptions​

Type declaration​

Defined in​

FlexibleControlsTypeChangeDelegate​

Type declaration​

Parameters​

Returns​

Defined in​

GeometryFilter​

Type declaration​

Defined in​

Image360AnnotationAppearance​

Enumerations

Classes

Interfaces

Type Aliases

AddImage360Options

Type declaration

Defined in

AnyIntersection

Defined in

AssetAnnotationImage360Info

Type declaration

Defined in

BeforeSceneRenderedDelegate

Type declaration

Parameters

Returns

Defined in

CadIntersection

Type declaration

Defined in

CadModelBudget

Type declaration

Defined in

CameraChangeDelegate

Type declaration

Parameters

Returns

Defined in

CameraConfiguration

Type declaration

Defined in

CameraControlsOptions

Type declaration

Defined in

CameraEventDelegate

Defined in

CameraManagerEventType

Defined in

CameraState

Type declaration

Defined in

CameraStopDelegate

Type declaration

Returns

Defined in

ClippingPlanesState

Type declaration

Defined in

CogniteModel

Defined in

ComboControlsEventType

Type declaration

Defined in

ComboControlsOptions

Type declaration

Defined in

CompletePointCloudAppearance

Defined in

CustomObjectIntersection

Type declaration

Defined in

DefaultOverlay3DContentType

Index signature

Defined in

DisposedDelegate

Type declaration

Returns

Defined in

EdlOptions

Type declaration

Defined in

FlexibleControlsTypeChangeDelegate

Type declaration

Parameters

Returns

Defined in

GeometryFilter

Type declaration

Defined in

Image360AnnotationAppearance