Options
All
  • Public
  • Public/Protected
  • All
Menu

Viewer

Index

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

EventResponseMapping

EventResponseMapping: { camera.end: ICameraEvent; camera.move: ICameraEvent; camera.start: ICameraEvent; output.updated: IOutputEvent; rendering.beautyRenderingFinished: IViewportEvent; scene.boundingBoxChange: ISceneEvent; scene.boundingBoxEmpty: ISceneEvent; session.closed: ISessionEvent; session.created: ISessionEvent; session.customized: ISessionEvent; session.initialOutputsLoaded: ISessionEvent; task.cancel: ITaskEvent; task.end: ITaskEvent; task.process: ITaskEvent; task.start: ITaskEvent; viewport.busy.off: IViewportEvent; viewport.busy.on: IViewportEvent; viewport.closed: IViewportEvent; viewport.created: IViewportEvent; viewport.hidden: IViewportEvent; viewport.updated: IViewportEvent; viewport.visible: IViewportEvent }

Type declaration

MainEventTypes

MainEventTypes: typeof EVENTTYPE_CAMERA | typeof EVENTTYPE_OUTPUT | typeof EVENTTYPE_RENDERING | typeof EVENTTYPE_SCENE | typeof EVENTTYPE_SESSION | typeof EVENTTYPE_VIEWPORT | typeof EVENTTYPE_INTERACTION | typeof EVENTTYPE_TASK

SDTF_TYPEHINT

SDTF_TYPEHINT: typeof SDTF_TYPEHINT[keyof typeof SDTF_TYPEHINT]

SessionCreationDefinition

SessionCreationDefinition: { modelViewUrl: string; excludeViewports?: string[]; guid?: string; id?: string; initialParameterValues?: {}; jwtToken?: string; loadOutputs?: boolean; ticket?: string; waitForOutputs?: boolean }

Type declaration

  • modelViewUrl: string

    The modelViewUrl of the ShapeDiver Geometry Backend hosting the model.

  • Optional excludeViewports?: string[]

    Option to exclude some viewports from the start. Can be accessed via {@link ISessionexcludeViewports}.

  • Optional guid?: string

    The geometry backend model id (guid). This identifies the model on the Geometry Backend. A jwtToken is needed for authentication. If no guid was provided, a ticket has to be provided instead.

  • Optional id?: string

    The unique identifier of the session that was specified or automatically chosen on creation of the session.

  • Optional initialParameterValues?: {}

    The initial set of parameter values to use. Map from parameter id to parameter value. The default value will be used for any parameter not specified.

    • [key: string]: string
  • Optional jwtToken?: string

    The JWT used for authorizing API calls to the Geometry Backend.

  • Optional loadOutputs?: boolean

    Option to load the outputs, or not load them until the first call of {@link ISessioncustomize}. (default: true)

  • Optional ticket?: string

    The ticket for direct embedding of the model represented by the session. This identifies the model on the Geometry Backend. If no ticket was provided, a guid has to be provided instead.

  • Optional waitForOutputs?: boolean

    Option to wait for the outputs to be loaded, or return immediately after creation of the session. (default: true)

ShapeDiverResponseExportDefinitionGroup

ShapeDiverResponseExportDefinitionGroup: ShapeDiverCommonsGroup

Group information of an export definition.

ShapeDiverResponseModelComputationStatus

ShapeDiverResponseModelComputationStatus: typeof ShapeDiverResponseModelComputationStatus[keyof typeof ShapeDiverResponseModelComputationStatus]

ViewportCreationDefinition

ViewportCreationDefinition: { branding?: { backgroundColor?: string; busyModeDisplay?: BUSY_MODE_DISPLAY; busyModeSpinner?: string; logo?: string | null; spinnerPositioning?: SPINNER_POSITIONING }; canvas?: HTMLCanvasElement; id?: string; sessionSettingsId?: string; sessionSettingsMode?: SESSION_SETTINGS_MODE; visibility?: VISIBILITY_MODE }

