Class OccViewer

constructor

• new OccViewer(theBaseDataPath: string): OccViewer

• Main constructor.

  Parameters

  • theBaseDataPath: string

    path to folder that contains wasm and wasm32 folders with sources

  Returns OccViewer

AIS_RotationMode

AIS_SelectionScheme

Aspect_TypeOfLine

canvas

DisplayMode

Graphic3d_TypeOfLightSource

IObservableCallback

IPromise

Observable

Slice_TypeOfPlane

ViewCorner

ViewManager

animationManager

• get animationManager(): AnimationManager

• Get animation manager.

  Returns AnimationManager

  animation manager

camera

• get camera(): Camera

• Get camera controller - an interface for managing various camera view properties.

  Returns Camera

  camera controller

clippingPlane

• get clippingPlane(): ClippingPlane

• Get clipping plane controller - a global clipping plane object that could be applied to entire view or specific objects. Global clipping plane object is always defined, but disabled by default.

  Returns ClippingPlane

  clipping plane controller.

collisionManager

• get collisionManager(): CollisionManager

• Get collision manager.

  Returns CollisionManager

  collision manager

eventManager

• get eventManager(): EventManager

• Get event manager - an interface for subscribing and unsubscribing to various callbacks (like selection changes).

  Returns EventManager

  selection manager.

explodeView

• get explodeView(): ExplodeViewController

• Get explode view controller - a global explode view object that could be applied to entire view or specific objects. Global explode view object is always defined, but disabled by default.

  Returns ExplodeViewController

  explode view controller.

focusView

• get focusView(): Subview

• Get view object receiving focus.

  Returns Subview

  View object

ground

• get ground(): Ground

• Get ground controller - a manager of a global ground presentation object (hidden by default).

  Returns Ground

  ground controller.

inputBindings

• get inputBindings(): InputBindings

• Get input bindings

  Returns InputBindings

  input bindings object

interactiveContext

• get interactiveContext(): InteractiveContext

• Get Interactive Context - a low-level manager of interactive objects in the Viewer. See also OccViewer.InteractiveObject and it's subclasses for object-oriented interface to this functionality.

  Returns InteractiveContext

  interactive context.

interactiveContourController

• get interactiveContourController(): InteractiveContourController

• Get interactive contour controller

  Returns InteractiveContourController

  interactive contour controller

interactiveLineController

• get interactiveLineController(): InteractiveLineController

• Get interactive line controller

  Returns InteractiveLineController

  interactive line controller

interactivePlaneController

• get interactivePlaneController(): InteractivePlaneController

• Get interactive plane controller - an interface responsible for managing interactive planes.

  Returns InteractivePlaneController

  interactive plane controller

interactivePointController

• get interactivePointController(): InteractivePointController

• Get interactive point controller

  Returns InteractivePointController

  interactive point controller

interactiveRotationButtonController

• get interactiveRotationButtonController(): InteractiveRotationButtonController

• Get interactive line controller

  Returns InteractiveRotationButtonController

  interactive line controller

isMultithreadingMode

• get isMultithreadingMode(): boolean

