Subview definition - a region in canvas for displaying 3D viewer content.

Hierarchy

  • EventTarget
    • Subview

Constructors

  • Empty constructor.

    Parameters

    • theViewId: number = -2

    Returns Subview

Accessors

  • get camera(): Camera
  • Return camera controller.

    Returns Camera

  • get hasInputFocus(): boolean
  • Return TRUE if view receives input focus.

    Returns boolean

  • get id(): number
  • Get view id as OccViewer.ViewId; -2 is invalid id, -1 refers to a view receiving input focus.

    Returns number

  • get isActive(): boolean
  • Return TRUE if view is active (displayed on the screen).

    Returns boolean

  • set isActive(theActive: boolean): void
  • Set view active state.

    Parameters

    • theActive: boolean

    Returns void

  • get isDefined(): boolean
  • Return TRUE if view with specified Id exists.

    Returns boolean

  • get isSubviewComposer(): boolean
  • Return TRUE if view serves as a composer to subviews.

    Returns boolean

  • set isSubviewComposer(theComposer: boolean): void
  • Set view composer state.

    Parameters

    • theComposer: boolean

    Returns void

  • get isSubviewFullscreen(): boolean
  • Return TRUE if subview should fill entire canvas (replaces all subviews).

    Returns boolean

  • set isSubviewFullscreen(theToEnable: boolean): void
  • Set if subview should fill entire canvas (replace all subviews) or not.

    Parameters

    • theToEnable: boolean

    Returns void

  • get subviewBackgroundColor(): string
  • Get subview background color.

    Returns string

  • set subviewBackgroundColor(theBgColor: string): void
  • Set subview background color.

    Parameters

    • theBgColor: string

    Returns void

  • get subviewOffset(): WasmVector2d
  • Return subview offset from the corner as a fraction to canvas dimensions.

    Returns WasmVector2d

  • set subviewOffset(theOffset: WasmVector2d): void
  • Set subview offset.

    Parameters

    Returns void

Methods

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    MDN Reference

    Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optionaloptions: boolean | AddEventListenerOptions

    Returns void

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    Parameters

    • event: Event

    Returns boolean

  • Remove subview.

    Returns void

  • Removes the event listener in target's event listener list with the same type, callback, and options.

    MDN Reference

    Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optionaloptions: boolean | EventListenerOptions

    Returns void

  • Set this view to receive input focus.

    Returns void

  • Wrap existing view.

    Parameters

    • theViewer: OccViewer

      viewer module

    • theId: number = -2

      the id to wrap

    Returns boolean

    FALSE if view with specified Id doesn't exist in the Viewer