Type declaration

  • Optional branding?: { backgroundColor?: string; busyModeDisplay?: BUSY_MODE_DISPLAY; busyModeSpinner?: string; logo?: string | null; spinnerPositioning?: SPINNER_POSITIONING }

    The branding options of the viewport.

    • Optional backgroundColor?: string

      Optional background color to show while the viewport is hidden, can include alpha channel. A default color will be used if none is provided.

    • Optional busyModeDisplay?: BUSY_MODE_DISPLAY

      The mode used to indicate that the viewport is busy. (default: BUSY_MODE_DISPLAY.SPINNER) Whenever the busy mode gets toggled, the events EVENTTYPE_VIEWPORT.BUSY_MODE_ON and EVENTTYPE_VIEWPORT.BUSY_MODE_OFF will be emitted.

    • Optional busyModeSpinner?: string

      Optional URL to a logo to be displayed while the viewport is in busy mode. A default logo will be used if none is provided. The positioning of the spinner can be influenced via SPINNER_POSITIONING.

    • Optional logo?: string | null

      Optional URL to a logo to be displayed while the viewport is hidden. A default logo will be used if none is provided. Supply null to display no logo at all.

    • Optional spinnerPositioning?: SPINNER_POSITIONING

      Where the spinner that is specified by BUSY_MODE_DISPLAY is desplayed on the screen. (default: BUSY_MODE_DISPLAY.BOTTOM_RIGHT)

  • Optional canvas?: HTMLCanvasElement

    The canvas element in which the viewport should be created, it is encourage to provide one. If none was provided, a canvas will be created.

  • Optional id?: string

    The unique identifier of the session that was specified or automatically chosen on creation of the viewport.

  • Optional sessionSettingsId?: string

    The id of the session of which the settings should be used. Only works when sessionSettingsMode is set to {@link SESSION_SETTINGS_MODE.SESSION}.

  • Optional sessionSettingsMode?: SESSION_SETTINGS_MODE

    The mode in which settings should be applied. (default: SESSION_SETTINGS_MODE.FIRST)

  • Optional visibility?: VISIBILITY_MODE

    The initial visibility of the viewport. (default: VISIBILITY_MODE.SESSION)

Variables

Const EVENTTYPE

EVENTTYPE: { CAMERA: typeof EVENTTYPE_CAMERA; INTERACTION: typeof EVENTTYPE_INTERACTION; OUTPUT: typeof EVENTTYPE_OUTPUT; RENDERING: typeof EVENTTYPE_RENDERING; SCENE: typeof EVENTTYPE_SCENE; SESSION: typeof EVENTTYPE_SESSION; TASK: typeof EVENTTYPE_TASK; VIEWPORT: typeof EVENTTYPE_VIEWPORT }

Type declaration

Const SDTF_TYPEHINT

