ContextAPI#

Interface ContextAPI

The ContextAPI combines all functionality which can be applied on the WebvisContext.

Hierarchy

Methods

add addCustomNode addToCollection addToSelection addTopologyToSelection changeAnnotation changeClipPlane changeClippingRoom changeDrawing changeDrawingPlane changeMeasurement changeSetting changeSnapshot clear clearSelection clearTopologySelection clipOtherParts collectRuntimeNodesOfType connectToSession connectXRSession createAnimationFrames createAnnotation createAttachment createBoxVolume createCapping createCircularArcDescriptor createClipPlane createClippingRoom createCollection createDrawing createDrawingPlane createExplosion createMeasurement createNodePathHandles createPointDescriptor createSnapshot createViewer disableCapping disconnectFromSession enableCapping endExplosion enterXRMemberInitMode exitXRMemberInitMode exportXRInitTemplate fetchAttachmentData fixateXRMember getAnnotationData getAnnotations getAttachmentData getAttachmentDataURI getClipPlanes getClipRoom getCollection getCollectionElements getCollectionNodeCount getCoordinateSystemForwardVector getCoordinateSystemMatrix getCoordinateSystemRightVector getCoordinateSystemUpVector getDrawingPlaneData getDrawingPlanes getDrawings getEnabledAuxNodes getEnabledLayerFilters getInteractionMode getMeasurements getMetadata getName getProperties getProperty getRegisteredLayerFilters getRootNodeId getSelectedLeafNodes getSelectedNodes getSelectedTopologyHandles getSelection getSessionMemberID getSessionMembers getSessionStateData getShapeHandle getSnapshotData getSnapshots getStatistics getTopologyType getViewer getViewers getXRMemberInfo getXRMemberState getXRMembers getXRSessionState importConfig importSession importXRInitTemplate invertEnabledStates invertSelection isColorComparisonActive isNodeDeletable isNodePartOfEnabledLayers isNodePartOfEnabledVariant isNodeType isOfflineStorageAvailable isSelected isTopologySelected mapInternalToOriginalTopologyHandles mapOriginalToInternalTopologyHandles measureBetween measureTangent measureThickness performExplosion processInteractionInput promoteSessionMember query readSetting registerCustomProperty registerFrameListener registerListener remove removeAnimationFrames removeAnnotation removeAttachment removeCapping removeClipPlane removeClippingRoom removeCollection removeDrawing removeDrawingPlane removeFromCollection removeFromSelection removeMeasurement removeSessionMember removeSnapshot removeTopologyFromSelection removeViewer requestActiveSceneVolume requestAnnotationData requestAuxRootNodeIds requestBoxDescriptor requestClipPlaneData requestClipRoomData requestDrawingData requestFullSceneVolume requestL3DInformation requestMeasurementData requestNodeIdsByBoxVolume requestNodePathHandleMap requestNodePathStrings requestRootNodeIds requestServiceStates requestSnapshotData requestSupportedContentTypes requestSupportedRenderSetups requestTopologyDescriptor requestVariants requestXMemberCapabilities resetAR resetInteractionMode resetProperties resetProperty resetSetting resetUserSettings restoreSession restoreSnapshot searchByVolume selectCollection setAttachmentData setAttachmentDataURI setInteractionMode setLayerFilterEnabled setParent setProperty setSelection setTopologyProperty setTopologySelection setVariantEnabled setXRFusionMode setXRMemberSettings showExpertDialog shutdownSession startAR startXRMemberSpectate stopAR stopXRMemberSpectate storeSession transferSession unfixateXRMember unregisterFrameListener unregisterListener waitFor

Methods

add

  • Adds a new Node to the InstanceGraph.

    Parameters

    Returns number

    The id of added Node

  • Parameters

    • dataURI: string

      Specifies the URI to the data resource.

    • Optional parentID: number

      Specifies the parent Node ID of the added Node.

    • Optional usage: UsageString

      The usage parameter allows to define how the resource should be inserted in the InstanceGraph.

    • Optional label: string

      Specifies a custom label for the added Node.

    • Optional contentType: string

      Specifies the MimeType of the data resource.

    • Optional initialProperties: InitialNodeProperties

      Specifies initialProperties of the added Node.

    • Optional cacheStrategy: CacheStrategy

      Specifies the strategy which is used when a data cache is requested from the Hub.

    Returns number

    The id of added Node

    Deprecated

    Adds a new Node to the InstanceGraph.

addCustomNode

  • Creates a custom Node with custom data which is stored in an Attachment.

    Parameters

    • customNodeType: string

      {string} Specifies the custom Node type.

    • data: any

      {any} Specifies the data of the custom Node.

    • Optional dataType: AttachmentType

      {AttachmentType="json"} Specifies the type of the data.

    Returns number

addToCollection

  • Adds the node given by nodeID to the collection with id collectionID. If recursive is true, the descendants of the node are also added. Returns the number of nodes in the collection.

    Parameters

    • collectionID: number

      Specifies to which collection the node should be added

    • nodeID: number

      Specifies which node should be added to the collection

    • Optional recursive: boolean

      Specifies if the children of the node should also be added to the collection

    Returns void

addToSelection

  • Adds the given Nodes to the Selection.

    Parameters

    • nodeID: number | number[]

      The ID of the Node that should be added to the current Selection

    • Optional silent: boolean

      If set to true, no event will be emitted.

    Returns Promise<ChangeSelectionResult>

addTopologyToSelection

  • Adds one or multiple Topology elements to the current selection.

    Parameters

    • handle: TopologyHandle | TopologyHandle[]

      A Topology Element or the list of Topology Elements which should be added to the current selection.

    Returns Promise<void>

changeAnnotation

  • Changes one or more properties of an Annotation with the specified id.

    Parameters

    • annotationId: number

      The id of the Annotation you want to change.

    • properties: AnnotationProperties

      The properties of the Annotation you want change.

    Returns AnnotationProperties

    An Object with the changed Properties.

  • Parameters

    • annotationID: number

      The ID of the Annotation.

    • Optional label: string

      The text of the Annotation.

    • Optional visible: boolean

      Indicates if the Annotation should be visible or hidden.

    • Optional anchorPosition: number[] | Float32Array

      Anchor position in world space coordinates.

    • Optional labelPosition: number[] | Float32Array

      The position of the label.

    • Optional active: boolean

      DEPRECATED

    • Optional transform: number[] | Float32Array

      The transformation of the Annotation.

    Returns void

    Deprecated

    Changes an annotation.

changeClipPlane

  • Changes one or more properties of a clip plane with the specified id.

    Parameters

    • clipPlaneId: number

      The id of the clip plane you want to change.

    • properties: ClipPlaneProperties

      The properties of the clip plane you want change.

    Returns ClipPlaneProperties

    An Object with the changed Properties.

  • Changes the properties of the clip plane defined by the clipPlaneID with the optional parameters normal, points and name.

    Parameters

    • clipPlaneID: number

      The ID of an existing clip plane which should be changed

    • Optional normal: number[] | Float32Array

      The new normal of the clip plane

    • Optional point: number[] | Float32Array

      An arbitrary new point in space which lies on the clip plane

    • Optional name: string

      The new name for the clip plane

    • Optional thickness: number

      The thickness for the clip plane

    • Optional tangent: number[] | Float32Array

      The tangent of the clip plane

    • Optional disabled: boolean

      The enabled state of the clip plane

    • Optional invisible: boolean

      Invisible on the UI

    • Optional exclusive: boolean

      set the exclusive flag to clip geometry when using exclusiveClipplanes property

    Returns void

    Deprecated

    Calling changeClipPlane with single parameters is deprecated, please use ClipPlaneProperties instead.

