class sap.ui.vbm.Adapter3D

Control sample: sap.ui.vbm.Adapter3D
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/vbm/Adapter3D
Application Component: CA-GTF-VBZ

Provides the ability to load VBI JSON into sap.ui.vbm.Viewport control.


Constructor

Constructor for a new Visual Business Adapter 3D.

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

new sap.ui.vbm.Adapter3D(sId?, mSettings?)
Param Type Default Value Description
sId? string

id for the new control, generated automatically if no id is given

mSettings? object

initial settings for the new object


Associations

Name Cardinality Type Description
viewport 0..1 sap.ui.vbm.Viewport

The Viewport control associated with the Adapter3D. The Adapter3D would invoke methods and subscribe to events on this Viewport instance.


Events Overview

Event Description
submit

This event is fired when interactions in the viewport happen.

submit

This event is fired when interactions in the viewport happen.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
data string

A string in the VBI JSON format.


Methods Overview

Method Description
attachSubmit

Attaches event handler fnFunction to the submit event of this sap.ui.vbm.Adapter3D.

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.vbm.Adapter3D itself.

This event is fired when interactions in the viewport happen.

detachSubmit

Detaches event handler fnFunction from the submit event of this sap.ui.vbm.Adapter3D.

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

sap.ui.vbm.Adapter3D.extend

Creates a new subclass of class sap.ui.vbm.Adapter3D 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.Element.extend.

fireSubmit

Fires event submit to attached listeners.

sap.ui.vbm.Adapter3D.getMetadata

Returns a metadata object for class sap.ui.vbm.Adapter3D.

getViewport

ID of the element which is the current target of the association viewport, or null.

load

Processes the various sections from the VBI JSON.

The Resources, DataTypes, Scenes and Data sections from the VBI JSON are sequentially processed.

setViewport

Sets the associated viewport.

attachSubmit

Attaches event handler fnFunction to the submit event of this sap.ui.vbm.Adapter3D.

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.vbm.Adapter3D itself.

This event is fired when interactions in the viewport happen.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.vbm.Adapter3D itself

detachSubmit

Detaches event handler fnFunction from the submit event of this sap.ui.vbm.Adapter3D.

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

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.ui.vbm.Adapter3D.extend

Creates a new subclass of class sap.ui.vbm.Adapter3D 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.Element.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

fireSubmit

Fires event submit to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

data string

A string in the VBI JSON format.

sap.ui.vbm.Adapter3D.getMetadata

Returns a metadata object for class sap.ui.vbm.Adapter3D.

getViewport

ID of the element which is the current target of the association viewport, or null.

load

Processes the various sections from the VBI JSON.

The Resources, DataTypes, Scenes and Data sections from the VBI JSON are sequentially processed.

Param Type DefaultValue Description
data object string

The VBI JSON.

setViewport

Sets the associated viewport.

Param Type DefaultValue Description
oViewport sap.ui.core.ID sap.ui.vbm.Viewport

ID of an element which becomes the new target of this viewport association; alternatively, an element instance may be given