SDTF_TYPEHINT: { BOOLEAN: SdtfPrimitiveTypeHintName.BOOLEAN; CHAR: SdtfPrimitiveTypeHintName.CHAR; COLOR: SdtfPrimitiveTypeHintName.COLOR; DATA: SdtfPrimitiveTypeHintName.DATA; DECIMAL: SdtfPrimitiveTypeHintName.DECIMAL; DOUBLE: SdtfPrimitiveTypeHintName.DOUBLE; GEOMETRY_ARC: SdtfGeometryTypeHintName.GEOMETRY_ARC; GEOMETRY_BOUNDING_BOX: SdtfGeometryTypeHintName.GEOMETRY_BOUNDING_BOX; GEOMETRY_BOX: SdtfGeometryTypeHintName.GEOMETRY_BOX; GEOMETRY_CIRCLE: SdtfGeometryTypeHintName.GEOMETRY_CIRCLE; GEOMETRY_COMPLEX: SdtfGeometryTypeHintName.GEOMETRY_COMPLEX; GEOMETRY_CONE: SdtfGeometryTypeHintName.GEOMETRY_CONE; GEOMETRY_CYLINDER: SdtfGeometryTypeHintName.GEOMETRY_CYLINDER; GEOMETRY_ELLIPSE: SdtfGeometryTypeHintName.GEOMETRY_ELLIPSE; GEOMETRY_INTERVAL: SdtfGeometryTypeHintName.GEOMETRY_INTERVAL; GEOMETRY_INTERVAL2: SdtfGeometryTypeHintName.GEOMETRY_INTERVAL2; GEOMETRY_LINE: SdtfGeometryTypeHintName.GEOMETRY_LINE; GEOMETRY_MATRIX: SdtfGeometryTypeHintName.GEOMETRY_MATRIX; GEOMETRY_PLANE: SdtfGeometryTypeHintName.GEOMETRY_PLANE; GEOMETRY_POINT: SdtfGeometryTypeHintName.GEOMETRY_POINT; GEOMETRY_POINT2D: SdtfGeometryTypeHintName.GEOMETRY_POINT2D; GEOMETRY_POINT3D: SdtfGeometryTypeHintName.GEOMETRY_POINT3D; GEOMETRY_POINT4D: SdtfGeometryTypeHintName.GEOMETRY_POINT4D; GEOMETRY_POLYLINE: SdtfGeometryTypeHintName.GEOMETRY_POLYLINE; GEOMETRY_RAY: SdtfGeometryTypeHintName.GEOMETRY_RAY; GEOMETRY_RECTANGLE: SdtfGeometryTypeHintName.GEOMETRY_RECTANGLE; GEOMETRY_SPHERE: SdtfGeometryTypeHintName.GEOMETRY_SPHERE; GEOMETRY_TORUS: SdtfGeometryTypeHintName.GEOMETRY_TORUS; GEOMETRY_TRANSFORM: SdtfGeometryTypeHintName.GEOMETRY_TRANSFORM; GEOMETRY_TRANSFORM_LIST: SdtfGeometryTypeHintName.GEOMETRY_TRANSFORM_LIST; GEOMETRY_VECTOR: SdtfGeometryTypeHintName.GEOMETRY_VECTOR; GEOMETRY_VECTOR2D: SdtfGeometryTypeHintName.GEOMETRY_VECTOR2D; GEOMETRY_VECTOR3D: SdtfGeometryTypeHintName.GEOMETRY_VECTOR3D; GEOMETRY_VECTOR4D: SdtfGeometryTypeHintName.GEOMETRY_VECTOR4D; GRASSHOPPER_PATH: SdtfGrasshopperTypeHintName.GRASSHOPPER_PATH; GUID: SdtfPrimitiveTypeHintName.GUID; IMAGE: SdtfPrimitiveTypeHintName.IMAGE; INT16: SdtfPrimitiveTypeHintName.INT16; INT32: SdtfPrimitiveTypeHintName.INT32; INT64: SdtfPrimitiveTypeHintName.INT64; INT8: SdtfPrimitiveTypeHintName.INT8; JSON: SdtfPrimitiveTypeHintName.JSON; RHINO_ARC_CURVE: SdtfRhinoTypeHintName.RHINO_ARC_CURVE; RHINO_BREP: SdtfRhinoTypeHintName.RHINO_BREP; RHINO_CURVE: SdtfRhinoTypeHintName.RHINO_CURVE; RHINO_EXTRUSION: SdtfRhinoTypeHintName.RHINO_EXTRUSION; RHINO_LINE_CURVE: SdtfRhinoTypeHintName.RHINO_LINE_CURVE; RHINO_MESH: SdtfRhinoTypeHintName.RHINO_MESH; RHINO_NURBS_CURVE: SdtfRhinoTypeHintName.RHINO_NURBS_CURVE; RHINO_NURBS_SURFACE: SdtfRhinoTypeHintName.RHINO_NURBS_SURFACE; RHINO_PLANE_SURFACE: SdtfRhinoTypeHintName.RHINO_PLANE_SURFACE; RHINO_POINT: SdtfRhinoTypeHintName.RHINO_POINT; RHINO_POLYLINE_CURVE: SdtfRhinoTypeHintName.RHINO_POLYLINE_CURVE; RHINO_POLY_CURVE: SdtfRhinoTypeHintName.RHINO_POLY_CURVE; RHINO_REV_SURFACE: SdtfRhinoTypeHintName.RHINO_REV_SURFACE; RHINO_SUBD: SdtfRhinoTypeHintName.RHINO_SUBD; RHINO_SURFACE: SdtfRhinoTypeHintName.RHINO_SURFACE; SINGLE: SdtfPrimitiveTypeHintName.SINGLE; STRING: SdtfPrimitiveTypeHintName.STRING; UINT16: SdtfPrimitiveTypeHintName.UINT16; UINT32: SdtfPrimitiveTypeHintName.UINT32; UINT64: SdtfPrimitiveTypeHintName.UINT64; UINT8: SdtfPrimitiveTypeHintName.UINT8 }

