Interface ViewManager

Represents manager for subviews. See also OccViewer.viewManager property.

interface ViewManager {
    subviews: Subview[];
    createSubview(theSize: WasmVector2d): number;
    fitAllAuto(theViewId: number, theIsAuto: boolean): void;
    fitAllObjects(
        theViewId: number,
        theAuto: boolean,
        theToUpdate: boolean,
    ): void;
    fitMinMax(
        theViewId: number,
        theMin: WasmVector3d,
        theMax: WasmVector3d,
    ): void;
    fitObjects(theViewId: number, theNames: string, theToUpdate: boolean): void;
    getInputFocus(theViewId: number): number;
    getMaxCamDistanceMultiplier(theViewId: number): number;
    getOrbitAcceleration(): number;
    getPerspectiveProjectionFOVy(theViewId: number): number;
    getRotationMode(): AIS_RotationMode;
    getSubviewBackgroundColor(theViewId: number): string;
    getSubviewBorderColor(): string;
    getSubviewCorner(theViewId: number): ViewCorner;
    getSubviewMargins(theViewId: number): WasmVector2d;
    getSubviewOffset(theViewId: number): WasmVector2d;
    getSubviewSize(theViewId: number): WasmVector2d;
    getViewPoint(theViewId: number): WasmCameraParams;
    hasInputFocus(theViewId: number): boolean;
    isActive(theViewId: number): boolean;
    isDefined(theViewId: number): boolean;
    isFullscreen(): boolean;
    isPerspectiveProjection(theViewId: number): boolean;
    isSubviewComposer(theViewId: number): boolean;
    isSubviewFullscreen(theViewId: number): boolean;
    removeAllSubviews(): void;
    removeSubview(theViewId: number): void;
    setActive(theViewId: number, theActive: boolean): void;
    setAllowPanning(theViewId: number, theToAllow: boolean): void;
    setAllowRotation(theViewId: number, theToAllow: boolean): void;
    setAllowZooming(theViewId: number, theToAllow: boolean): void;
    setFullscreen(theToEnable: boolean): void;
    setInputFocus(theViewId: number): void;
    setLockOrbitZUp(theViewId: number, theToLock: boolean): void;
    setMaxCamDistanceMultiplier(theViewId: number, theMax: number): void;
    setOrbitAcceleration(theAccel: number): void;
    setOrientation(
        theViewId: number,
        theOrientation: V3d_TypeOfOrientation,
    ): void;
    setPerspectiveProjection(theViewId: number, theIsPersp: boolean): void;
    setPerspectiveProjectionFOVy(theViewId: number, theFovy: number): void;
    setRotationMode(theMode: AIS_RotationMode): void;
    setSubviewBackgroundColor(theViewId: number, theBgColor: string): void;
    setSubviewBorderColor(theColor: string): void;
    setSubviewComposer(theViewId: number, theActive: boolean): void;
    setSubviewCorner(theViewId: number, theCorner: ViewCorner): void;
    setSubviewFullscreen(theViewId: number, theToEnable: boolean): void;
    setSubviewMargins(theViewId: number, theMargins: WasmVector2d): void;
    setSubviewOffset(theViewId: number, theOffset: WasmVector2d): void;
    setSubviewSize(theViewId: number, theSize: WasmVector2d): void;
    setViewPoint(theViewId: number, theParams: WasmCameraParams): void;
    toAllowPanning(theViewId: number): boolean;
    toAllowRotation(theViewId: number): boolean;
    toAllowZooming(theViewId: number): boolean;
    toLockOrbitZUp(theViewId: number): boolean;
}

Properties

subviews

Methods

createSubview fitAllAuto fitAllObjects fitMinMax fitObjects getInputFocus getMaxCamDistanceMultiplier getOrbitAcceleration getPerspectiveProjectionFOVy getRotationMode getSubviewBackgroundColor getSubviewBorderColor getSubviewCorner getSubviewMargins getSubviewOffset getSubviewSize getViewPoint hasInputFocus isActive isDefined isFullscreen isPerspectiveProjection isSubviewComposer isSubviewFullscreen removeAllSubviews removeSubview setActive setAllowPanning setAllowRotation setAllowZooming setFullscreen setInputFocus setLockOrbitZUp setMaxCamDistanceMultiplier setOrbitAcceleration setOrientation setPerspectiveProjection setPerspectiveProjectionFOVy setRotationMode setSubviewBackgroundColor setSubviewBorderColor setSubviewComposer setSubviewCorner setSubviewFullscreen setSubviewMargins setSubviewOffset setSubviewSize setViewPoint toAllowPanning toAllowRotation toAllowZooming toLockOrbitZUp

Properties

Readonlysubviews

subviews: Subview[]

Return the array of created subviews

Methods

createSubview

  • createSubview(theSize: WasmVector2d): number

  • Set new subview size and return it's id.

    Parameters

    Returns number

fitAllAuto

  • fitAllAuto(theViewId: number, theIsAuto: boolean): void

  • Fit selected or fit all visible objects into view.

    Parameters

    • theViewId: number
    • theIsAuto: boolean

    Returns void