changeClippingRoom

  • Changes one or more properties of the clip room.

    Parameters

    • Optional properties: ClipRoomProperties

      The properties of the clip room you want change.

    Returns ClipRoomProperties

    An object with the changed properties.

  • Parameters

    • Optional name: string

      The name of the clip room.

    • Optional size: number[] | Float32Array

      The size of the clip room.

    • Optional transformation: number[] | Float32Array

      The transformation of the clip room.

    • Optional disabled: boolean

      The disabled state of the clip room.

    • Optional invisible: boolean

      The invisible state of the clip room.

    Returns ClipRoomProperties

    An object with the changed properties.

    Deprecated

    Calling changeClippingRoom with single parameters is deprecated, please use ClipRoomProperties instead.

    Changes one or more properties of the clip room.

changeDrawing

changeDrawingPlane

changeMeasurement

changeSetting

  • Changes the setting to the given value.

    Type Parameters

    • T extends string

    Parameters

    • setting: T

      A name that specifies a particular setting

    • value: ContextSettingType<T>

      The new value for the setting

    Returns boolean

    A boolean which indicates if the setting has changed

changeSnapshot

  • Changes one or more properties of a Snapshot with the specified ID.

    Parameters

    • snapshotID: number

      The ID of the Snapshot you want to change.

    • properties: SnapshotProperties

      The properties of the Snapshot you want to change.

    Returns SnapshotProperties

    An object with the changed Properties.

  • This changes the textual description of the Snapshot for given snapshotID to the value of text.

    Parameters

    • snapshotID: number

      The ID of the Snapshot.

    • Optional name: string

      The new name of the Snapshot.

    • Optional screenshotURL: string

      The new screenshot URL of the Snapshot.

    • Optional order: number

      The order inside the List of Snapshots.

    Returns SnapshotProperties

    Deprecated

    Calling changeSnapshot with single parameters is deprecated, please use SnapshotProperties instead.

clear

  • Clears the whole Context by removing all Nodes, Snapshots, ClipPlanes, Drawings, Measurements, etc.

    Returns Promise<void>

clearSelection

clearTopologySelection

clipOtherParts

  • Creates a clip room around the box volume of the specified node.

    Parameters

    • target: number | number[]

      ID(s) of the target Node(s).

    Returns void

collectRuntimeNodesOfType

  • Returns a list of all existing runtime Node ids of a specified type.

    Parameters

    • nodeType: NodeType

      The Node type to collect.

    • Optional subType: string

      The sub type to collect. Only used for Custom-Nodes.

    Returns number[]

    A list of runtime Node ids of the specified type.

connectToSession

  • Parameters

    • Optional sessionID: string

      The ID of the Session.

    • Optional name: string

      The ID of the Session.

    Returns Promise<SessionStateData>

    Deprecated

    The whole SessionAPI is under consolidation and will be replaced in a future release.

    Connects to a Session. If the ID does not exist, a new Session will be created.

connectXRSession

createAnimationFrames

  • Creates a new keyframe-based animation sequence.

    Parameters

    • name: string

      The name of the animation sequence.

    • frames: AnimationFrame[]

      The keyframes of the animation sequence.

    Returns void

createAnnotation

  • Creates a new Annotation.

    Parameters

    Returns number

    The id of the newly created Annotation.

  • Parameters

    • nodeID: number

      The ID of the node that the Annotation belongs to.

    • label: string

      The text of the Annotation.

    • Optional visible: boolean

      Indicates if the Annotation should be visible or hidden.

    • Optional anchorPosition: number[] | Float32Array

      Anchor position in world space coordinates.

    • Optional labelOffset: number[] | Float32Array

      The offset between anchorPosition and where the label should be displayed.

    Returns number

    The ID of the new annotation.

    Deprecated

    Creates a new annotation.

createAttachment

  • Creates a new attachment.

    Parameters

    • Optional dataType: AttachmentType

      Specifies the attachment data type.

    Returns number

    The attachment id.

createBoxVolume

  • Creates a new BoxVolume object.

    Parameters

    • Optional min: [number, number, number]
    • Optional max: [number, number, number]

    Returns BoxVolume

    A new Box Volume

createCapping

  • Experimental

    Generates capping geometry for the surface that is cut by the clip plane. The generated surfaces allow measurements and all other operations which can be performed on usual geometry.

    Parameters

    • clipPlaneId: number

      the id of the clip plane

    Returns Promise<void>

createCircularArcDescriptor

createClipPlane

  • Creates a new clip plane.

    Parameters

    Returns number

    The id of the newly created clip plane.

  • Creates a clip plane defined by the plane’s normal, positioned at an optional point (otherwise at the world space origin) and an optional name. Returns the ID of the clip plane.

    Parameters

    • Optional normal: number[] | Float32Array

      The normal of the clip plane

    • Optional point: number[] | Float32Array

      An arbitrary point in space which lies on the clip plane

    • Optional name: string

      The name of the clip plane

    • Optional thickness: number

      The thickness of the clip plane

    • Optional tangent: number[] | Float32Array

      The tangent of the clip plane

    • Optional disabled: boolean

      The state of the clip plane

    • Optional invisible: boolean

      Invisible on the UI

    • Optional exclusive: boolean

      set the exclusive flag to clip geometry when using exclusiveClipplanes property

    Returns number

    The ID of the newly created clip plane

    Deprecated

    Calling createClipPlane with single parameters is deprecated, please use ClipPlaneProperties instead.

createClippingRoom

  • Creates a new clip room.

    Parameters

    Returns void

  • Parameters

    • Optional name: string

      The name of the clip room.

    • Optional size: number[] | Float32Array

      The size of the clip room.

    • Optional transformation: number[] | Float32Array

      The transformation of the clip room.

    • Optional disabled: boolean

      The disabled state of the clip room.

    • Optional invisible: boolean

      The invisible state of the clip room.

    Returns void

    Deprecated

    Calling createClippingRoom with single parameters is deprecated, please use ClipRoomProperties instead.

    Creates a new clip room.

createCollection

  • Returns the id of a new collection containing the nodes from the given list.

    Parameters

    • Optional nodeIDlist: number[]

      An array of node id's from which a new node collection should be created.

    Returns number

    The id of the newly created node collection.

  • Creates a new, empty collection and returns its id.

    Returns number

    The id of the newly created collection.

createDrawing

createDrawingPlane

  • Experimental

    Creates a new DrawingPlane with the specified properties.

    Parameters

    Returns number

    The ID of the newly created Drawing.

createExplosion

  • Creates an Explosion (around a given point).

    Parameters

    • Optional centerNodeID: number

      The nodeID of the node around which center the explosion is created.

    Returns void

createMeasurement

createNodePathHandles

  • createNodePathHandles Creates and returns handles for the target node ids or topology selectors.

    Parameters

    • targets: number[]

      {Array} Array of target node ids to create the handles for

    Returns Promise<NodePathHandle[]>

    The array of handles