Type declaration

  • BOOLEAN: SdtfPrimitiveTypeHintName.BOOLEAN
  • CHAR: SdtfPrimitiveTypeHintName.CHAR
  • COLOR: SdtfPrimitiveTypeHintName.COLOR
  • DATA: SdtfPrimitiveTypeHintName.DATA
  • DECIMAL: SdtfPrimitiveTypeHintName.DECIMAL
  • DOUBLE: SdtfPrimitiveTypeHintName.DOUBLE
  • GEOMETRY_ARC: SdtfGeometryTypeHintName.GEOMETRY_ARC
  • GEOMETRY_BOUNDING_BOX: SdtfGeometryTypeHintName.GEOMETRY_BOUNDING_BOX
  • GEOMETRY_BOX: SdtfGeometryTypeHintName.GEOMETRY_BOX
  • GEOMETRY_CIRCLE: SdtfGeometryTypeHintName.GEOMETRY_CIRCLE
  • GEOMETRY_COMPLEX: SdtfGeometryTypeHintName.GEOMETRY_COMPLEX
  • GEOMETRY_CONE: SdtfGeometryTypeHintName.GEOMETRY_CONE
  • GEOMETRY_CYLINDER: SdtfGeometryTypeHintName.GEOMETRY_CYLINDER
  • GEOMETRY_ELLIPSE: SdtfGeometryTypeHintName.GEOMETRY_ELLIPSE
  • GEOMETRY_INTERVAL: SdtfGeometryTypeHintName.GEOMETRY_INTERVAL
  • GEOMETRY_INTERVAL2: SdtfGeometryTypeHintName.GEOMETRY_INTERVAL2
  • GEOMETRY_LINE: SdtfGeometryTypeHintName.GEOMETRY_LINE
  • GEOMETRY_MATRIX: SdtfGeometryTypeHintName.GEOMETRY_MATRIX
  • GEOMETRY_PLANE: SdtfGeometryTypeHintName.GEOMETRY_PLANE
  • GEOMETRY_POINT: SdtfGeometryTypeHintName.GEOMETRY_POINT
  • GEOMETRY_POINT2D: SdtfGeometryTypeHintName.GEOMETRY_POINT2D
  • GEOMETRY_POINT3D: SdtfGeometryTypeHintName.GEOMETRY_POINT3D
  • GEOMETRY_POINT4D: SdtfGeometryTypeHintName.GEOMETRY_POINT4D
  • GEOMETRY_POLYLINE: SdtfGeometryTypeHintName.GEOMETRY_POLYLINE
  • GEOMETRY_RAY: SdtfGeometryTypeHintName.GEOMETRY_RAY
  • GEOMETRY_RECTANGLE: SdtfGeometryTypeHintName.GEOMETRY_RECTANGLE
  • GEOMETRY_SPHERE: SdtfGeometryTypeHintName.GEOMETRY_SPHERE
  • GEOMETRY_TORUS: SdtfGeometryTypeHintName.GEOMETRY_TORUS
  • GEOMETRY_TRANSFORM: SdtfGeometryTypeHintName.GEOMETRY_TRANSFORM
  • GEOMETRY_TRANSFORM_LIST: SdtfGeometryTypeHintName.GEOMETRY_TRANSFORM_LIST
  • GEOMETRY_VECTOR: SdtfGeometryTypeHintName.GEOMETRY_VECTOR
  • GEOMETRY_VECTOR2D: SdtfGeometryTypeHintName.GEOMETRY_VECTOR2D
  • GEOMETRY_VECTOR3D: SdtfGeometryTypeHintName.GEOMETRY_VECTOR3D
  • GEOMETRY_VECTOR4D: SdtfGeometryTypeHintName.GEOMETRY_VECTOR4D
  • GRASSHOPPER_PATH: SdtfGrasshopperTypeHintName.GRASSHOPPER_PATH
  • GUID: SdtfPrimitiveTypeHintName.GUID
  • IMAGE: SdtfPrimitiveTypeHintName.IMAGE
  • INT16: SdtfPrimitiveTypeHintName.INT16
  • INT32: SdtfPrimitiveTypeHintName.INT32
  • INT64: SdtfPrimitiveTypeHintName.INT64
  • INT8: SdtfPrimitiveTypeHintName.INT8
  • JSON: SdtfPrimitiveTypeHintName.JSON
  • RHINO_ARC_CURVE: SdtfRhinoTypeHintName.RHINO_ARC_CURVE
  • RHINO_BREP: SdtfRhinoTypeHintName.RHINO_BREP
  • RHINO_CURVE: SdtfRhinoTypeHintName.RHINO_CURVE
  • RHINO_EXTRUSION: SdtfRhinoTypeHintName.RHINO_EXTRUSION
  • RHINO_LINE_CURVE: SdtfRhinoTypeHintName.RHINO_LINE_CURVE
  • RHINO_MESH: SdtfRhinoTypeHintName.RHINO_MESH
  • RHINO_NURBS_CURVE: SdtfRhinoTypeHintName.RHINO_NURBS_CURVE
  • RHINO_NURBS_SURFACE: SdtfRhinoTypeHintName.RHINO_NURBS_SURFACE
  • RHINO_PLANE_SURFACE: SdtfRhinoTypeHintName.RHINO_PLANE_SURFACE
  • RHINO_POINT: SdtfRhinoTypeHintName.RHINO_POINT
  • RHINO_POLYLINE_CURVE: SdtfRhinoTypeHintName.RHINO_POLYLINE_CURVE
  • RHINO_POLY_CURVE: SdtfRhinoTypeHintName.RHINO_POLY_CURVE
  • RHINO_REV_SURFACE: SdtfRhinoTypeHintName.RHINO_REV_SURFACE
  • RHINO_SUBD: SdtfRhinoTypeHintName.RHINO_SUBD
  • RHINO_SURFACE: SdtfRhinoTypeHintName.RHINO_SURFACE
  • SINGLE: SdtfPrimitiveTypeHintName.SINGLE
  • STRING: SdtfPrimitiveTypeHintName.STRING
  • UINT16: SdtfPrimitiveTypeHintName.UINT16
  • UINT32: SdtfPrimitiveTypeHintName.UINT32
  • UINT64: SdtfPrimitiveTypeHintName.UINT64
  • UINT8: SdtfPrimitiveTypeHintName.UINT8