fitAllObjects

  • fitAllObjects(theViewId: number, theAuto: boolean, theToUpdate: boolean): void

  • Fit all/selected objects into view.

    Parameters

    • theViewId: number
    • theAuto: boolean

      fit selected objects (TRUE) or all objects (FALSE)

    • theToUpdate: boolean

      viewer update flag

    Returns void

fitMinMax

fitObjects

  • fitObjects(theViewId: number, theNames: string, theToUpdate: boolean): void

  • Fit given objects into view.

    Parameters

    • theViewId: number
    • theNames: string

      names of objects to fit or special cases ("*" -> fitAll) ("" -> fitAuto (if something selected - fit selected or fit all))

    • theToUpdate: boolean

      viewer update flag

    Returns void

getInputFocus

  • getInputFocus(theViewId: number): number

  • Return id of view that receives input focus.

    Parameters

    • theViewId: number

    Returns number

getMaxCamDistanceMultiplier

  • getMaxCamDistanceMultiplier(theViewId: number): number

  • Max camera distance multiplier; when it equals 0 or negative then disable the max zoom limit.

    Parameters

    • theViewId: number

    Returns number

getOrbitAcceleration

  • getOrbitAcceleration(): number

  • Orbit acceleration coefficient.

    Returns number

getPerspectiveProjectionFOVy

  • getPerspectiveProjectionFOVy(theViewId: number): number

  • Perspective projection FOVy in degrees.

    Parameters

    • theViewId: number

    Returns number

getRotationMode

getSubviewBackgroundColor

  • getSubviewBackgroundColor(theViewId: number): string

  • Return subview background color.

    Parameters

    • theViewId: number

    Returns string

getSubviewBorderColor

  • getSubviewBorderColor(): string

  • Get subview border color (color filling in margins between all subviews).

    Returns string

getSubviewCorner

  • getSubviewCorner(theViewId: number): ViewCorner

  • Return subview corner.

    Parameters

    • theViewId: number

    Returns ViewCorner

getSubviewMargins

  • getSubviewMargins(theViewId: number): WasmVector2d

  • Return subview margins defined in pixels.

    Parameters

    • theViewId: number

    Returns WasmVector2d

getSubviewOffset

  • getSubviewOffset(theViewId: number): WasmVector2d

  • Return subview offset from corner, defined as a fraction of main canvas.

    Parameters

    • theViewId: number

    Returns WasmVector2d

getSubviewSize

  • getSubviewSize(theViewId: number): WasmVector2d

  • Return subview size, defined as a fraction of main canvas.

    Parameters

    • theViewId: number

    Returns WasmVector2d

getViewPoint

hasInputFocus

  • hasInputFocus(theViewId: number): boolean

  • Return TRUE if view with specified OccViewer.ViewId receives input focus.

    Parameters

    • theViewId: number

    Returns boolean

isActive

  • isActive(theViewId: number): boolean

  • Return TRUE if view with specified OccViewer.ViewId is active (displayed on the screen).

    Parameters

    • theViewId: number

    Returns boolean

isDefined

  • isDefined(theViewId: number): boolean

  • Return TRUE if view with specified OccViewer.ViewId exists.

    Parameters

    • theViewId: number

    Returns boolean

isFullscreen

  • isFullscreen(): boolean

  • Return fullscreen mode, when canvas (with all Subviews) occupies entire screen. See also ViewManager.isSubviewFullscreen.

    Returns boolean

isPerspectiveProjection

  • isPerspectiveProjection(theViewId: number): boolean

  • Switch perspective/orthographic projection.

    Parameters

    • theViewId: number

    Returns boolean

isSubviewComposer

  • isSubviewComposer(theViewId: number): boolean

  • Return TRUE if view with specified OccViewer.ViewId serves as a composer to subviews.

    Parameters

    • theViewId: number

    Returns boolean

isSubviewFullscreen

  • isSubviewFullscreen(theViewId: number): boolean

  • Return subview fullscreen mode.

    Parameters

    • theViewId: number

    Returns boolean

removeAllSubviews

  • removeAllSubviews(): void

  • Remove all subview.

    Returns void

removeSubview

  • removeSubview(theViewId: number): void

  • Remove subview.

    Parameters

    • theViewId: number

    Returns void

setActive

  • setActive(theViewId: number, theActive: boolean): void

  • Set view OccViewer.ViewId active state.

    Parameters

    • theViewId: number
    • theActive: boolean

    Returns void

setAllowPanning

  • setAllowPanning(theViewId: number, theToAllow: boolean): void

  • Allow/disallow camera panning.

    Parameters

    • theViewId: number
    • theToAllow: boolean

    Returns void

setAllowRotation

  • setAllowRotation(theViewId: number, theToAllow: boolean): void

  • Allow/disallow camera rotation.

    Parameters

    • theViewId: number
    • theToAllow: boolean

    Returns void

setAllowZooming

  • setAllowZooming(theViewId: number, theToAllow: boolean): void

  • Allow/disallow camera zooming.

    Parameters

    • theViewId: number
    • theToAllow: boolean

    Returns void

