abstract class sap.ui.vk.Scene

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

Provides the interface for the 3D model.

The objects of this class should not be created directly. They should be created via sap.ui.vk.ContentConnector.


Constructor

Constructor for a new Scene.

The objects of this class should not be created directly. They should be created via sap.ui.vk.ContentConnector.

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.Scene()

Properties

Name Type Default Value Description
doubleSided boolean false

Enables or disables double-sided materials

Visibility: public

Methods Overview

Method Description
addSequence

Add a sequence to the scene

addTrack

Add an animation track to the scene

createHighlight

Creates a highlight.

createSequence

Creates an animation sequence.

createTrack

Creates an animation track.

sap.ui.vk.Scene.extend

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

findSequence

Finds sequence by ID

findTrack

Finds track by ID

getDefaultNodeHierarchy

Gets the default node hierarchy in the Scene object.

getDoubleSided

Gets current value of property doubleSided.

Enables or disables double-sided materials

Default value is false.

getHighlight

get highlight according to ID

getId

Gets the unique ID of the Scene object.

getInitialView

Get initial view

sap.ui.vk.Scene.getMetadata

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

getSceneRef

Gets the scene reference that this Scene object wraps.

getSequences

Gets a list of sequences

getTracks

Gets a list of animation tracks

getViewGroups

Provides an array of all ViewGroups

getViews

Provides an array of all views

indexOfSequence

Gets index of a sequence in the scene

indexOfTrack

Gets index of an animation track in the scene

insertSequence

Inserts a sequence

insertTrack

Inserts an animation track

removeHighlight

remove highlight according to ID

removeSequence

Removes a sequence from the scene

removeSequences

Removes all sequences from the scene

removeTrack

Removes an animation track from the scene

removeTracks

Removes all animation tracks from the scene

setDoubleSided

Sets a new value for property doubleSided.

Enables or disables double-sided materials

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

Default value is false.

setInitialView

Set initial view

addSequence

Add a sequence to the scene

Param Type DefaultValue Description
sequence sap.ui.vk.AnimationSequence

sequence to add

addTrack

Add an animation track to the scene

Param Type DefaultValue Description
track sap.ui.vk.AnimationTrack

animation track to add

createHighlight

Creates a highlight.

Param Type DefaultValue Description
sId string

persistent highlight ID

parameters any

highlight creation parameters

name string

highlight name

duration float

highlight duration - 0 means static highlight

cycles int

highlight cycles - 0 with duration > o means infinite highlight

opacities float[]

highlight opacities - optional, can be empty

colours array[]

highlight colours - optional, can be empty, in form of [[r1, g1, b1, a1], [r2, g2, b2, a2], ...]

createSequence

Creates an animation sequence.

Param Type DefaultValue Description
sId string

persistent sequence ID

parameters any

sequence creation parameters

name string

sequence name

duration float

sequence duration

createTrack

Creates an animation track.

Param Type DefaultValue Description
sId string

persistent track ID

parameters any

track creation parameters

trackValueType sap.ui.vk.TrackValueType

track's value type

sap.ui.vk.Scene.extend

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

findSequence

Finds sequence by ID

Param Type DefaultValue Description
sequenceId string

sequence ID

findTrack

Finds track by ID

Param Type DefaultValue Description
trackId string

track ID

getDefaultNodeHierarchy

Gets the default node hierarchy in the Scene object.

getDoubleSided

Gets current value of property doubleSided.

Enables or disables double-sided materials

Default value is false.

getHighlight

get highlight according to ID

Param Type DefaultValue Description
sId string

persistent highlight ID

getId

Gets the unique ID of the Scene object.

getInitialView

Get initial view

sap.ui.vk.Scene.getMetadata

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

getSceneRef

Gets the scene reference that this Scene object wraps.

getSequences

Gets a list of sequences

getTracks

Gets a list of animation tracks

getViewGroups

Provides an array of all ViewGroups

getViews

Provides an array of all views

indexOfSequence

Gets index of a sequence in the scene

Param Type DefaultValue Description
sequence sap.ui.vk.AnimationSequence

sequence to locate

indexOfTrack

Gets index of an animation track in the scene

Param Type DefaultValue Description
track sap.ui.vk.AnimationTrack

animation track to locate

insertSequence

Inserts a sequence

Param Type DefaultValue Description
sequence sap.ui.vk.AnimationSequence

sequence to insert

index int

index where to insert the sequence

insertTrack

Inserts an animation track

Param Type DefaultValue Description
track sap.ui.vk.AnimationTrack

animation track to insert

index int

index where to insert the animation track

removeHighlight

remove highlight according to ID

Param Type DefaultValue Description
sId string

persistent highlight ID

removeSequence

Removes a sequence from the scene

Param Type DefaultValue Description
sequence sap.ui.vk.AnimationSequence

sequence to remove

removeSequences

Removes all sequences from the scene

removeTrack

Removes an animation track from the scene

Param Type DefaultValue Description
track sap.ui.vk.AnimationTrack

animation track to remove

removeTracks

Removes all animation tracks from the scene

setDoubleSided

Sets a new value for property doubleSided.

Enables or disables double-sided materials

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

Default value is false.

Param Type DefaultValue Description
bDoubleSided boolean false

New value for property doubleSided

setInitialView

Set initial view

Param Type DefaultValue Description
view sap.ui.vk.View

Initial view