Const ShapeDiverResponseModelComputationStatus

ShapeDiverResponseModelComputationStatus: { CHECK_CONFIRMED: ShapeDiverCommonsModelComputationStatus.CHECK_CONFIRMED; CHECK_DENIED: ShapeDiverCommonsModelComputationStatus.CHECK_DENIED; CHECK_PENDING: ShapeDiverCommonsModelComputationStatus.CHECK_PENDING; MAX_ASSET_PARTS_EXCEEDED: ShapeDiverCommonsModelComputationStatus.MAX_ASSET_PARTS_EXCEEDED; MAX_ASSET_PARTS_PER_OUTPUT_EXCEEDED: ShapeDiverCommonsModelComputationStatus.MAX_ASSET_PARTS_PER_OUTPUT_EXCEEDED; MAX_COMBINED_ASSET_SIZE_EXCEEDED: ShapeDiverCommonsModelComputationStatus.MAX_COMBINED_ASSET_SIZE_EXCEEDED; MAX_DB_SIZE_PER_OUTPUT_EXCEEDED: ShapeDiverCommonsModelComputationStatus.MAX_DB_SIZE_PER_OUTPUT_EXCEEDED; MAX_PARTS_EXCEEDED: ShapeDiverCommonsModelComputationStatus.MAX_PARTS_EXCEEDED; MAX_PARTS_PER_OUTPUT_EXCEEDED: ShapeDiverCommonsModelComputationStatus.MAX_PARTS_PER_OUTPUT_EXCEEDED; MAX_TRANSFORMATIONS_PER_OUTPUT_EXCEEDED: ShapeDiverCommonsModelComputationStatus.MAX_TRANSFORMATIONS_PER_OUTPUT_EXCEEDED; MODEL_WITHOUT_GEOMETRY_OUTPUT: ShapeDiverCommonsModelComputationStatus.MODEL_WITHOUT_GEOMETRY_OUTPUT; NO_OUTPUT_DATA_FOR_DEFAULT_PARAMETER_VALUES: ShapeDiverCommonsModelComputationStatus.NO_OUTPUT_DATA_FOR_DEFAULT_PARAMETER_VALUES; RECOVERABLE_ERROR: ShapeDiverCommonsModelComputationStatus.RECOVERABLE_ERROR; SUCCESS: ShapeDiverCommonsModelComputationStatus.SUCCESS; TIMEOUT: ShapeDiverCommonsModelComputationStatus.TIMEOUT; UNKNOWN: ShapeDiverCommonsModelComputationStatus.UNKNOWN; UNRECOVERABLE_ERROR: ShapeDiverCommonsModelComputationStatus.UNRECOVERABLE_ERROR }

