Interactive Image Object.

Hierarchy (View Summary)

Constructors

Properties

_myObjId: string
_myViewer: OccViewer

Accessors

  • get activeSlice(): number
  • Return image active slice.

    Returns number

  • set activeSlice(theSlice: number): void
  • Set active slice index.

    Parameters

    • theSlice: number

    Returns void

  • get bndBox(): BndBox
  • Get bounding box.

    Returns BndBox

  • get brightness(): number
  • Return image brightness factor; 1.0 by default (no correction).

    Returns number

  • set brightness(theFactor: number): void
  • Set image brightness factor.

    Parameters

    • theFactor: number

    Returns void

  • get caseSide(): string
  • Return case side.

    Returns string

  • get color(): string
  • Return object's global RGB color defined as OccViewer.ColorString

    Returns string

  • set color(theColor: string): void
  • Set object's global color or empty string to unset.

    Parameters

    • theColor: string

    Returns void

  • get depth(): number
  • Return image depth.

    Returns number

  • get gamma(): number
  • Return gamma correction factor; 1.0 by default (no correction).

    Returns number

  • set gamma(theFactor: number): void
  • Set gamma correction factor.

    Parameters

    • theFactor: number

    Returns void

  • get height(): number
  • Return image height.

    Returns number

  • get id(): string
  • Get object id as string.

    Returns string

  • get imageName(): string
  • Return image name.

    Returns string

  • get isExist(): boolean
  • Return TRUE if object with specified Id exists.

    Returns boolean

  • get isLoaded(): boolean
  • Return TRUE if object with specified Id has deferred data loaded.

    Returns boolean

  • get isXRayLateralView(): boolean
  • Get XRay lateral view flag.

    Returns boolean

  • set isXRayLateralView(theIsLateral: boolean): void
  • Set XRay lateral view flag.

    Parameters

    • theIsLateral: boolean

    Returns void

  • get nbAxialSlices(): number
  • Return number if image slices within axial orientation.

    Returns number

  • get nbFrontalSlices(): number
  • Return number if image slices within frontal orientation.

    Returns number

  • get nbSagittalSlices(): number
  • Return number if image slices within sagittal orientation.

    Returns number

  • get nbSlices(): number
  • Return number if image slices within active orientation.

    Returns number

  • get selectable(): boolean
  • Return object's selectable status.

    Returns boolean

  • set selectable(theIsSelectable: boolean): void
  • Set object's selectable status.

    Parameters

    • theIsSelectable: boolean

    Returns void

  • get transparency(): number
  • Return object's transparency within [0.0, 1.0] range, or 0.0 if unspecified.

    Returns number

  • set transparency(theTransp: number): void
  • Set object's global transparency within [0.0, 1.0] range, or 0.0 to unset.

    Parameters

    • theTransp: number

    Returns void

  • set updateViewCameraOnRotation(theViewId: number): void
  • Update the camera of view on axis rotation

    Parameters

    • theViewId: number

    Returns void

  • get visible(): boolean
  • Return object visibility state.

    Returns boolean

  • set visible(theToShow: boolean): void
  • Set object visibility state.

    Parameters

    • theToShow: boolean

    Returns void

  • get visibleInView(): null | Subview
  • Return view in which object is visible or NULL if it is not displayed or displayed in multiple views.

    Returns null | Subview

  • set visibleInView(theView: null | Subview): void
  • Set object to be visible only within specific view or all views (NULL) - view affinity. Note that visible still has to be set independently.

    Parameters

    Returns void

  • get width(): number
  • Return image width.

    Returns number

  • get zLayer(): ZLayerId
  • Return z layer of object.

    Returns ZLayerId

  • set zLayer(theLayer: ZLayerId): void
  • Set z layer of object.

    Parameters

    Returns void

Methods

  • Return slice index closest to specific 3D point, or -1 if point is outside of 3d image.

    Parameters

    Returns number

  • Load deferred data async.

    Returns Promise<boolean>

    FALSE if model cannot be opened

  • Load mask data This method doesn't display the object in the Viewer - OccViewer.InteractiveObject.isVisible=true should be called after loading data completion.

    Parameters

    • theFileUrl: string = ""

      the file URL address to read model from or empty string to load already opened model

    Returns Promise<boolean>

    FALSE if object was not found

  • Load deferred data async.

    Parameters

    • theFilePath: string

      path to file

    Returns Promise<boolean>

    FALSE if model cannot be opened

  • Open object from the given URL and register presentation(s) in the hidden (erased) state. If Interactive Object was created with empty id, it will be generated from the given URL.

    The file will be loaded asynchronously. To remove file from file system you should call OccViewer.unlinkFile if it is no longer needed.

    Depending on the file format, this method might read only a model structure without geometry - see InteractiveImage.loadUrlAsync. Warning! Displaying an object with not yet loaded geometry will produce errors!

    Parameters

    • theFileUrl: string

      the file URL address

    Returns Promise<boolean>

    FALSE if model cannot be opened

  • Open mesh from file path.

    Parameters

    • theFilePath: string

    Returns Promise<boolean>

  • preload file to viewer using url provided

    Parameters

    • theFileUrl: string

    Returns Promise<string>

    path to file