createPointDescriptor

createSnapshot

  • Creates a Snapshot of the current.

    Parameters

    • Optional name: string

      The Name of the Snapshot.

    • Optional options: SnapshotCreationOptions

      Options used for the Snapshot creation.

    Returns Promise<number>

    The Snapshot ID.

createViewer

  • Creates a viewer element.

    Parameters

    • Optional viewerID: string

      The id of the viewer.

    • Optional canvas: HTMLCanvasElement

      The canvas which is attached to the viewer.

    • Optional settings: {
          aaSetting: any;
          backgroundColor: any;
          cappingEffectEdgeColor: any;
          cappingEffectEnabled: any;
          cappingEffectInnerColor: any;
          colorComparisonFirstColor: any;
          colorComparisonMatchingColor: any;
          colorComparisonSecondColor: any;
          colorizeEffect: any;
          coordSys: any;
          defaultFieldOfView: any;
          disableSpecularHighlights: any;
          doubleClickAnimationVolumeScale: any;
          doubleClickTimeWindow: any;
          drawingArrowheadEnd: any;
          drawingArrowheadStart: any;
          drawingColor: any;
          drawingMode: any;
          drawingSize: any;
          dynamicAuxContrastEnabled: any;
          dynamicCOREnabled: any;
          dynamicClippingDistance: any;
          dynamicClippingEnabled: any;
          expandOnViewerSelection: any;
          faceHighlightColor: any;
          faceSelectionColor: any;
          fitViewFactor: any;
          flyNavigationSpeed: any;
          flyToOnDoubleClick: any;
          focusOnDoubleClick: any;
          frustumCulling: any;
          gizmoScalingFactor: any;
          gizmosEnabled: any;
          gpuMemoryReleaseFactor: any;
          hoverColor: any;
          initView: any;
          initialFit: any;
          lightingEnvironment: any;
          lineHighlightColor: any;
          lineSelectionColor: any;
          maxDynamicClipDistance: any;
          maxGPUMemory: any;
          maxSRCCPUMemory: any;
          mouseInvertZoomingDirection: any;
          navigationMode: any;
          navigationSampling: any;
          navigationSpeedFactor: any;
          navigationSpeedThrottleFactor: any;
          preSelectionColor: any;
          projectionType: any;
          renderAuxOnTop: any;
          renderMode: any;
          renderSetup: any;
          screenSpaceCoverageCalculationMethod: any;
          selectionColor: any;
          showAuxOnNavigation: any;
          silhouetteEffect: any;
          silhouetteEffectColor: any;
          silhouetteEffectExclusiveEnabled: any;
          smallFeatureCulling: any;
          smallFeaturePixelThreshold: any;
          soc: any;
          spacemouseMultiplier: any;
          ssaoEnabled: any;
          taaEnabled: any;
          topoGeometryColor: any;
          topoGeometrySecondaryColor: any;
          topoPointsEnabled: any;
          turntableLowerVerticalLimit: any;
          turntableUpperVerticalLimit: any;
          turntableVerticalLimitsEnabled: any;
          useDevicePixelRatio: any;
          vertexColorsEnabled: any;
          viewPerspective: any;
          webglPreserveDrawingbuffer: any;
      }

      ViewerSettings

      • aaSetting: any
      • backgroundColor: any
      • cappingEffectEdgeColor: any
      • cappingEffectEnabled: any
      • cappingEffectInnerColor: any
      • colorComparisonFirstColor: any
      • colorComparisonMatchingColor: any
      • colorComparisonSecondColor: any
      • colorizeEffect: any
      • coordSys: any
      • defaultFieldOfView: any
      • disableSpecularHighlights: any
      • doubleClickAnimationVolumeScale: any
      • doubleClickTimeWindow: any
      • drawingArrowheadEnd: any
      • drawingArrowheadStart: any
      • drawingColor: any
      • drawingMode: any
      • drawingSize: any
      • dynamicAuxContrastEnabled: any
      • dynamicCOREnabled: any
      • dynamicClippingDistance: any
      • dynamicClippingEnabled: any
      • expandOnViewerSelection: any
      • faceHighlightColor: any
      • faceSelectionColor: any
      • fitViewFactor: any
      • flyNavigationSpeed: any
      • flyToOnDoubleClick: any
      • focusOnDoubleClick: any
      • frustumCulling: any
      • gizmoScalingFactor: any
      • gizmosEnabled: any
      • gpuMemoryReleaseFactor: any
      • hoverColor: any
      • initView: any
      • initialFit: any
      • lightingEnvironment: any
      • lineHighlightColor: any
      • lineSelectionColor: any
      • maxDynamicClipDistance: any
      • maxGPUMemory: any
      • maxSRCCPUMemory: any
      • mouseInvertZoomingDirection: any
      • navigationMode: any
      • navigationSampling: any
      • navigationSpeedFactor: any
      • navigationSpeedThrottleFactor: any
      • preSelectionColor: any
      • projectionType: any
      • renderAuxOnTop: any
      • renderMode: any
      • renderSetup: any
      • screenSpaceCoverageCalculationMethod: any
      • selectionColor: any
      • showAuxOnNavigation: any
      • silhouetteEffect: any
      • silhouetteEffectColor: any
      • silhouetteEffectExclusiveEnabled: any
      • smallFeatureCulling: any
      • smallFeaturePixelThreshold: any
      • soc: any
      • spacemouseMultiplier: any
      • ssaoEnabled: any
      • taaEnabled: any
      • topoGeometryColor: any
      • topoGeometrySecondaryColor: any
      • topoPointsEnabled: any
      • turntableLowerVerticalLimit: any
      • turntableUpperVerticalLimit: any
      • turntableVerticalLimitsEnabled: any
      • useDevicePixelRatio: any
      • vertexColorsEnabled: any
      • viewPerspective: any
      • webglPreserveDrawingbuffer: any

    Returns ViewerAPI

disableCapping

  • Experimental

    Disables the generated capping geometry.

    Parameters

    • clipPlaneId: number

      the id of the clip plane

    Returns Promise<void>

disconnectFromSession

  • Returns void

    Deprecated

    The whole SessionAPI is under consolidation and will be replaced in a future release.

    Disconnects from a Session.

enableCapping

  • Experimental

    Enables the generated capping geometry.

    Parameters

    • clipPlaneId: number

      the id of the clip plane

    Returns Promise<void>

endExplosion

  • Restores the initial transformations of all exploded parts.

    Returns void

enterXRMemberInitMode

  • Experimental

    Enters the initialization phase for modeltracking. This is also used to reset the current modeltracking. It will also trigger a XRMemberStateChangedEvent event with FIXATED set to false. By default the modeltracking will be softreset. If you choose to reset different data on the modeltracker you can do so by specifying the XRInitOptions.

    Parameters

    • memberId: number

      The XRMember that the operation should be applied on.

    • Optional xrInitOptions: XRInitOptions

      Specify initialization options. E.g. reset behavior of modeltracker. Default is softreset.

    Returns Promise<boolean>

    Returns a Promise which reports whether the operation was successful or not.