Result of a computation request.

Type declaration

  • CHECK_CONFIRMED: ShapeDiverCommonsModelComputationStatus.CHECK_CONFIRMED
  • CHECK_DENIED: ShapeDiverCommonsModelComputationStatus.CHECK_DENIED
  • CHECK_PENDING: ShapeDiverCommonsModelComputationStatus.CHECK_PENDING
  • MAX_ASSET_PARTS_EXCEEDED: ShapeDiverCommonsModelComputationStatus.MAX_ASSET_PARTS_EXCEEDED
  • MAX_ASSET_PARTS_PER_OUTPUT_EXCEEDED: ShapeDiverCommonsModelComputationStatus.MAX_ASSET_PARTS_PER_OUTPUT_EXCEEDED
  • MAX_COMBINED_ASSET_SIZE_EXCEEDED: ShapeDiverCommonsModelComputationStatus.MAX_COMBINED_ASSET_SIZE_EXCEEDED
  • MAX_DB_SIZE_PER_OUTPUT_EXCEEDED: ShapeDiverCommonsModelComputationStatus.MAX_DB_SIZE_PER_OUTPUT_EXCEEDED
  • MAX_PARTS_EXCEEDED: ShapeDiverCommonsModelComputationStatus.MAX_PARTS_EXCEEDED
  • MAX_PARTS_PER_OUTPUT_EXCEEDED: ShapeDiverCommonsModelComputationStatus.MAX_PARTS_PER_OUTPUT_EXCEEDED
  • MAX_TRANSFORMATIONS_PER_OUTPUT_EXCEEDED: ShapeDiverCommonsModelComputationStatus.MAX_TRANSFORMATIONS_PER_OUTPUT_EXCEEDED
  • MODEL_WITHOUT_GEOMETRY_OUTPUT: ShapeDiverCommonsModelComputationStatus.MODEL_WITHOUT_GEOMETRY_OUTPUT
  • NO_OUTPUT_DATA_FOR_DEFAULT_PARAMETER_VALUES: ShapeDiverCommonsModelComputationStatus.NO_OUTPUT_DATA_FOR_DEFAULT_PARAMETER_VALUES
  • RECOVERABLE_ERROR: ShapeDiverCommonsModelComputationStatus.RECOVERABLE_ERROR
  • SUCCESS: ShapeDiverCommonsModelComputationStatus.SUCCESS
  • TIMEOUT: ShapeDiverCommonsModelComputationStatus.TIMEOUT
  • UNKNOWN: ShapeDiverCommonsModelComputationStatus.UNKNOWN
  • UNRECOVERABLE_ERROR: ShapeDiverCommonsModelComputationStatus.UNRECOVERABLE_ERROR

