Request

Response

    Core

    Autodesk.Viewing.ScreenModeDelegate

    new ScreenModeDelegate(viewer)

    Virtual base class for screen mode manipulation.

    Derive from this class and use it to allow viewer to go full screen.

    Parameters

    viewer*Viewer instance.
    * Required

    Methods

    doScreenModeChange(oldMode,newMode)

    Override this method to make the screen mode change occur.

    Parameters

    oldMode*
    Autodesk.Viewing.ScreenMode
    Old screen mode.
    newMode*
    Autodesk.Viewing.ScreenMode
    New screen mode.
    * Required

    fullscreenEventListener()

    Full screen event listener.

    getEscapeMode()

    Return new screen mode on escape.

    Returns

    TypeDescription
    Autodesk.Viewing.ScreenMode|undefined New screen mode or undefined if no change.

    getMode()

    Override this method to get the current screen mode.

    Returns

    TypeDescription
    Autodesk.Viewing.ScreenMode Current screen mode.

    getNextMode()

    Return next screen mode in sequence. Depending on what modes are supported, this may be a toggle or a 3-state.

    Returns

    TypeDescription
    Autodesk.Viewing.ScreenMode|undefined Next screen mode in sequence or undefined if no change.

    isModeSupported(mode)

    Is screen mode supported? Returning false for normal mode means no screen mode changes are supported.

    Parameters

    mode*
    Autodesk.Viewing.ScreenMode
    Desired screen mode.
    * Required

    Returns

    TypeDescription
    boolean True if screen mode is supported.

    onScreenModeChanged(oldMode,newMode)

    Called after the screen mode changes.

    Parameters

    oldMode*
    Autodesk.Viewing.ScreenMode
    Old screen mode.
    newMode*
    Autodesk.Viewing.ScreenMode
    New screen mode.
    * Required

    setMode(mode)

    Set new screen mode.

    Parameters

    mode*
    Autodesk.Viewing.ScreenMode
    New screen mode.
    * Required

    Returns

    TypeDescription
    boolean True if screen mode was changed.

    uninitialize()

    Perform any cleanup required for a ScreenModeDelegate instance.