exitXRMemberInitMode

  • Experimental

    Exits the initialization phase for modeltracking, this will also anchor the model at the current position.

    Parameters

    • memberId: number

      The XRMember that the operation should be applied on.

    Returns Promise<boolean>

    Returns a Promise which reports whether the operation was successful or not.

exportXRInitTemplate

  • Experimental

    Exports init template for modeltracking. Usage: After a successful tracking session, the learned init template data can be exported with this function and stored for later.

    Only supported if the XRMember has the MODELTRACKER capability.

    The aquired data can be imported via importXRInitTemplate function

    Parameters

    • memberId: number

      the XRMember that the operation should be applied on

    Returns Promise<string>

    base64 encoded init template data

fetchAttachmentData

  • Fetches & returns the attachment data.

    Type Parameters

    • T = any

    Parameters

    • Optional attachmentID: number

      Specifies the attachment object.

    Returns Promise<T>

    The attached data.

fixateXRMember

  • Experimental

    Anchors the model at the current position. It will also trigger a XRMemberStateChangedEvent event with FIXATED set to true.

    Parameters

    • memberId: number

      The XRMember that the operation should be applied on.

    Returns Promise<boolean>

    Returns a Promise which reports whether the operation was successful or not.

getAnnotationData

getAnnotations

getAttachmentData

  • Returns the attachment data.

    Type Parameters

    • T = any

    Parameters

    • Optional attachmentID: number

      Specifies the attachment object.

    Returns T

    The attached data

    Deprecated

    getAttachmentData is deprecated, please use fetchAttachmentData instead.

getAttachmentDataURI

  • Returns the attachment data URI.

    Parameters

    • Optional attachmentID: number

      Specifies the attachment object.

    Returns string

getClipPlanes

  • Returns the ids of all available clip planes.

    Returns number[]

    The ids of all available clip planes.

getClipRoom

  • Returns the id the clip room.

    Returns number

    The id the clip room.

getCollection

getCollectionElements

  • Returns an array containing the ids of the nodes in the collection. Modifying the returned array results in undefined behavior.

    Parameters

    • collectionID: number

      The id of the node collection

    Returns Promise<number[]>

    Array of node IDs representing the node collection

    READONLY

getCollectionNodeCount

  • Returns the number of elements inside a collection.

    Parameters

    • collectionID: number

      The id of the collection

    Returns Promise<number>

    Number of elements in a collection.

getCoordinateSystemForwardVector

  • Returns the forward vector of the current coordinate system.

    Returns Float32Array | [number, number, number]

    The forward vector of the current coordinate system.

getCoordinateSystemMatrix

  • Returns a 4x4 rotation matrix which is used to transform the internal default right-handed coordinate system with X and Y as front plane axis to the configured one.

    Returns Float32Array | [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]

    The CoordinateSystem Matrix

getCoordinateSystemRightVector

  • Returns the right vector of the current coordinate system.

    Returns Float32Array | [number, number, number]

    Retuns

    The right vector of the current coordinate system.

getCoordinateSystemUpVector

  • Returns the up vector of the current coordinate system.

    Returns Float32Array | [number, number, number]

    The up vector of the current coordinate system.

getDrawingPlaneData

getDrawingPlanes

  • Experimental

    Returns all available DrawingPlane IDs.

    Returns number[]

    An Array of all available DrawingPlane IDs.

getDrawings

  • Returns all available Drawing ids.

    Returns number[]

    An Array of all available Drawing ids.

getEnabledAuxNodes

  • Parameters

    • Optional nodeID: number

      Specifies the entry point of the subtree traversal (default: 0)

    Returns Promise<number[]>

    An Array of all enabled aux Node id's

    Deprecated

    This function will no longer be available in future webvis releases

    Traverses the subtree of a given nodeID and collects all enabled aux Nodes.

getEnabledLayerFilters

  • Returns the currently defined list of enabled LayerFilters.

    Returns string[]

    An array of strings representing the names of the enabled LayerFilters.

getInteractionMode

getMeasurements

getMetadata

  • Returns a JSON object containing the metadata for the given nodeID.

    Parameters

    • nodeID: number

      The id of a Node.

    Returns Promise<{
        [key: string]: string;
    }>

    A JSON object containing the requested metadata.

getName

  • Returns string

    The name of the context.

getProperties

  • Returns the values of the properties on the Node with the matching id.

    Type Parameters

    • T extends string

    Parameters

    • nodeID: number

      The id of the Node whose properties should be read.

    • properties: T[]

      The names of the properties whose value should be read.

    Returns Promise<PropertyType<T>[]>

    The retrieved values of the Node's properties.

getProperty

  • Returns the value of the property on the Node with the matching id.

    Type Parameters

    • T extends string

    Parameters

    • nodeID: number

      The id of the Node whose property should be read.

    • property: T

      The name of the property whose value should be read.

    Returns Promise<PropertyType<T>>

    The retrieved value of the Node property.

getRegisteredLayerFilters

  • Returns the currently defined list of LayerFilters.

    Returns {
        [key: string]: boolean;
    }

    Returns the registered LayerFilters and their states.

    • [key: string]: boolean

getRootNodeId

  • Returns the root Node id of the given Node or Topology Element.

    Parameters

    • target: number | TopologyHandle

      Specifies the target Node or Topology Element.

    • Optional includeTarget: boolean

      Controls if the target Node itself can be returned as root Node. If set to false and a root Node id is passed in, it returns the next higher root Node id.

    Returns number

    • The root Node id of the given Node id or Topology handle.

getSelectedLeafNodes

  • Returns a list of all selected nodes.

    Returns number[]

    An array which contains the IDs of all Nodes in the current Selection.

getSelectedNodes

  • Returns all selected leaf nodes.

    Returns number[]

    An array which contains the IDs of all leaf Nodes in the current Selection.

getSelectedTopologyHandles

getSelection

  • Returns a list of all selected nodes.

    Returns Promise<number[]>

    An array which contains the IDs of all leaf Nodes in the current Selection.

    Deprecated

    getSelection is deprecated, please use getSelectedNodes instead.

getSessionMemberID

  • Returns number

    The ID of the SessionMember.

    Deprecated

    The whole SessionAPI is under consolidation and will be replaced in a future release.

getSessionMembers

  • Returns Promise<SessionMemberData[]>

    The IDs of all SessionMembers.

    Deprecated

    The whole SessionAPI is under consolidation and will be replaced in a future release.

getSessionStateData

  • Returns SessionStateData

    Information about the Session.

    Deprecated

    The whole SessionAPI is under consolidation and will be replaced in a future release.

getShapeHandle

getSnapshotData

  • Parameters

    • snapshotID: number

    Returns {
        attachmentID: number;
        name: string;
        order: number;
    }

    The data of the specified Snapshot.

    • attachmentID: number
    • name: string
    • order: number

    Deprecated

    getSnapshotData is deprecated, please use requestSnapshotData instead.

getSnapshots

  • Returns the ids of all available Snapshots.

    Returns number[]

    The ids of all available Snapshots.

getStatistics

  • Traverses the subtree of a given nodeID and collects all statistics (currently only available for AUX-Nodes).

    Parameters

    • Optional nodeType: NodeType

      Specifies the target Node type.

    • Optional nodeID: number

      Specifies the entry point of the subtree traversal (default: 0).

    • Optional recursive: boolean

    Returns Promise<any>

    An Object of Type/Count pairs.

