Class sap.ui.vk.ViewerModule: sap/ui/vk/Viewer

extends Control

Provides simple 3D visualization capability by connecting, configuring and presenting the essential Visualization Toolkit controls a single composite control.

Experimental API:Since 1.32.0 This class is experimental and might be modified or removed in future versions.

Constructor Summary
new sap.ui.vk.Viewer(sId?, mSettings?)Constructor for a new Viewer.
Event Summary
contentResourceChangesProcessed(oControlEvent)This event will be fired when any content resource or the contentResources aggregation has been changed and processed.
fullScreen(oControlEvent)This event is fired when viewer enters/exits full screen mode.
sceneDestroying(oControlEvent)This event will be fired when scene / image loaded in Viewer is about to be destroyed.
sceneLoadingFailed(oControlEvent)This event will be fired when a critical error occurs during scene / image loading.
sceneLoadingSucceeded(oControlEvent)This event will be fired when a scene / image has been loaded into the Viewer.
selectionChanged(oControlEvent)This event is fired when the nodes are selected/unselected.
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.vk.Viewer.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vk.Viewer with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.vk.Viewer.getMetadata()Returns a metadata object for class sap.ui.vk.Viewer.
addContentResource(oContentResource)Adds some contentResource to the aggregation contentResources.
attachContentResourceChangesProcessed(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the contentResourceChangesProcessed event of this sap.ui.vk.Viewer.
attachFullScreen(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the fullScreen event of this sap.ui.vk.Viewer.
attachSceneDestroying(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the sceneDestroying event of this sap.ui.vk.Viewer.
attachSceneLoadingFailed(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the sceneLoadingFailed event of this sap.ui.vk.Viewer.
attachSceneLoadingSucceeded(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the sceneLoadingSucceeded event of this sap.ui.vk.Viewer.
attachSelectionChanged(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the selectionChanged event of this sap.ui.vk.Viewer.
destroyContentResources()Destroys all the contentResources in the aggregation contentResources.
destroyOverlay()Destroys the overlay in the aggregation overlay.
detachContentResourceChangesProcessed(fnFunction, oListener)Detaches event handler fnFunction from the contentResourceChangesProcessed event of this sap.ui.vk.Viewer.
detachFullScreen(fnFunction, oListener)Detaches event handler fnFunction from the fullScreen event of this sap.ui.vk.Viewer.
detachSceneDestroying(fnFunction, oListener)Detaches event handler fnFunction from the sceneDestroying event of this sap.ui.vk.Viewer.
detachSceneLoadingFailed(fnFunction, oListener)Detaches event handler fnFunction from the sceneLoadingFailed event of this sap.ui.vk.Viewer.
detachSceneLoadingSucceeded(fnFunction, oListener)Detaches event handler fnFunction from the sceneLoadingSucceeded event of this sap.ui.vk.Viewer.
detachSelectionChanged(fnFunction, oListener)Detaches event handler fnFunction from the selectionChanged event of this sap.ui.vk.Viewer.
fireContentResourceChangesProcessed(mArguments?)Fires event contentResourceChangesProcessed to attached listeners.
fireFullScreen(mArguments?)Fires event fullScreen to attached listeners.
fireSceneDestroying(mArguments?)Fires event sceneDestroying to attached listeners.
fireSceneLoadingFailed(mArguments?)Fires event sceneLoadingFailed to attached listeners.
fireSceneLoadingSucceeded(mArguments?)Fires event sceneLoadingSucceeded to attached listeners.
fireSelectionChanged(mArguments?)Fires event selectionChanged to attached listeners.
getContentResources()Gets content of aggregation contentResources.
getEnableFullScreen()Gets current value of property enableFullScreen.
getEnableNotifications()Gets current value of property enableNotifications.
getEnableOverlay()Gets current value of property enableOverlay.
getEnableProgressIndicator()Gets current value of property enableProgressIndicator.
getEnableSceneTree()Gets current value of property enableSceneTree.
getEnableStepNavigation()Gets current value of property enableStepNavigation.
getEnableToolbar()Gets current value of property enableToolbar.
getGraphicsCore()Gets the GraphicsCore object.
getHeight()Gets current value of property height.
getNativeViewport()Gets the 2D viewport used for displaying format natively supported by the browser - 2D images etc.
getOverlay()Gets content of aggregation overlay.
getScene()Gets the Scene currently loaded in the Viewer control.
getShowSceneTree()Gets current value of property showSceneTree.
getShowStepNavigation()Gets current value of property showStepNavigation.
getShowStepNavigationThumbnails()Gets current value of property showStepNavigationThumbnails.
getToolbarTitle()Gets current value of property toolbarTitle.
getViewport()Gets the 3D viewport.
getViewStateManager()Gets the view state manager object used for handling visibility and selection of nodes.
getWidth()Gets current value of property width.
indexOfContentResource(oContentResource)Checks for the provided sap.ui.vk.ContentResource in the aggregation contentResources.
insertContentResource(oContentResource, iIndex)Inserts a contentResource into the aggregation contentResources.
removeAllContentResources()Removes all the controls from the aggregation contentResources.
removeContentResource(vContentResource)Removes a contentResource from the aggregation contentResources.
setEnableFullScreen(bEnableFullScreen)Sets a new value for property enableFullScreen.
setEnableNotifications(bEnableNotifications)Sets a new value for property enableNotifications.
setEnableOverlay(bEnableOverlay)Sets a new value for property enableOverlay.
setEnableProgressIndicator(bEnableProgressIndicator)Sets a new value for property enableProgressIndicator.
setEnableSceneTree(bEnableSceneTree)Sets a new value for property enableSceneTree.
setEnableStepNavigation(bEnableStepNavigation)Sets a new value for property enableStepNavigation.
setEnableToolbar(bEnableToolbar)Sets a new value for property enableToolbar.
setHeight(sHeight)Sets a new value for property height.
setOverlay(oOverlay)Sets the aggregated overlay.
setShowSceneTree(bShowSceneTree)Sets a new value for property showSceneTree.
setShowStepNavigation(bShowStepNavigation)Sets a new value for property showStepNavigation.
setShowStepNavigationThumbnails(bShowStepNavigationThumbnails)Sets a new value for property showStepNavigationThumbnails.
setToolbarTitle(sToolbarTitle)Sets a new value for property toolbarTitle.
setWidth(sWidth)Sets a new value for property width.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.ui.vk.Viewer(sId?, mSettings?)
Constructor for a new Viewer. Besides the settings documented below, Viewer itself supports the following special settings:
  • runtimeSettings: object Optional Emscripten runtime module settings. A JSON object with the following properties:
    • totalMemory: int (default: 128 * 1024 * 1024) size of Emscripten module memory in bytes.
    • logElementId: string ID of a textarea DOM element to write the log to.
    • statusElementId: string ID of a DOM element to write the status messages to.
  • webGLContextAttributes: object Optional WebGL context attributes. A JSON object with the following boolean properties:
    • antialias: boolean (default: true) If set to true, the context will attempt to perform antialiased rendering if possible.
    • alpha: boolean (default: true) If set to true, the context will have an alpha (transparency) channel.
    • premultipliedAlpha: boolean (default: false) If set to true, the color channels in the framebuffer will be stored premultiplied by the alpha channel to improve performance.
    Other WebGL context attributes are also supported.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:
{string}sId? ID for the new Viewer control, generated automatically if no ID is given
{object}mSettings? initial settings for the new Viewer control
Event Detail
contentResourceChangesProcessed(oControlEvent)
This event will be fired when any content resource or the contentResources aggregation has been changed and processed.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
fullScreen(oControlEvent)
This event is fired when viewer enters/exits full screen mode.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{boolean}oControlEvent.getParameters.isFullScreen true: entered full screen; false: exited full screen.
sceneDestroying(oControlEvent)
This event will be fired when scene / image loaded in Viewer is about to be destroyed.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.vk.Scene}oControlEvent.getParameters.scene Returns a reference to the scene to be destroyed.
sceneLoadingFailed(oControlEvent)
This event will be fired when a critical error occurs during scene / image loading.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
sceneLoadingSucceeded(oControlEvent)
This event will be fired when a scene / image has been loaded into the Viewer.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.vk.Scene}oControlEvent.getParameters.scene Returns a reference to the loaded Scene.
selectionChanged(oControlEvent)
This event is fired when the nodes are selected/unselected.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{string[]}oControlEvent.getParameters.selected IDs of newly selected nodes.
{string[]}oControlEvent.getParameters.unselected IDs of newly unselected nodes.
Method Detail
sap.ui.vk.Viewer.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.vk.Viewer with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.ui.vk.Viewer.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.vk.Viewer.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addContentResource(oContentResource): sap.ui.vk.Viewer
Adds some contentResource to the aggregation contentResources.
Parameters:
{sap.ui.vk.ContentResource}oContentResource the contentResource to add; if empty, nothing is inserted
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
attachContentResourceChangesProcessed(oData?, fnFunction, oListener?): sap.ui.vk.Viewer
Attaches event handler fnFunction to the contentResourceChangesProcessed event of this sap.ui.vk.Viewer.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vk.Viewer itself.

This event will be fired when any content resource or the contentResources aggregation has been changed and processed.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.vk.Viewer itself
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
attachFullScreen(oData?, fnFunction, oListener?): sap.ui.vk.Viewer
Attaches event handler fnFunction to the fullScreen event of this sap.ui.vk.Viewer.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vk.Viewer itself.

This event is fired when viewer enters/exits full screen mode.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.vk.Viewer itself
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
attachSceneDestroying(oData?, fnFunction, oListener?): sap.ui.vk.Viewer
Attaches event handler fnFunction to the sceneDestroying event of this sap.ui.vk.Viewer.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vk.Viewer itself.

This event will be fired when scene / image loaded in Viewer is about to be destroyed.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.vk.Viewer itself
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
attachSceneLoadingFailed(oData?, fnFunction, oListener?): sap.ui.vk.Viewer
Attaches event handler fnFunction to the sceneLoadingFailed event of this sap.ui.vk.Viewer.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vk.Viewer itself.

This event will be fired when a critical error occurs during scene / image loading.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.vk.Viewer itself
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
attachSceneLoadingSucceeded(oData?, fnFunction, oListener?): sap.ui.vk.Viewer
Attaches event handler fnFunction to the sceneLoadingSucceeded event of this sap.ui.vk.Viewer.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vk.Viewer itself.

This event will be fired when a scene / image has been loaded into the Viewer.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.vk.Viewer itself
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
attachSelectionChanged(oData?, fnFunction, oListener?): sap.ui.vk.Viewer
Attaches event handler fnFunction to the selectionChanged event of this sap.ui.vk.Viewer.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vk.Viewer itself.

This event is fired when the nodes are selected/unselected.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.vk.Viewer itself
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
destroyContentResources(): sap.ui.vk.Viewer
Destroys all the contentResources in the aggregation contentResources.
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
destroyOverlay(): sap.ui.vk.Viewer
Destroys the overlay in the aggregation overlay.
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
detachContentResourceChangesProcessed(fnFunction, oListener): sap.ui.vk.Viewer
Detaches event handler fnFunction from the contentResourceChangesProcessed event of this sap.ui.vk.Viewer.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
detachFullScreen(fnFunction, oListener): sap.ui.vk.Viewer
Detaches event handler fnFunction from the fullScreen event of this sap.ui.vk.Viewer.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
detachSceneDestroying(fnFunction, oListener): sap.ui.vk.Viewer
Detaches event handler fnFunction from the sceneDestroying event of this sap.ui.vk.Viewer.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
detachSceneLoadingFailed(fnFunction, oListener): sap.ui.vk.Viewer
Detaches event handler fnFunction from the sceneLoadingFailed event of this sap.ui.vk.Viewer.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
detachSceneLoadingSucceeded(fnFunction, oListener): sap.ui.vk.Viewer
Detaches event handler fnFunction from the sceneLoadingSucceeded event of this sap.ui.vk.Viewer.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
detachSelectionChanged(fnFunction, oListener): sap.ui.vk.Viewer
Detaches event handler fnFunction from the selectionChanged event of this sap.ui.vk.Viewer.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
fireContentResourceChangesProcessed(mArguments?): sap.ui.vk.Viewer
Fires event contentResourceChangesProcessed to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
fireFullScreen(mArguments?): sap.ui.vk.Viewer
Fires event fullScreen to attached listeners.

Expects the following event parameters:

  • isFullScreen of type booleantrue: entered full screen; false: exited full screen.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
fireSceneDestroying(mArguments?): sap.ui.vk.Viewer
Fires event sceneDestroying to attached listeners.

Expects the following event parameters:

  • scene of type sap.ui.vk.SceneReturns a reference to the scene to be destroyed.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
fireSceneLoadingFailed(mArguments?): sap.ui.vk.Viewer
Fires event sceneLoadingFailed to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
fireSceneLoadingSucceeded(mArguments?): sap.ui.vk.Viewer
Fires event sceneLoadingSucceeded to attached listeners.

Expects the following event parameters:

  • scene of type sap.ui.vk.SceneReturns a reference to the loaded Scene.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
fireSelectionChanged(mArguments?): sap.ui.vk.Viewer
Fires event selectionChanged to attached listeners.

Expects the following event parameters:

  • selected of type string[]IDs of newly selected nodes.
  • unselected of type string[]IDs of newly unselected nodes.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
getContentResources(): sap.ui.vk.ContentResource[]
Gets content of aggregation contentResources.

Content resources to load and display in the Viewer control.

Returns:
{sap.ui.vk.ContentResource[]}
getEnableFullScreen(): boolean
Gets current value of property enableFullScreen.

Enable / disable full screen mode

Default value is false.

Returns:
{boolean} Value of property enableFullScreen
getEnableNotifications(): boolean
Gets current value of property enableNotifications.

Disables the Message Popover Control

Default value is true.

Returns:
{boolean} Value of property enableNotifications
getEnableOverlay(): boolean
Gets current value of property enableOverlay.

Enables or disables the Overlay control

Default value is false.

Returns:
{boolean} Value of property enableOverlay
getEnableProgressIndicator(): boolean
Gets current value of property enableProgressIndicator.

Enable / disable progress indicator for downloading and rendering VDS files

Default value is true.

Returns:
{boolean} Value of property enableProgressIndicator
getEnableSceneTree(): boolean
Gets current value of property enableSceneTree.

Disables the scene tree control Button on the menu

Default value is true.

Returns:
{boolean} Value of property enableSceneTree
getEnableStepNavigation(): boolean
Gets current value of property enableStepNavigation.

Disables the Step Navigation Control Button on the menu

Default value is true.

Returns:
{boolean} Value of property enableStepNavigation
getEnableToolbar(): boolean
Gets current value of property enableToolbar.

Shows or hides Toolbar control

Default value is true.

Returns:
{boolean} Value of property enableToolbar
getGraphicsCore(): sap.ui.vk.GraphicsCore
Gets the GraphicsCore object.
Returns:
{sap.ui.vk.GraphicsCore} The GraphicsCore object.
getHeight(): sap.ui.core.CSSSize
Gets current value of property height.

Height of the Viewer control

Default value is auto.

Returns:
{sap.ui.core.CSSSize} Value of property height
getNativeViewport(): sap.ui.vk.NativeViewport
Gets the 2D viewport used for displaying format natively supported by the browser - 2D images etc.
Returns:
{sap.ui.vk.NativeViewport} The 2D viewport.
getOverlay(): sap.ui.vk.Overlay
Gets content of aggregation overlay.
Returns:
{sap.ui.vk.Overlay}
getScene(): sap.ui.vk.Scene
Gets the Scene currently loaded in the Viewer control.
Returns:
{sap.ui.vk.Scene} The scene loaded in the control.
getShowSceneTree(): boolean
Gets current value of property showSceneTree.

Shows or hides the scene tree control

Default value is true.

Returns:
{boolean} Value of property showSceneTree
getShowStepNavigation(): boolean
Gets current value of property showStepNavigation.

Shows or hides the Step Navigation Control

Default value is false.

Returns:
{boolean} Value of property showStepNavigation
getShowStepNavigationThumbnails(): boolean
Gets current value of property showStepNavigationThumbnails.

Shows or hides the Step Navigation thumbnails

Default value is true.

Returns:
{boolean} Value of property showStepNavigationThumbnails
getToolbarTitle(): string
Gets current value of property toolbarTitle.

The toolbar title

Default value is .

Returns:
{string} Value of property toolbarTitle
getViewport(): sap.ui.vk.Viewport
Gets the 3D viewport.
Returns:
{sap.ui.vk.Viewport} The 3D viewport.
getViewStateManager(): sap.ui.vk.ViewStateManager
Gets the view state manager object used for handling visibility and selection of nodes.
Returns:
{sap.ui.vk.ViewStateManager} The view state manager object.
getWidth(): sap.ui.core.CSSSize
Gets current value of property width.

Width of the Viewer control

Default value is auto.

Returns:
{sap.ui.core.CSSSize} Value of property width
indexOfContentResource(oContentResource): int
Checks for the provided sap.ui.vk.ContentResource in the aggregation contentResources. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.vk.ContentResource}oContentResource The contentResource whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertContentResource(oContentResource, iIndex): sap.ui.vk.Viewer
Inserts a contentResource into the aggregation contentResources.
Parameters:
{sap.ui.vk.ContentResource}oContentResource the contentResource to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the contentResource should be inserted at; for a negative value of iIndex, the contentResource is inserted at position 0; for a value greater than the current size of the aggregation, the contentResource is inserted at the last position
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
removeAllContentResources(): sap.ui.vk.ContentResource[]
Removes all the controls from the aggregation contentResources.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.vk.ContentResource[]} An array of the removed elements (might be empty)
removeContentResource(vContentResource): sap.ui.vk.ContentResource
Removes a contentResource from the aggregation contentResources.
Parameters:
{int|string|sap.ui.vk.ContentResource}vContentResource The contentResourceto remove or its index or id
Returns:
{sap.ui.vk.ContentResource} The removed contentResource or null
setEnableFullScreen(bEnableFullScreen): sap.ui.vk.Viewer
Sets a new value for property enableFullScreen.

Enable / disable full screen mode

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

Parameters:
{boolean}bEnableFullScreen New value for property enableFullScreen
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
setEnableNotifications(bEnableNotifications): sap.ui.vk.Viewer
Sets a new value for property enableNotifications.

Disables the Message Popover Control

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
{boolean}bEnableNotifications New value for property enableNotifications
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
setEnableOverlay(bEnableOverlay): sap.ui.vk.Viewer
Sets a new value for property enableOverlay.

Enables or disables the Overlay control

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

Parameters:
{boolean}bEnableOverlay New value for property enableOverlay
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
setEnableProgressIndicator(bEnableProgressIndicator): sap.ui.vk.Viewer
Sets a new value for property enableProgressIndicator.

Enable / disable progress indicator for downloading and rendering VDS files

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
{boolean}bEnableProgressIndicator New value for property enableProgressIndicator
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
setEnableSceneTree(bEnableSceneTree): sap.ui.vk.Viewer
Sets a new value for property enableSceneTree.

Disables the scene tree control Button on the menu

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
{boolean}bEnableSceneTree New value for property enableSceneTree
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
setEnableStepNavigation(bEnableStepNavigation): sap.ui.vk.Viewer
Sets a new value for property enableStepNavigation.

Disables the Step Navigation Control Button on the menu

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
{boolean}bEnableStepNavigation New value for property enableStepNavigation
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
setEnableToolbar(bEnableToolbar): sap.ui.vk.Viewer
Sets a new value for property enableToolbar.

Shows or hides Toolbar control

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
{boolean}bEnableToolbar New value for property enableToolbar
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
setHeight(sHeight): sap.ui.vk.Viewer
Sets a new value for property height.

Height of the Viewer control

When called with a value of null or undefined, the default value of the property will be restored.

Default value is auto.

Parameters:
{sap.ui.core.CSSSize}sHeight New value for property height
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
setOverlay(oOverlay): sap.ui.vk.Viewer
Sets the aggregated overlay.
Parameters:
{sap.ui.vk.Overlay}oOverlay The overlay to set
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
setShowSceneTree(bShowSceneTree): sap.ui.vk.Viewer
Sets a new value for property showSceneTree.

Shows or hides the scene tree control

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
{boolean}bShowSceneTree New value for property showSceneTree
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
setShowStepNavigation(bShowStepNavigation): sap.ui.vk.Viewer
Sets a new value for property showStepNavigation.

Shows or hides the Step Navigation Control

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

Parameters:
{boolean}bShowStepNavigation New value for property showStepNavigation
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
setShowStepNavigationThumbnails(bShowStepNavigationThumbnails): sap.ui.vk.Viewer
Sets a new value for property showStepNavigationThumbnails.

Shows or hides the Step Navigation thumbnails

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
{boolean}bShowStepNavigationThumbnails New value for property showStepNavigationThumbnails
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
setToolbarTitle(sToolbarTitle): sap.ui.vk.Viewer
Sets a new value for property toolbarTitle.

The toolbar title

When called with a value of null or undefined, the default value of the property will be restored.

Default value is .

Parameters:
{string}sToolbarTitle New value for property toolbarTitle
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining
setWidth(sWidth): sap.ui.vk.Viewer
Sets a new value for property width.

Width of the Viewer control

When called with a value of null or undefined, the default value of the property will be restored.

Default value is auto.

Parameters:
{sap.ui.core.CSSSize}sWidth New value for property width
Returns:
{sap.ui.vk.Viewer} Reference to this in order to allow method chaining