• Gets multi threading is on; requires WASM module built with pthread support (OccViewer.isAllowMultithreading and OccViewer.isPthreadLoaded.

  Returns boolean
• set isMultithreadingMode(theIsOn: boolean): void

• Enable/disable multi threading; has no effect if loaded WASM module was built without pthread support (OccViewer.isAllowMultithreading and OccViewer.isPthreadLoaded).

  Parameters

  • theIsOn: boolean

  Returns void

isPthreadLoaded

• get isPthreadLoaded(): boolean

• Check if pthread version of viewer is loaded.

  Returns boolean

isWasmLoaded

• get isWasmLoaded(): boolean

• Check if WASM module has been loaded.

  Returns boolean

license

• get license(): License

• Returns License

lights

• get lights(): LightsController

• Get lights controller - an interface for managing list of active light sources and other lighting properties.

  Returns LightsController

  lights controller.

manipulator

• get manipulator(): Manipulator

• Returns manipulator object - an auxiliary presentation object for interactive movements of presentations in the Viewer.

  Returns Manipulator

modelLoader

• get modelLoader(): ModelLoader

• Get model loader - an interface for loading models from various file formats. See also OccViewer.InteractiveMesh for object-oriented interface to this functionality.

  Returns ModelLoader

  model loader.

pmi

• get pmi(): PmiController

• Get PMI controller - a low-level manager of PMI interactive objects. See also OccViewer.TextLabel and OccViewer.LengthDimension for object-oriented interface to PMI functionality.

  Returns PmiController

  PMI controller.

propertyManager

• get propertyManager(): PropertyManager

• Get Property manager - an interface for accessing properties of model objects. See also OccViewer.InteractiveMesh for object-oriented interface to this functionality.

  Returns PropertyManager

  property manager object

rayCast

• get rayCast(): RayCastController

• Get Ray casting controller.

  Returns RayCastController

renderingParams

• get renderingParams(): RenderingParams

• Get renderingParams controller - an interface for querying and changing various rendering properties.

  Returns RenderingParams

  rendering controller

rootView

• get rootView(): Subview

• Get root view object (either main view itself or composer of subviews).

  Returns Subview

  View object

selectionManager

• get selectionManager(): SelectionManager

• Get selection manager - an interface for managing the list of selected objects and various selection properties.

  Returns SelectionManager

  selection manager.

sitmap

• get sitmap(): SitMap

• Gets sitmap controller - an interface for managing sitmap objects.

  Returns SitMap

  sitmap controller.

slicer

• get slicer(): Slicer

• Get Slicer controller - an interface for managing creating slices.

  Returns Slicer

  view cube controller

traceLevel

• get traceLevel(): Message_Gravity

• Get gravity level for logging messages. Consider increasing the level within production application environment to log only critical errors.

  Returns Message_Gravity

  lower message gravity to log
• set traceLevel(theGravity: Message_Gravity): void

• Set gravity level for logging messages.

  Parameters

  • theGravity: Message_Gravity

    lower message gravity to log

  Returns void

viewCube

• get viewCube(): ViewCube

• Get View Cube controller - an interface for managing properties of auxiliary View Cube interactive object displayed at View corner.

  Returns ViewCube

  view cube controller

viewManager

• get viewManager(): ViewManager

• Get subview manager.

  Returns ViewManager

  subview manager object

downloadFile

• downloadFile(
      theFilename: string,
      theBuffer: string | Uint8Array,
      theType?: string,
  ): void

• Download file.

  Parameters

  • theFilename: string

    name of file
  • theBuffer: string | Uint8Array

    buffer to download
  • theType: string = "application/octet-stream"

    MIME type of file

  Returns void

getModule

• getModule(moduleName: string): IModule

• Return module by name.

  Parameters

  • moduleName: string

  Returns IModule

init

• init(): Promise<void>

• Init OccViewer Module and load WASM file.

  Returns Promise<void>

isAllowMultithreading

• isAllowMultithreading(): boolean

• Check if multithreading is allowed.

  Returns boolean

isWasmSupported

• isWasmSupported(): boolean

• Check browser support.

  Returns boolean

  TRUE if WASM supported

isWebGLSupported

• isWebGLSupported(): boolean

• Check browser support for WebGL.

  Returns boolean

  TRUE if WebGL supported

locateFile

• locateFile(thePath: string, thePrefix: string): string

• Callback returning file path for loading WebAssembly components.

  Parameters

  • thePath: string

    file path to locate
  • thePrefix: string

    default file prefix

  Returns string

  full path to the resource

makeScreenshot

• makeScreenshot(
      theFilename: string,
      theWidth: number,
      theHeight: number,
      theViewId?: number,
      theIsGrayscale?: boolean,
  ): boolean

• Make screenshot and download.

  Parameters

  • theFilename: string

    of screenshot which will be downloaded
  • theWidth: number

    of screenshot (-1 - take size of canvas)
  • theHeight: number

    of screenshot (-1 - take size of canvas)
  • theViewId: number = -1

    view ID (-1 for active view)
  • theIsGrayscale: boolean = false

    final image will be in grayscale (false as default)

  Returns boolean

  true if success

makeScreenshotImage

• makeScreenshotImage(
      theWidth: number,
      theHeight: number,
      theViewId?: number,
      theIsGrayscale?: boolean,
      theToBase64?: boolean,
  ): null | string | Uint8Array

• Make screenshot image.

  Parameters

  • theWidth: number

    of screenshot (-1 - take size of canvas)
  • theHeight: number

    of screenshot (-1 - take size of canvas)
  • theViewId: number = -1

    view ID (-1 for active view)
  • theIsGrayscale: boolean = false

    final image will be in grayscale (false as default)
  • theToBase64: boolean = false

    return image as base64 string (false as default)

  Returns null | string | Uint8Array

  Uint8Array or base64 string of image or null if failed

pickPoint

• pickPoint(
      theX: number,
      theY: number,
      theToStickToPickRay: boolean,
      theView?: null | Subview,
  ): null | WasmVector3d

• Pick 3d point by 2d coordinates and store.

  Parameters

  • theX: number

    x coordinate of canvas
  • theY: number

    y coordinate of canvas
  • theToStickToPickRay: boolean

    when TRUE, the result point will lie on picking ray
  • theView: null | Subview = null

    view to pick in (null for main view)

  Returns null | WasmVector3d

  3d coordinate or null in case if nothing picked

printMessage

• printMessage(theText: string, theGravity: Message_Gravity): void

• C++ Message::Send() callback redirecting to Terminal.

  Parameters

  • theText: string

    text to print
  • theGravity: Message_Gravity

    message gravity within 0..4 range

  Returns void

registerFontFromUrl

• registerFontFromUrl(
      theFontURl: string,
      theFontName?: string,
      theToOverride?: boolean,
  ): Promise<void>

• Register font (file in TTF format). This should be done before displaying text labels using this font, otherwise a fallback font will be used instead.

  Parameters

  • theFontURl: string
  • theFontName: string = ""

    font name or empty string to keep name from file itself
  • theToOverride: boolean = false

    override existing font family

  Returns Promise<void>

resize

• resize(): void

• Resize rendering window.

  Returns void

updateCanvasOffset

• updateCanvasOffset(): void

• Update Offset of canvas relative to window.

  Returns void

updateView

• updateView(): void

• Update View.

  Returns void

StaticonInit

• onInit(aFunc: (aViewer: OccViewer) => void): void

• Parameters

  • aFunc: (aViewer: OccViewer) => void

  Returns void