getTopologyType

getViewer

  • Parameters

    • Optional id: string

      The id of the viewer.

    Returns ViewerAPI

    The viewer element by the given id.

getViewers

getXRMemberInfo

  • Experimental

    Get the XRMemberInfo for a given XRMember.

    Parameters

    • memberId: number

      The XRMember that the operation should be applied on.

    Returns XRMemberInfo

    Returns an XRMemberInfo struct containing all relevant infos (memberId, XRCapabilities, sessionMemberData) for the given member.

getXRMemberState

  • Experimental

    Get the runtime state of a given XRMember.

    Parameters

    • memberId: number

      The XRMember that the state should be queried from.

    Returns XRMemberState

    Returns either the member state if the member exist or return undefined if XR is not connected or the memberId does not exist.

getXRMembers

  • Experimental

    Lists all the available XRMembers in the current session.

    Returns number[]

    Returns a Promise with the list of the IDs of all available XRMembers.

getXRSessionState

importConfig

  • Applies the specified set of settings to the context.

    Parameters

    • config: {
          aaSetting: any;
          additionalCookies: any;
          additionalRequestHeaders: any;
          additionalWSQueryParameters: any;
          applicationIdentifier: any;
          auxModeRecursiveSearch: any;
          auxModeUncolorFacesOnLeave: any;
          backgroundColor: any;
          boosterURL: any;
          cappingEffectEdgeColor: any;
          cappingEffectEnabled: any;
          cappingEffectInnerColor: any;
          cappingGeometryColor: any;
          colorComparisonFirstColor: any;
          colorComparisonMatchingColor: any;
          colorComparisonSecondColor: any;
          colorizeEffect: any;
          contextMenuFunction: any;
          coordSys: any;
          defaultFieldOfView: any;
          defaultQueryLinkDepth: any;
          disableDefaultInteraction: any;
          disableSpecularHighlights: any;
          doubleClickAnimationVolumeScale: any;
          doubleClickTimeWindow: any;
          drawingArrowheadEnd: any;
          drawingArrowheadStart: any;
          drawingColor: any;
          drawingMode: any;
          drawingSize: any;
          dynamicAuxContrastEnabled: any;
          dynamicCOREnabled: any;
          dynamicClippingDistance: any;
          dynamicClippingEnabled: any;
          expandOnViewerSelection: any;
          faceHighlightColor: any;
          faceSelectionColor: any;
          fitViewFactor: any;
          flyNavigationSpeed: any;
          flyToOnDoubleClick: any;
          focusOnDoubleClick: any;
          frontPlaneAxis: any;
          frustumCulling: any;
          gizmoScalingFactor: any;
          gizmosEnabled: any;
          gpuMemoryReleaseFactor: any;
          hoverColor: any;
          hubURL: any;
          initView: any;
          initialFit: any;
          initialStateActivation: any;
          lightingEnvironment: any;
          lineHighlightColor: any;
          lineSelectionColor: any;
          loadRemoteConfigFile: any;
          logLevel: any;
          maxActiveSceneVolumeDiameter: any;
          maxConcurrentDownloads: any;
          maxDynamicClipDistance: any;
          maxGPUMemory: any;
          maxSRCCPUMemory: any;
          measurementAngularTolerance: any;
          measurementMaterialDensities: any;
          mouseInvertZoomingDirection: any;
          navigationMode: any;
          navigationSampling: any;
          navigationSpeedFactor: any;
          navigationSpeedThrottleFactor: any;
          notificationLogLevels: any;
          parentSelectEnabled: any;
          preSelectionColor: any;
          preferXHRWithCredentials: any;
          projectionType: any;
          renderAuxOnTop: any;
          renderMode: any;
          renderSetup: any;
          screenSpaceCoverageCalculationMethod: any;
          selectionColor: any;
          sessionDeviceTags: any;
          sessionForwardUrl: any;
          sessionInteractions: any;
          sessionMemberName: any;
          showAuxOnNavigation: any;
          silhouetteEffect: any;
          silhouetteEffectColor: any;
          silhouetteEffectExclusiveEnabled: any;
          skipSslVerify: any;
          slamProviderType: any;
          smallFeatureCulling: any;
          smallFeaturePixelThreshold: any;
          snapshotContentSelection: any;
          soc: any;
          spacemouseMultiplier: any;
          ssaoEnabled: any;
          taaEnabled: any;
          topoGeometryColor: any;
          topoGeometrySecondaryColor: any;
          topoPointsEnabled: any;
          turntableLowerVerticalLimit: any;
          turntableUpperVerticalLimit: any;
          turntableVerticalLimitsEnabled: any;
          uriMap: any;
          useDevicePixelRatio: any;
          vertexColorsEnabled: any;
          viewPerspective: any;
          webglPreserveDrawingbuffer: any;
          xrEnabled: any;
      }

      Settings to import

      • aaSetting: any
      • additionalCookies: any
      • additionalRequestHeaders: any
      • additionalWSQueryParameters: any
      • applicationIdentifier: any
      • auxModeRecursiveSearch: any
      • auxModeUncolorFacesOnLeave: any
      • backgroundColor: any
      • boosterURL: any
      • cappingEffectEdgeColor: any
      • cappingEffectEnabled: any
      • cappingEffectInnerColor: any
      • cappingGeometryColor: any
      • colorComparisonFirstColor: any
      • colorComparisonMatchingColor: any
      • colorComparisonSecondColor: any
      • colorizeEffect: any
      • contextMenuFunction: any
      • coordSys: any
      • defaultFieldOfView: any
      • defaultQueryLinkDepth: any
      • disableDefaultInteraction: any
      • disableSpecularHighlights: any
      • doubleClickAnimationVolumeScale: any
      • doubleClickTimeWindow: any
      • drawingArrowheadEnd: any
      • drawingArrowheadStart: any
      • drawingColor: any
      • drawingMode: any
      • drawingSize: any
      • dynamicAuxContrastEnabled: any
      • dynamicCOREnabled: any
      • dynamicClippingDistance: any
      • dynamicClippingEnabled: any
      • expandOnViewerSelection: any
      • faceHighlightColor: any
      • faceSelectionColor: any
      • fitViewFactor: any
      • flyNavigationSpeed: any
      • flyToOnDoubleClick: any
      • focusOnDoubleClick: any
      • frontPlaneAxis: any
      • frustumCulling: any
      • gizmoScalingFactor: any
      • gizmosEnabled: any
      • gpuMemoryReleaseFactor: any
      • hoverColor: any
      • hubURL: any
      • initView: any
      • initialFit: any
      • initialStateActivation: any
      • lightingEnvironment: any
      • lineHighlightColor: any
      • lineSelectionColor: any
      • loadRemoteConfigFile: any
      • logLevel: any
      • maxActiveSceneVolumeDiameter: any
      • maxConcurrentDownloads: any
      • maxDynamicClipDistance: any
      • maxGPUMemory: any
      • maxSRCCPUMemory: any
      • measurementAngularTolerance: any
      • measurementMaterialDensities: any
      • mouseInvertZoomingDirection: any
      • navigationMode: any
      • navigationSampling: any
      • navigationSpeedFactor: any
      • navigationSpeedThrottleFactor: any
      • notificationLogLevels: any
      • parentSelectEnabled: any
      • preSelectionColor: any
      • preferXHRWithCredentials: any
      • projectionType: any
      • renderAuxOnTop: any
      • renderMode: any
      • renderSetup: any
      • screenSpaceCoverageCalculationMethod: any
      • selectionColor: any
      • sessionDeviceTags: any
      • sessionForwardUrl: any
      • sessionInteractions: any
      • sessionMemberName: any
      • showAuxOnNavigation: any
      • silhouetteEffect: any
      • silhouetteEffectColor: any
      • silhouetteEffectExclusiveEnabled: any
      • skipSslVerify: any
      • slamProviderType: any
      • smallFeatureCulling: any
      • smallFeaturePixelThreshold: any
      • snapshotContentSelection: any
      • soc: any
      • spacemouseMultiplier: any
      • ssaoEnabled: any
      • taaEnabled: any
      • topoGeometryColor: any
      • topoGeometrySecondaryColor: any
      • topoPointsEnabled: any
      • turntableLowerVerticalLimit: any
      • turntableUpperVerticalLimit: any
      • turntableVerticalLimitsEnabled: any
      • uriMap: any
      • useDevicePixelRatio: any
      • vertexColorsEnabled: any
      • viewPerspective: any
      • webglPreserveDrawingbuffer: any
      • xrEnabled: any

    Returns void