setFullscreen

  • setFullscreen(theToEnable: boolean): void

  • Set fullscreen mode; WARNING! This should be called in combination with user gesture (mouse click / button click) in browser!

    Parameters

    • theToEnable: boolean

    Returns void

setInputFocus

  • setInputFocus(theViewId: number): void

  • Set view with specified OccViewer.ViewId to receive input focus.

    Parameters

    • theViewId: number

    Returns void

setLockOrbitZUp

  • setLockOrbitZUp(theViewId: number, theToLock: boolean): void

  • Set if camera up orientation should be forced Z up.

    Parameters

    • theViewId: number
    • theToLock: boolean

    Returns void

setMaxCamDistanceMultiplier

  • setMaxCamDistanceMultiplier(theViewId: number, theMax: number): void

  • Set max camera distance multiplier.

    Parameters

    • theViewId: number
    • theMax: number

    Returns void

setOrbitAcceleration

  • setOrbitAcceleration(theAccel: number): void

  • Orbit acceleration coefficient.

    Parameters

    • theAccel: number

    Returns void

setOrientation

setPerspectiveProjection

  • setPerspectiveProjection(theViewId: number, theIsPersp: boolean): void

  • Switch perspective/orthographic projection.

    Parameters

    • theViewId: number
    • theIsPersp: boolean

    Returns void

setPerspectiveProjectionFOVy

  • setPerspectiveProjectionFOVy(theViewId: number, theFovy: number): void

  • Perspective projection FOVy in degrees.

    Parameters

    • theViewId: number
    • theFovy: number

    Returns void

setRotationMode

setSubviewBackgroundColor

  • setSubviewBackgroundColor(theViewId: number, theBgColor: string): void

  • Set subview background color.

    Parameters

    • theViewId: number
    • theBgColor: string

    Returns void

setSubviewBorderColor

  • setSubviewBorderColor(theColor: string): void

  • Set subview border color.

    Parameters

    • theColor: string

    Returns void

setSubviewComposer

  • setSubviewComposer(theViewId: number, theActive: boolean): void

  • Set if view with specified OccViewer.ViewId should serve as a composer to subviews.

    Parameters

    • theViewId: number
    • theActive: boolean

    Returns void

setSubviewCorner

  • setSubviewCorner(theViewId: number, theCorner: ViewCorner): void

  • Set subview corner.

    Parameters

    Returns void

setSubviewFullscreen

  • setSubviewFullscreen(theViewId: number, theToEnable: boolean): void

  • Set subview fullscreen mode.

    Parameters

    • theViewId: number
    • theToEnable: boolean

    Returns void

setSubviewMargins

  • setSubviewMargins(theViewId: number, theMargins: WasmVector2d): void

  • Set subview margins .

    Parameters

    Returns void

setSubviewOffset

  • setSubviewOffset(theViewId: number, theOffset: WasmVector2d): void

  • Set subview offset from corner.

    Parameters

    Returns void

setSubviewSize

  • setSubviewSize(theViewId: number, theSize: WasmVector2d): void

  • Set subview size.

    Parameters

    Returns void

setViewPoint

  • setViewPoint(theViewId: number, theParams: WasmCameraParams): void

  • Set camera view point parameters.

    Parameters

    Returns void

toAllowPanning

  • toAllowPanning(theViewId: number): boolean

  • Allow/disallow camera panning.

    Parameters

    • theViewId: number

    Returns boolean

toAllowRotation

  • toAllowRotation(theViewId: number): boolean

  • Allow/disallow camera rotation.

    Parameters

    • theViewId: number

    Returns boolean

toAllowZooming

  • toAllowZooming(theViewId: number): boolean

  • Allow/disallow camera zooming.

    Parameters

    • theViewId: number

    Returns boolean

toLockOrbitZUp

  • toLockOrbitZUp(theViewId: number): boolean

  • Get/set if camera up orientation within AIS_NavigationMode_Orbit rotation mode should be forced Z up.

    Parameters

    • theViewId: number

    Returns boolean

Settings

Member Visibility

On This Page

Properties
Methods
createSubviewfitAllAutofitAllObjectsfitMinMaxfitObjectsgetInputFocusgetMaxCamDistanceMultipliergetOrbitAccelerationgetPerspectiveProjectionFOVygetRotationModegetSubviewBackgroundColorgetSubviewBorderColorgetSubviewCornergetSubviewMarginsgetSubviewOffsetgetSubviewSizegetViewPointhasInputFocusisActiveisDefinedisFullscreenisPerspectiveProjectionisSubviewComposerisSubviewFullscreenremoveAllSubviewsremoveSubviewsetActivesetAllowPanningsetAllowRotationsetAllowZoomingsetFullscreensetInputFocussetLockOrbitZUpsetMaxCamDistanceMultipliersetOrbitAccelerationsetOrientationsetPerspectiveProjectionsetPerspectiveProjectionFOVysetRotationModesetSubviewBackgroundColorsetSubviewBorderColorsetSubviewComposersetSubviewCornersetSubviewFullscreensetSubviewMarginssetSubviewOffsetsetSubviewSizesetViewPointtoAllowPanningtoAllowRotationtoAllowZoomingtoLockOrbitZUp