class sap.ui.vtm.Viewable

Control sample: sap.ui.vtm.Viewable
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/vtm/Viewable
Application Component:

A viewable containing 3D content that can be loaded into a sap.ui.vtm.Scene.


Constructor

Constructor for a new Viewable.

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.vtm.Viewable(sId, mSettings?)
Param Type Default Value Description
sId string

An optional ID for the sap.ui.vtm.Viewable.

mSettings? object

An optional object with initial settings for the new sap.ui.vtm.Viewable instance


Properties

Name Type Default Value Description
name string

The name for this Viewable.

Visibility: public
relativeMatrix sap.ui.vtm.Matrix

The relative transformation matrix to apply to the scene node created to wrap the contents of the loaded viewable.

Visibility: public
rootNodeIds string[]

The root scene node IDs for this viewable.

Visibility: public
source any

The source URL (string) or File for this Viewable.

Visibility: public

Methods Overview

Method Description
sap.ui.vtm.Viewable.extend

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

sap.ui.vtm.Viewable.getMetadata

Returns a metadata object for class sap.ui.vtm.Viewable.

getName

Gets current value of property name.

The name for this Viewable.

getRelativeMatrix

Gets current value of property relativeMatrix.

The relative transformation matrix to apply to the scene node created to wrap the contents of the loaded viewable.

getRootNodeIds

Gets current value of property rootNodeIds.

The root scene node IDs for this viewable.

getSource

Gets current value of property source.

The source URL (string) or File for this Viewable.

getSourceId

Gets the unique ID that identifies this Viewable. This is an alias for #getId

getSourceString

Returns a string representation of the source. If the source is a File this returns the file name (which is not guaranteed to uniquely identify the file).

setName

Sets the name for this Viewable.

setRelativeMatrix

Sets a new value for property relativeMatrix.

The relative transformation matrix to apply to the scene node created to wrap the contents of the loaded viewable.

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

setRootNodeIds

Sets a new value for property rootNodeIds.

The root scene node IDs for this viewable.

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

setSource

Sets the source URL or File for this Viewable.

sap.ui.vtm.Viewable.extend

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

sap.ui.vtm.Viewable.getMetadata

Returns a metadata object for class sap.ui.vtm.Viewable.

getName

Gets current value of property name.

The name for this Viewable.

getRelativeMatrix

Gets current value of property relativeMatrix.

The relative transformation matrix to apply to the scene node created to wrap the contents of the loaded viewable.

getRootNodeIds

Gets current value of property rootNodeIds.

The root scene node IDs for this viewable.

getSource

Gets current value of property source.

The source URL (string) or File for this Viewable.

getSourceId

Gets the unique ID that identifies this Viewable. This is an alias for #getId

getSourceString

Returns a string representation of the source. If the source is a File this returns the file name (which is not guaranteed to uniquely identify the file).

setName

Sets the name for this Viewable.

Param Type DefaultValue Description
name string

The name for this Viewable.

setRelativeMatrix

Sets a new value for property relativeMatrix.

The relative transformation matrix to apply to the scene node created to wrap the contents of the loaded viewable.

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

Param Type DefaultValue Description
sRelativeMatrix sap.ui.vtm.Matrix

New value for property relativeMatrix

setRootNodeIds

Sets a new value for property rootNodeIds.

The root scene node IDs for this viewable.

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

Param Type DefaultValue Description
sRootNodeIds string[]

New value for property rootNodeIds

setSource

Sets the source URL or File for this Viewable.

Param Type DefaultValue Description
source string File

The source URL of File for this Viewable.