importSession

  • Imports a session from the data string of the given format. Supported formats are: JSON.

    Parameters

    • data: any

      the content of the file.

    • Optional format: "xscn"

    Returns Promise<any>

importXRInitTemplate

  • Experimental

    Imports init template for modeltracking. When using Model tracking, Init templates are captured during the tracking process. This initialization data is linked to previously visited view-points along the traveled camera path. Once the tracking is lost the templates are used to quickly reinitialize from similar view-points without the user having to align the line model with the real object.

    Once the init template data is imported. It will stay until enterInitMode with resetInitTemplate set to true is called.

    Only supported if the XRMember has the MODELTRACKER capability.

    The input data can be aquired via exportXRInitTemplate function

    Parameters

    • memberId: number

      the XRMember that the operation should be applied on

    • template: string

    Returns Promise<void>

invertEnabledStates

invertSelection

isColorComparisonActive

  • Checks if the color comparison mode is active.

    Returns boolean

    true if the color comparison mode is active, otherwise false.

isNodeDeletable

  • Parameters

    • nodeID: number

    Returns boolean

    Returns true if a Node is deletable.

isNodePartOfEnabledLayers

  • Returns true if the specified nodeID is part of an enabled Layer.

    Parameters

    • nodeID: number

      The nodeID which should be checked.

    Returns Promise<boolean>

isNodePartOfEnabledVariant

  • Parameters

    • nodeId: number

      The ID of the Node.

    Returns Promise<boolean>

    True, if the Node is Part of an enabled Variant. False otherwise.

isNodeType

  • Parameters

    Returns boolean

    Checks the Node's type for the given Node id.

isOfflineStorageAvailable

isSelected

  • Checks if the specified Node is part of the selection.

    Parameters

    • nodeID: number

      The ID of the node for which we would like to know if it is selected or not.

    Returns Promise<boolean>

    True of the given node is selected, otherwise false.

isTopologySelected

  • Checks if the specified Topology Element is part of the current selection.

    Parameters

    • handle: TopologyHandle

      The topology element which should be checked if it selected.

    Returns boolean

    A boolean value which indicates if the specified Topology Element is part of the current selection or not.

mapInternalToOriginalTopologyHandles

mapOriginalToInternalTopologyHandles

  • Maps the given original topology handles to webvis internal topology handles.

    Parameters

    • nodeID: number

      The Node which specifies the Part the topology relates to.

    • handles: OriginalTopologyHandle[]

      A list of original topology handles.

    Returns Promise<TopologyHandle[]>

    Promise<Array<TopologyHandle|undefined>> - A list of the corresponding webvis internal topology handles.

measureBetween

measureTangent

measureThickness

performExplosion

  • Performs the actual Explosion.

    Parameters

    • explosionFactor: number

      The value by which the parts are expanded.

    Returns void

processInteractionInput

  • Triggers an interaction on the current active interaction mode.

    Parameters

    • interactionData: InteractionData

      Definition of the triggered Interaction.

    Returns void

promoteSessionMember

  • Parameters

    • memberID: number

      The ID of the SessionMember.

    Returns void

    Deprecated

    The whole SessionAPI is under consolidation and will be replaced in a future release.

    Promotes a SessionMember to the Role of the Moderator.

query

  • Executes the query on the specified subtree

    Parameters

    • query: string | Query
    • Optional nodeID: number

    Returns Promise<QueryResult>

readSetting

  • Returns the value of a setting.

    Type Parameters

    • T extends string

    Parameters

    • setting: T

      The name of the setting that should be read

    Returns ContextSettingType<T>

    The value of the specified setting

registerCustomProperty

  • Registering a new custom property.

    Parameters

    • name: string

      The name of the new property.

    • defaultValue: any

      Specifies the default value.

    • Optional recursive: boolean

      Defines whether the property is recursive.

    Returns void

registerFrameListener

  • Registers a listener function which get called once per internal update tick.

    Parameters

    Returns void

registerListener

  • Registers the listener to the node with the matching nodeID and returns the id of the listener. The observeSubTree flag allows to observe the whole subtree under the respective node with the listener. With the eventTypes array, you can specify the types of events the listener should be reacting on. If an empty array is passed, the listener will react on all event types.

    Type Parameters

    Parameters

    • eventTypes: EventType[]

      The kind of events on which the event listener should listen.

    • listener: IEventListener<T>

      The event listener.

    • Optional nodeID: number

      The id of the node on which the event listener should be registered.

    • Optional observeSubTree: boolean

      Indicates whether the event listener should also listen to events in all child nodes. This has an effect on NODE_* events only.

    Returns number

    The id of the event listener.

remove

  • Removes the Node for the given nodeID from the Scene and all related Snapshots. If no nodeID is supplied all Nodes are deleted.

    Parameters

    • Optional nodeID: number | number[]

      The id of the Node that should be removed.

    • Optional safe: boolean

      Performs a safe remove which interrupt the removal process if the Node is part of one or more Snapshots.

    Returns Promise<RemoveState>

removeAnimationFrames

  • Removes an existing animation sequence.

    Parameters

    • name: string

      Specifies the name of the animation frames.

    Returns void

removeAnnotation

  • Removes the Annotation from the scene and all related Snapshots.

    Parameters

    • annotationId: number

      The ID of the Annotation.

    • Optional safe: boolean

      Performs a safe remove which interrupt the removal process if the Annotation is part of one or more Snapshots.

    Returns RemoveState

removeAttachment

  • Removes the Attachment from the scene and all related Snapshots.

    Parameters

    • Optional attachmentID: number

      Specifies the attachment object.

    • Optional safe: boolean

      Performs a safe remove which interrupt the removal process if the Attachment is part of one or more Snapshots.

    Returns RemoveState

removeCapping

  • Experimental

    Removes the generated capping geometry.

    Parameters

    • clipPlaneId: number

      the id of the clip plane

    Returns Promise<void>

