Represents interactive 3D point / marker.

Hierarchy (View Summary)

Constructors

Properties

_myObjId: string
_myViewer: OccViewer

Accessors

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

    Returns BndBox

  • 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 height(): number
  • Return height.

    Returns number

  • set height(theHeight: number): void
  • Set height

    Parameters

    • theHeight: number

    Returns void

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

    Returns string

  • set imageFilePath(theFilePath: string): void
  • Open image from given preloaded file. file should be preloaded with ModelLoader::uploadUrl or ModelLoader::preloadFile. theFilePath should contain correct image extension.

    Parameters

    • theFilePath: string

      path to image file.

    Returns void

  • 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 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 size(): number
  • Return point size.

    Returns number

  • set size(theSize: number): void
  • Set point size.

    Parameters

    • theSize: number

    Returns void

  • get thickness(): number
  • Return thickness.

    Returns number

  • set thickness(theThickness: number): void
  • Set thickness

    Parameters

    • theThickness: number

    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

  • get useBoundBox(): boolean
  • Get if point has a defined bound box (for example: for camera fitting.)

    Returns boolean

  • set useBoundBox(theUseBoundBox: boolean): void
  • Set if point has a defined bound box (for example: for camera fitting.)

    Parameters

    • theUseBoundBox: boolean

    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 zLayer(): ZLayerId
  • Return z layer of object.

    Returns ZLayerId

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

    Parameters

    Returns void

Methods

  • Load image from given url asynchronously.

    Parameters

    • theFileUrl: string

      url to image file.

    Returns Promise<void>