namespace sap.ui.vk

Control sample: sap.ui.vk
Visiblity: public
Available since: N/A
Module: sap/ui/vk/library
Application Component: CA-UI5-VTK

SAPUI5 library with controls for displaying 3D models.


Nodes Overview

Node Description
sap.ui.vk.AnimationPlayer

Provides definition for an animation playback

sap.ui.vk.Annotation

Annotation allows applications to display custom html annotation on top of Viewport and associate it with 3D object

sap.ui.vk.AnnotationStyle

Sets the animation style type for annotation text.

sap.ui.vk.AuthorizationHandler

Contract for authorization callback function

A callback function which can be implemented by an application to provide an authorization token. Such a function receives a single parameter which is a connection URL and must return a promise which will be resolved to Access Token Response when authorization token is obtained.

A sample implementation of authorization handler:

...
var viewer = new sap.ui.vk.Viewer();
viewer.setAuthorizationHandler(function(url) {
    var headers = new Headers();
    headers.append("Content-Type", "application/x-www-form-urlencoded");
    headers.append("Authorization", "Basic " + basicAuth);

    return fetch(accessTokenUrl, {
            method: "POST",
            body: "grant_type=client_credentials",
            headers: headers
        }).then(response => response.json())
});
...

sap.ui.vk.BaseNodeProxy

Provides a simple, lightweight proxy object to a node in a node hierarchy.

sap.ui.vk.Camera

Provides the base interface for the camera.

sap.ui.vk.CameraFOVBindingType

Camera field of view binding types.

sap.ui.vk.CameraProjectionType

Camera projection type.

sap.ui.vk.ContainerBase

Abstract Constructor for a new Container.

sap.ui.vk.ContainerContent

Aggregation element for the Container Base

sap.ui.vk.ContentConnector

Provides an object that owns content resources, tracks their changes and loads and destroys the content built from the content resources.

sap.ui.vk.ContentManager

Provides a base loader interface.

sap.ui.vk.ContentResource

Specifies a resource to load.

sap.ui.vk.ContentResourceSourceCategory

The categories of content resources.

sap.ui.vk.DecryptionHandler

Contract for objects that implement decryption.

sap.ui.vk.DrawerToolbar

Overflow toolbar that can be collapsed.

sap.ui.vk.DrawerToolbarButton

Button identifiers for sap.ui.vk.DrawerToolbar.

sap.ui.vk.FlexibleControl

Holds layout data for the FlexibleControl contents.

sap.ui.vk.FlexibleControlLayoutData

Holds layout data for the FlexibleControl contents.

sap.ui.vk.ImageContentManager

Provides a loader that loads a 2D raster or vector image into an HTMLImageElement or HTMLObjectElement object.

sap.ui.vk.IPlaybackCollection

Contract for objects that provide access to animation playbacks.

sap.ui.vk.LayerProxy

Provides a proxy object to the layer in the node hierarchy.

sap.ui.vk.LegendItem

Legend item control

sap.ui.vk.ListPanel

Aggregation control for the Legend

sap.ui.vk.ListPanelStack

ListPanelStack control

sap.ui.vk.Loco

Intercepts input event data for a SAPUI5 target, and interprets the data based on a supported set of gestures.

sap.ui.vk.MapContainer

Abstract Constructor for a new Container.

sap.ui.vk.MapContainerButtonType

Types of custom buttons supported on the MapContainer toolbar

sap.ui.vk.Material

Provides the interface for the material.

sap.ui.vk.NativeViewport

Enables loading, pan, zoom and overlay capabilities for a subset of file formats capable of being loaded into a browser natively.

sap.ui.vk.NodeContentType

Node content type for sap.ui.vk.NodeHierarchy.createNode.

sap.ui.vk.NodeHierarchy

Provides the ability to explore a Scene object's node structure.

sap.ui.vk.NodeProxy

Provides a proxy object to the node in the node hierarchy.

sap.ui.vk.Notifications

Provides the ability to display logged console messages within your application.

sap.ui.vk.ObjectType

Object type

sap.ui.vk.OrthographicCamera

Provides the interface for the orthographic camera.

sap.ui.vk.OutputSettings

Aggregation element for the output settings of the Viewport

sap.ui.vk.Overlay

Constructor for a new Overlay.

sap.ui.vk.OverlayArea

Aggregation element for the Overlay Control

sap.ui.vk.PerspectiveCamera

Provides the interface for the perspective camera.

sap.ui.vk.ProgressIndicator

Shows the progress of a process in a graphical way.

sap.ui.vk.RedlineCollaboration

Provides a base class control for RedlineCollaborations.

sap.ui.vk.RedlineConversation

Provides a base class control for RedlineConversations.

sap.ui.vk.RedlineDesign

Provides a control for designing redlining shapes.

sap.ui.vk.RedlineElement

Provides a base class for redline elements.

sap.ui.vk.RedlineElementComment

Provides a control for creating RedlineElementComments.

sap.ui.vk.RedlineElementEllipse

Provides a control for creating ellipse redline elements.

sap.ui.vk.RedlineElementFreehand

Provides a control for creating freehand redline elements.

sap.ui.vk.RedlineElementLine

Provides a control for creating line redline elements.

sap.ui.vk.RedlineElementRectangle

Provides a control for creating rectangle redline elements.

sap.ui.vk.RedlineElementText

Provides a control for creating text redline elements.

sap.ui.vk.RedlineSurface

Provides a bass class control for redlining.

sap.ui.vk.RenderMode

Render mode for sap.ui.vk.Viewport.

sap.ui.vk.SafeArea

SafeArea allows applications to define area of viewport which will be initially displayed regardless of viewing device and its screen resolution or orientation.

sap.ui.vk.Scene

Provides the interface for the 3D model.

sap.ui.vk.SceneTree

Provides a hierarchical view of all the nodes in a given scene in table format.

sap.ui.vk.SelectionDisplayMode

Selection display options.

sap.ui.vk.SelectionMode

SelectionMode options.

sap.ui.vk.StepNavigation

Enables capabilities for navigating and activating procedures and steps contained in a single 3D scene.

sap.ui.vk.Texture

Provides the interface for the texture.

sap.ui.vk.Toolbar

Provides buttons to hide or show certain sap.ui.vk controls.

sap.ui.vk.TransformationMatrix

Transformation matrix is an array of 12 numbers in a row major mode.

sap.ui.vk.View

Provides the interface for the view.

sap.ui.vk.Viewer

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

sap.ui.vk.ViewGallery

Enables capabilities for navigating and activating procedures and steps contained in a single 3D scene.

sap.ui.vk.ViewGroup

Provides the interface for the view.

sap.ui.vk.Viewport

Provides a rendering canvas for the 3D elements of a loaded scene.

sap.ui.vk.ViewportBase

Provides a rendering canvas for the 3D elements of a loaded scene.

sap.ui.vk.ViewStateManager

Manages the visibility and selection states of nodes in the scene.

sap.ui.vk.ViewStateManagerBase

Manages the visibility and selection states of nodes in the scene.

sap.ui.vk.VisibilityMode

Visibility mode for sap.ui.vk.Viewport.getViewInfo.

sap.ui.vk.ZoomTo

ZoomTo options.

sap.ui.vk.dvl
sap.ui.vk.svg
sap.ui.vk.threejs
sap.ui.vk.tools

Methods Overview

Method Description
sap.ui.vk.getCore

Retrieve the Core instance for the current window.

sap.ui.vk.getCore

Retrieve the Core instance for the current window.

Param Type DefaultValue Description