removeClipPlane

  • Removes a clip room with the specified id.

    Parameters

    • clipPlaneId: number

      The id of the clip room you want to remove.

    • Optional safe: boolean

      Performs a safe remove which interrupt the removal process if the ClipPlane is part of one or more Snapshots.

    Returns RemoveState

removeClippingRoom

  • Removes the clip room from the scene and all related Snapshots.

    Parameters

    • Optional safe: boolean

      Performs a safe remove which interrupt the removal process if the ClipRoom is part of one or more Snapshots.

    Returns RemoveState

removeCollection

removeDrawing

  • Removes a Drawing with the specified id. If a Drawing is part of a Snapshot the removal will fail with the State REFERENCED_BY_SNAPSHOT

    Parameters

    • drawingId: number

      The id of the to be removed Drawing.

    • Optional safe: boolean

      Performs a safe remove which interrupt the removal process if the Drawing is part of one or more Snapshots.

    Returns RemoveState

removeDrawingPlane

  • Experimental

    Removes a DrawingPlane with the specified ID. If a DrawingPlane is part of a Snapshot the removal will fail with the State REFERENCED_BY_SNAPSHOT.

    Parameters

    • drawingPlaneId: number

      The ID of the Drawing you want to remove.

    • Optional safe: boolean

      Performs a safe remove which interrupt the removal process if the Drawing is part of one or more Snapshots.

    Returns RemoveState

removeFromCollection

  • Removes a node given by nodeID from the collection with id collectionID. If recursive is true, the descendants of the node are also removed.

    Parameters

    • collectionID: number

      Specifies from which collection the node should be removed

    • nodeID: number

      Specifies which node should be removed from the collection

    • Optional recursive: boolean

      Specifies whether the children of the node should be removed from the collection too

    Returns void

removeFromSelection

  • Removes the given nodes from the Selection

    Parameters

    • nodeID: number | number[]

      The ID of the Node that should be removed from the current Selection

    • Optional silent: boolean

      If set to true, no event will be emitted.

    Returns Promise<ChangeSelectionResult>

removeMeasurement

  • Removes the Measurement from the scene and all related Snapshots.

    Parameters

    • measurementID: number
    • Optional safe: boolean

      Performs a safe remove which interrupt the removal process if the Measurement is part of one or more Snapshots.

    Returns RemoveState

removeSessionMember

  • Parameters

    • memberID: number

      The ID of the SessionMember.

    Returns void

    Deprecated

    The whole SessionAPI is under consolidation and will be replaced in a future release.

    Removes a SessionMember from a Session.

removeSnapshot

  • Deletes the Snapshot for given snapshotID.

    Parameters

    • snapshotID: number

    Returns void

removeTopologyFromSelection

  • Removes one or multiple Topology elements to the current selection.

    Parameters

    • handle: TopologyHandle | TopologyHandle[]

      A Topology Element or a list of Topology Elements which should be removed from the current selection.

    Returns Promise<void>

removeViewer

  • Removes a viewer element.

    Parameters

    Returns void

requestActiveSceneVolume

requestAnnotationData

requestAuxRootNodeIds

  • Returns a list of all existing aux root Node ids below the specified subtree.

    Parameters

    • Optional scopeNodeId: number

      Specifies the top one Node id of the subtree to be searched.

    Returns Promise<number[]>

    A list of aux root Node ids.

requestBoxDescriptor

requestClipPlaneData

requestClipRoomData

requestDrawingData

  • Returns the DrawingData for the specified Drawing id.

    Parameters

    • drawingId: number

      The id of the Drawing from which the data is requested.

    Returns Promise<DrawingData>

    The requested Drawing data.

requestFullSceneVolume

requestL3DInformation

  • Returns the L3D information of the specified Node.

    Parameters

    • targetNodeId: number

      Specifies the target Node id.

    Returns Promise<any>

    The L3D information of the specified Node

requestMeasurementData

requestNodeIdsByBoxVolume

  • Returns a List of all Node ids which are included or overlapped by the specified 3D world space Bounding Volume.

    Parameters

    • boxVolume: BoxVolume

      Specifies the 3D world space Bounding Volume.

    • Optional includeOverlappingNodes: boolean

      Specifies that the result should include Nodes which overlap the specified 3D world space Bounding Volume as well.

    • Optional includeDisabledNodes: boolean

      Specifies that the result should include Nodes which are disabled as well.

    • Optional forceExpand: boolean
    • Optional scopeNodeId: number

      Specifies the top one Node id of the subtree to be searched.

    Returns Promise<number[]>

    List of all NodeIds which are included or overlapped by the specified 3D world space Bounding Volume.

requestNodePathHandleMap

  • requestNodePathHandleMap Returns an object mapping from input paths to the respective handles.

    Parameters

    • paths: string[]

      {Array<string | NodePathHandle>} The array of node path strings or handles.

    • Optional scope: number

      {number} [scope=0] nodeID specifying the scope as starting point for the paths

    Returns Promise<NodePathHandleMap>

    The resulting object mapping paths to handles

requestNodePathStrings

  • requestNodePathStrings Returns string representations for the respective node path handles.

    Parameters

    • handles: NodePathHandle[]

      {Array}

    • Optional scope: number

      {number} nodeID specifying the scope as starting point for the path resolution

    • Optional typePriorities: NodePathFragmentType[]

      {Array} Array of priorities to control the fragments for the path string assembly.

    Returns Promise<string[]>

    String representation of the node path for the respective scope.

requestRootNodeIds

  • Returns a list of all existing root Node ids below the specified subtree.

    Parameters

    • Optional scopeNodeId: number

      Specifies the top one Node id of the subtree to be searched.

    • Optional recursive: boolean

      Specifies if the subtree is traversed recursively.

    Returns Promise<number[]>

    A list of root Node ids.

requestServiceStates

requestSnapshotData

requestSupportedContentTypes

requestSupportedRenderSetups

  • Returns Promise<{
        name: string;
        value: string;
    }[]>

    All supported render setups.

requestTopologyDescriptor

requestVariants

  • Parameters

    • nodeId: number

      The ID of the Node.

    Returns Promise<VariantProperties[]>

    The Variant(s) for a given nodeID.

requestXMemberCapabilities

  • Experimental

    Execute whatever is necessary to enable XRCapbilities on the given member, e.g. start the camera or forward to the booster.

    Parameters

    • memberId: number

      The XRMember that the operation should be applied on.

    Returns Promise<boolean>

    Returns a Promise which reports whether the operation was successful or not.

resetAR

  • Returns Promise<boolean>

    returns true if resetting was successfull or false if not

    Deprecated

    Restart modeltracker initialization for the local xr member

resetInteractionMode

  • Sets the current interaction mode back to the Default mode.

    Parameters

    • Optional keepColorCompareActive: boolean

      Specifies if the color comparison mode should stay active. (Default: false)

    Returns void

resetProperties

  • Resets the value of the specified properties on the given Node.

    Type Parameters

    • T extends string

    Parameters

    • nodeID: number

      The id of the Node whose property should be reset.

    • properties: T[]

      List of properties which should be reset.

    • Optional recursive: boolean

      If set to true, the properties are reset recursively.

    Returns Promise<void>

