class sap.ui.vtm.SceneNode

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

This class provides access to the data for a scene node. Objects of this type are transient. Long lived references to such objects should not be kept. A single sap.ui.vtm.SceneNode object can be reused to refer to a different scene node by changing the value of the sceneNodeId property. Scene traversal methods typically reuse a single sap.ui.vtm.SceneNode object to avoid construction and destruction. Applications are expected to use their own data structures to store data extracted from scene nodes that needs to be accessed efficiently.


Constructor

This class is not intended to be directly instantiated by application code. The scene traversal methods (traverseTree, traverseBranch, traverseNodes) should be used to access scene nodes

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

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

mSettings? object

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


Properties

Name Type Default Value Description
scene object

The sap.ui.vtm.Scene for the scene node.

Visibility: public
sceneNodeId string

The scene node id.

This is a transient identifier that exists in the context of the current scene. It should not be persisted.

Visibility: public

Methods Overview

Method Description
sap.ui.vtm.SceneNode.extend

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

getAbsoluteMatrix

Gets the absolute transformation matrix that applies to the scene node in ISO 10303-42 format.

getClosed

Gets whether this scene node is closed. When a scene node is closed, the closed scene node and its descendants are treated as a single scene node (at least in terms of selection).

getIdentifiers

Gets a plain JavaScript object map of identifier values.

Keys are in the form: ['{"source":"SAP","type":"VE_COMPONENT"}'.

Values are strings or arrays of strings in the form: '[{"name":"ID", "value":"_moto_x_asm"},{"name":"version", "value": "00"},{"name": "timestamp", "value":"2016-05-18 03:44:53.93"}]'.

sap.ui.vtm.SceneNode.getMetadata

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

getName

Gets the name of the scene node.

getNodeMetadata

Gets a plain JavaScript object map of metadata values.

Keys are in the form: '{"category":"SAP","field":"MATERIAL"}'.

Values are in the form of strings or arrays of strings.

getRelativeMatrix

Gets the relative transformation matrix that applies to the scene node in ISO 10303-42 format.

getScene

Gets current value of property scene.

The sap.ui.vtm.Scene for the scene node.

getSceneNodeId

Gets current value of property sceneNodeId.

The scene node id.

This is a transient identifier that exists in the context of the current scene. It should not be persisted.

setAbsoluteMatrix

Sets the absolute transformation matrix that applies to the scene node in ISO 10303-42 format.

setRelativeMatrix

Sets the relative transformation matrix that applies to the scene node in ISO 10303-42 format.

setScene

Sets a new value for property scene.

The sap.ui.vtm.Scene for the scene node.

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

setSceneNodeId

Sets a new value for property sceneNodeId.

The scene node id.

This is a transient identifier that exists in the context of the current scene. It should not be persisted.

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

sap.ui.vtm.SceneNode.extend

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

getAbsoluteMatrix

Gets the absolute transformation matrix that applies to the scene node in ISO 10303-42 format.

getClosed

Gets whether this scene node is closed. When a scene node is closed, the closed scene node and its descendants are treated as a single scene node (at least in terms of selection).

getIdentifiers

Gets a plain JavaScript object map of identifier values.

Keys are in the form: ['{"source":"SAP","type":"VE_COMPONENT"}'.

Values are strings or arrays of strings in the form: '[{"name":"ID", "value":"_moto_x_asm"},{"name":"version", "value": "00"},{"name": "timestamp", "value":"2016-05-18 03:44:53.93"}]'.

sap.ui.vtm.SceneNode.getMetadata

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

getName

Gets the name of the scene node.

getNodeMetadata

Gets a plain JavaScript object map of metadata values.

Keys are in the form: '{"category":"SAP","field":"MATERIAL"}'.

Values are in the form of strings or arrays of strings.

getRelativeMatrix

Gets the relative transformation matrix that applies to the scene node in ISO 10303-42 format.

getScene

Gets current value of property scene.

The sap.ui.vtm.Scene for the scene node.

getSceneNodeId

Gets current value of property sceneNodeId.

The scene node id.

This is a transient identifier that exists in the context of the current scene. It should not be persisted.

setAbsoluteMatrix

Sets the absolute transformation matrix that applies to the scene node in ISO 10303-42 format.

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

The absolute transformation matrix that applies to the scene node in ISO 10303-42 format.

setRelativeMatrix

Sets the relative transformation matrix that applies to the scene node in ISO 10303-42 format.

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

The relative transformation matrix that applies to the scene node in ISO 10303-42 format.

setScene

Sets a new value for property scene.

The sap.ui.vtm.Scene for the scene node.

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

Param Type DefaultValue Description
oScene object

New value for property scene

setSceneNodeId

Sets a new value for property sceneNodeId.

The scene node id.

This is a transient identifier that exists in the context of the current scene. It should not be persisted.

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

Param Type DefaultValue Description
sSceneNodeId string

New value for property sceneNodeId