Const generalOptions

generalOptions: IGeneralOptions = ...

General Viewer options that are used everywhere.

  • loggingLevel: The logging level that is used.
  • showMessages: Option to show/hide messages in the browser console.
  • parallelGlTFProcessing: The number of glTFs that are downloaded and processed at the same time.
  • consoleBranding: When set to false, the branding in the viewer console will be limited to a single line.
  • caching: Caching Options.

Const sceneTree

sceneTree: ITree = Tree.instance

The scene tree that is used to store the scene. The scene tree contains a unique node and child nodes for each session, and can also be used to add your own nodes.

Const sessions

sessions: {} = {}

The sessions that are currently being used.

Type declaration

Const version

version: string = ...

The version of the viewer.

Const viewports

viewports: {} = {}

The viewports that are currently being used.

Type declaration

Functions

addListener

  • Adds an event listener.

    Parameters

    Returns string

createSession

  • Create and initialize a session with a model hosted on a ShapeDiver Geometry Backend, using the provided ticket/guid and modelViewUrl. Returns a session api object allowing to control the session.

    A JWT can be specified for authorizing the API calls to the Geometry Backend. The model's settings on the Geometry Backend might require a JWT to be provided.

    By default the outputs of the model for its default parameter values will be loaded.

    An optional identifier for the session can be provided. This identifier can be used to retrieve the api object from sessions. In case no identifier is provided, a unique one will be generated.

    Parameters

    Returns Promise<ISessionApi>

createViewport

  • Create and initialize a viewport with the provided type and canvas, and return a viewport api object allowing to control it.

    An optional identifier for the viewport can be provided. This identifier can be used to retrieve the viewport object from viewports. In case no identifier is provided, a unique one will be generated.

    By default a new viewport displays the complete scene tree. Viewports can be excluded from displaying geometry for specific sessions by using the excludeViewports property of ISessionApi.

    Parameters

    Returns Promise<IViewportApi>

isARError

isViewerCameraError

isViewerDataProcessingError

isViewerEnvironmentMapError

isViewerError

  • Type guard for all error types of the viewer package.

    Parameters

    • e: any

    Returns e is ShapeDiverViewerError

isViewerGeometryBackendError

isViewerGeometryBackendGenericError

isViewerGeometryBackendRequestError

isViewerGeometryBackendResponseError

isViewerInteractionError

isViewerLightError

isViewerSessionError

isViewerSettingsError

isViewerUnknownError

isViewerValidationError

isViewerViewportError

isViewerWebGLError

removeListener

  • removeListener(id: string): boolean

  • Removes an event listener.

    Parameters

    • id: string

      The id of the listener.

    Returns boolean