resetProperty

  • Resets the value of the property on the Node with the matching id.

    Type Parameters

    • T extends string

    Parameters

    • nodeID: number

      The id of the Node whose property should be reset.

    • property: T

      Property which should be reset.

    • Optional recursive: boolean

      If set to true, the properties are reset recursively.

    Returns Promise<void>

resetSetting

resetUserSettings

restoreSession

  • Restores a Session for the given access handle from the infrastructure.

    Parameters

    • handle: string

    Returns Promise<void>

restoreSnapshot

  • Restores the Snapshot for the given snapshotID. The settings parameter allows to control the subset of the Snapshot data to be restored.

    Parameters

    Returns Promise<void>

searchByVolume

  • Finds nodes within the given BoxVolume (created using the createBoxVolume() function). If includeOverlappingNodes is false, only nodes fully contained by the box volume are returned. The rootNodeID specifies the node from which the subtree is searched.

    Parameters

    • selectionBox: BoxVolume

      3-dimensional search volume.

    • includeOverlappingNodes: boolean

      Specifies whether the search result contains only those nodes which lie entirely in the search volume or if overlapping nodes are also included.

    • Optional rootNodeID: number

      Restricts the search to a subtree of a node with the given id.

    Returns Promise<number>

    A the id of the created collection of nodes that are fitting the given search criteria.

selectCollection

  • Replaces the current Selection with the Nodes from the given Collection.

    Parameters

    • collectionID: number

      The ID of the Collection.

    • Optional silent: boolean

      If set to true, no event will be emitted.

    Returns Promise<void | ChangeSelectionResult>

setAttachmentData

  • Sets the attachment data.

    Type Parameters

    • T = any

    Parameters

    • Optional attachmentID: number

      Specifies the attachment object.

    • Optional data: T

      The new attachment data.

    Returns void

setAttachmentDataURI

  • Sets the attachment data URI.

    Parameters

    • Optional attachmentID: number

      Specifies the attachment object.

    • Optional dataURI: string

      The attachment data URI.

    Returns void

setInteractionMode

  • Set the current interaction mode.

    Parameters

    • mode: string | string[]

      Specifies the interaction mode you want set.

    • Optional keepColorCompareActive: boolean

      Specifies if the color comparison mode should stay active. (Default: false)

    Returns void

    Deprecated

    Calling setInteractionMode with the mode parameter of type string or string[] is deprecated, please use the InteractionMode enum instead.

  • Set the current interaction mode.

    Parameters

    • mode: InteractionMode

      Specifies the interaction mode you want set.

    • Optional keepColorCompareActive: boolean

      Specifies if the color comparison mode should stay active. (Default: false)

    Returns void

setLayerFilterEnabled

setParent

  • Parameters

    • nodeID: number
    • newParentID: number

    Returns void

setProperty

  • Sets the property named property to value on the Node with id nodeID.

    Type Parameters

    • T extends string

    Parameters

    • nodeID: number | number[]

      The id of the Node whose property has to be set.

    • property: T

      The name of the property that has to be set.

    • value: PropertyType<T>

      The new value of the specified property.

    • Optional silent: boolean

      The silent flag indicates that no NODE_CHANGED event is fired.

    Returns Promise<void>

setSelection

setTopologyProperty

setTopologySelection

setVariantEnabled

  • Enables or disables a given Variant.

    Parameters

    • variant: number

      The ID of the Variant.

    • enabled: boolean

      The enabled state.

    Returns Promise<void>

setXRFusionMode

  • Experimental

    Sets the passed fusion mode for the given XRMember. The fusion mode determines which inputs will be used for the final visualization.

    Parameters

    • memberId: number

      the XRMember that the operation should be applied on

    • xrFusionMode: XRFusionMode

      the fusion mode that should be set

    Returns Promise<boolean>

    returns a Promise which reports whether the operation was successful or not

setXRMemberSettings

  • Experimental

    This will change the XRMemberSettings for the specified XRMember.

    Parameters

    • memberId: number

      The XRMember that the operation should be applied on.

    • settings: XRMemberSettings

      The quality threshold for the modeltracker must be between 0 and 1

    Returns Promise<boolean>

    Returns a Promise which reports whether the operation was successful or not.

showExpertDialog

  • Returns Promise<boolean>

    returns true if the operation was successfull or false if not

    Deprecated

    Show expert dialog for developers or advanced users

shutdownSession

  • Returns Promise<void>

    Deprecated

    The whole SessionAPI is under consolidation and will be replaced in a future release.

    Shuts down a Session and disconnects all joined SessionMembers.

startAR

  • Returns Promise<boolean>

    returns true if starting was successfull or false if it could not start AR

    Deprecated

    Start AR. Projects the camera stream in the background and starts searching for the given reference. The reference is defined by setting the realproperty on the particular node via the webvis API. E.g. webvis.setProperty(0, pluginAPI.realProperty, pluginAPI.realState.Enabled)

startXRMemberSpectate

  • Experimental

    Puts the image stream in the background of the renderer. It will also trigger a XRMemberStateChangedEvent event with FOLLOWING set to true.

    Parameters

    • memberId: number

      The XRMember that the operation should be applied on.

    Returns Promise<boolean>

    Returns a Promise which reports whether the operation was successful or not.

stopAR

  • Returns Promise<boolean>

    returns true if stopping was successfull or false if it could not stop AR

    Deprecated

    Stop AR. Stop projecting the camera stream in the background and reset background to default color.

stopXRMemberSpectate

  • Experimental

    Stops the image stream in the background of the renderer. It will also trigger a XRMemberStateChangedEvent event with FOLLOWING set to false.

    Parameters

    • memberId: number

      The XRMember that the operation should be applied on.

    Returns Promise<boolean>

    Returns a Promise which reports whether the operation was successful or not.

storeSession

  • Temporarily stores the Session in the infrastructure and returns an access handle.

    Parameters

    Returns Promise<string | void>

    The access handle of the stored Session.

transferSession

  • Experimental

    Temporarily transfers the Session to a local storage and returns an access handle.

    Parameters

    Returns Promise<string | void>

    The access handle of the transferred Session.

unfixateXRMember

  • Experimental

    Unfixates the model. The model will move with the device. It will also trigger a XRMemberStateChangedEvent event with FIXATED set to false.

    Parameters

    • memberId: number

      The XRMember that the operation should be applied on.

    Returns Promise<boolean>

    Returns a Promise which reports whether the operation was successful or not.

unregisterFrameListener

unregisterListener

  • Removes the listener for the given listenerID.

    Parameters

    • listenerID: number

      The id of the event listener that should be unregistered.

    Returns void

waitFor

  • Register a callback to a specific state. The callback is executed once when the state is reached. If webVis is already in that state the callback is triggered immediately.

    Parameters

    • state: ContextState

      The state for which a callback is registered

    Returns Promise<void>

    A promise which throws an error if the requested state is invalid

    The following states are allowed as target init - Is reached when webVis is fully configured and set up.
    resourceStateUpdated - Is reached when there is state information available for all resources (This information can also be "still transcoding").
    resourceProcessed - This is triggered when all resources are done transcoding.
    renderingFinished - This is triggered when webVis is done with rendering. So no more image changes are imminent.

Did you find this page useful? Please give it a rating:
★ ★ ★ ★ ★
Thank you for rating this page!
Any issues or feedback?
What kind of problem would you like to report?
Please tell us more about what's wrong: