class sap.ui.vk.View

Control sample: sap.ui.vk.View
Visiblity: public
UX Guidelines:
Implements: sap.ui.vk.IPlaybackCollection
Available since: N/A
Module: sap/ui/vk/View
Application Component: CA-UI5-VTK

Provides the interface for the view.


Constructor

Constructor for a new View.

The objects of this class contain necessary information to reproduce current view including camera type, position and orientation as well as objects visibility property and their positions (if different from default)

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.vk.View()

Properties

Name Type Default Value Description
aspectRatio float

Aspect ratio for Safe Area (optional). This can be 0 to 25. Values above or below this range will be ignored.

Visibility: public
description string

View description (optional)

Visibility: public
name string

View name (optional)

Visibility: public
viewId string

View persistent ID (optional)

Visibility: public

Methods Overview

Method Description
sap.ui.vk.View.extend

Creates a new subclass of class sap.ui.vk.View 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.base.ManagedObject.extend.

getAspectRatio

Gets current value of property aspectRatio.

Aspect ratio for Safe Area (optional). This can be 0 to 25. Values above or below this range will be ignored.

getCamera

Returns view camera

getDescription

Gets current value of property description.

View description (optional)

sap.ui.vk.View.getMetadata

Returns a metadata object for class sap.ui.vk.View.

getName

Gets current value of property name.

View name (optional)

getNodeInfos

Get parameters of nodes defined in view

getViewId

Gets current value of property viewId.

View persistent ID (optional)

setAspectRatio

Sets a new value for property aspectRatio.

Aspect ratio for Safe Area (optional). This can be 0 to 25. Values above or below this range will be ignored.

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

setCamera

Set view camera.

setDescription

Sets a new value for property description.

View description (optional)

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

setName

Sets a new value for property name.

View name (optional)

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

setNodeInfos

Set parameters of nodes defined in view

setViewId

Sets a new value for property viewId.

View persistent ID (optional)

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

updateNodeInfos

Update parameters of nodes if nodes are already defined, add parameters if the node is not defined in view

sap.ui.vk.View.extend

Creates a new subclass of class sap.ui.vk.View 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.base.ManagedObject.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

getAspectRatio

Gets current value of property aspectRatio.

Aspect ratio for Safe Area (optional). This can be 0 to 25. Values above or below this range will be ignored.

getCamera

Returns view camera

getDescription

Gets current value of property description.

View description (optional)

sap.ui.vk.View.getMetadata

Returns a metadata object for class sap.ui.vk.View.

getName

Gets current value of property name.

View name (optional)

getNodeInfos

Get parameters of nodes defined in view

getViewId

Gets current value of property viewId.

View persistent ID (optional)

setAspectRatio

Sets a new value for property aspectRatio.

Aspect ratio for Safe Area (optional). This can be 0 to 25. Values above or below this range will be ignored.

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

Param Type DefaultValue Description
fAspectRatio float

New value for property aspectRatio

setCamera

Set view camera.

Param Type DefaultValue Description
camera sap.ui.vk.Camera

view camera

setDescription

Sets a new value for property description.

View description (optional)

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

Param Type DefaultValue Description
sDescription string

New value for property description

setName

Sets a new value for property name.

View name (optional)

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

Param Type DefaultValue Description
sName string

New value for property name

setNodeInfos

Set parameters of nodes defined in view

Param Type DefaultValue Description
infos object[]

Array of objects containing node information, each object contains the following fields

target object

Node reference

transform float[]

Node transformation matrix, array of 16 or 12

meshId string

Optional, node mesh Id

materialId string

Optional, node material Id

visible boolean

Node visibility

opacity float

Node opacity

annotationId float

Optional, annotation id

setViewId

Sets a new value for property viewId.

View persistent ID (optional)

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

Param Type DefaultValue Description
sViewId string

New value for property viewId

updateNodeInfos

Update parameters of nodes if nodes are already defined, add parameters if the node is not defined in view

Param Type DefaultValue Description
update object[]

Infos array of objects containing node information, each object contains the following fields

target object

Node reference

transform float[]

Node transformation matrix, array of 16 or 12

meshId string

Optional, node mesh Id

materialId string

Optional, node material Id

visible boolean

Node visibility

opacity float

Node opacity