class sap.ui.vk.threejs.ViewStateManager

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/vk/threejs/ViewStateManager
Application Component: CA-UI5-VTK

Manages the visibility and selection states of nodes in the scene.


Constructor

Constructor for a new ViewStateManager.

new sap.ui.vk.threejs.ViewStateManager(sId?, mSettings?)
Param Type Default Value Description
sId? string

ID for the new ViewStateManager object. Generated automatically if no ID is given.

mSettings? object

Initial settings for the new ViewStateManager object.

Borrowed Properties

Name Type Default Value Description
recursiveOutlining boolean false Visibility: public
recursiveSelection boolean false Visibility: public
shouldTrackVisibilityChanges boolean false Visibility: public

Methods Overview

Method Description
enumerateOutlinedNodes

Enumerates IDs of the outlined nodes.

enumerateSelection

Enumerates IDs of the selected nodes.

sap.ui.vk.threejs.ViewStateManager.extend

Creates a new subclass of class sap.ui.vk.threejs.ViewStateManager 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.vk.ViewStateManagerBase.extend.

getHighlightColor

Gets the default highlighting color

sap.ui.vk.threejs.ViewStateManager.getMetadata

Returns a metadata object for class sap.ui.vk.threejs.ViewStateManager.

getNodeHierarchy

Gets the NodeHierarchy object associated with this ViewStateManager object.

getOpacity

Gets the opacity of the node.

If a single node is passed to the method then a single value is returned.
If an array of nodes is passed to the method then an array of values is returned.

getOutlineColor

Gets the outline color

getOutlineWidth

Gets the outline width

getOutliningState

Gets the outlining state of the node.

If a single node reference is passed to the method then a single outlining state is returned.
If an array of node references is passed to the method then an array of outlining states is returned.

getSelectionState

Gets the selection state of the node.

If a single node reference is passed to the method then a single selection state is returned.
If an array of node references is passed to the method then an array of selection states is returned.

getShowSelectionBoundingBox

Gets if showing the bounding box when nodes are selected

getSymbolNodes

Get the Symbol node from nodeId, if nodeId is not set, returns a collection of all Symbol nodes

getTintColor

Gets the tint color of the node.

If a single node reference is passed to the method then a single value is returned.
If an array of node references is passed to the method then an array of values is returned.

getVisibilityChanges

Gets the visibility changes in the current ViewStateManager object.

getVisibilityState

Gets the visibility state of nodes.

If a single node is passed to the method then a single visibility state is returned.
If an array of nodes is passed to the method then an array of visibility states is returned.

resetNodeProperty

Reset node property to the value defined by current view..

setHighlightColor

Sets the default highlighting color

setOpacity

Sets the opacity of the nodes.

setOutlineColor

Sets the outline color

setOutlineWidth

Sets the outline width

setOutliningStates

Sets or resets the outlining state of the nodes.

setSelectionState

Sets the selection state of the nodes.

setSelectionStates

Sets or resets the selection state of the nodes.

setShowSelectionBoundingBox

Sets if showing the bounding box when nodes are selected

setTintColor

Sets the tint color of the nodes.

setVisibilityState

Sets the visibility state of the nodes.

enumerateOutlinedNodes

Enumerates IDs of the outlined nodes.

Param Type DefaultValue Description
callback function

A function to call when the outlined nodes are enumerated. The function takes one parameter of type string.

enumerateSelection

Enumerates IDs of the selected nodes.

Param Type DefaultValue Description
callback function

A function to call when the selected nodes are enumerated. The function takes one parameter of type string.

sap.ui.vk.threejs.ViewStateManager.extend

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

getHighlightColor

Gets the default highlighting color

Param Type DefaultValue Description
inABGRFormat boolean false

This flag indicates to return the highlighting color in the ABGR format, if it equals false then the color is returned in the CSS color format.

sap.ui.vk.threejs.ViewStateManager.getMetadata

Returns a metadata object for class sap.ui.vk.threejs.ViewStateManager.

getNodeHierarchy

Gets the NodeHierarchy object associated with this ViewStateManager object.

getOpacity

Gets the opacity of the node.

If a single node is passed to the method then a single value is returned.
If an array of nodes is passed to the method then an array of values is returned.

Param Type DefaultValue Description
nodeRefs any any[]

The node reference or the array of node references.

getOutlineColor

Gets the outline color

Param Type DefaultValue Description
inABGRFormat boolean false

This flag indicates to return the outline color in the ABGR format, if it equals false then the color is returned in the CSS color format.

getOutlineWidth

Gets the outline width

getOutliningState

Gets the outlining state of the node.

If a single node reference is passed to the method then a single outlining state is returned.
If an array of node references is passed to the method then an array of outlining states is returned.

Param Type DefaultValue Description
nodeRefs any any[]

The node reference or the array of node references.

getSelectionState

Gets the selection state of the node.

If a single node reference is passed to the method then a single selection state is returned.
If an array of node references is passed to the method then an array of selection states is returned.

Param Type DefaultValue Description
nodeRefs any any[]

The node reference or the array of node references.

getShowSelectionBoundingBox

Gets if showing the bounding box when nodes are selected

getSymbolNodes

Get the Symbol node from nodeId, if nodeId is not set, returns a collection of all Symbol nodes

Param Type DefaultValue Description
nodeId string

node Id string, optional

getTintColor

Gets the tint color of the node.

If a single node reference is passed to the method then a single value is returned.
If an array of node references is passed to the method then an array of values is returned.

Param Type DefaultValue Description
nodeRefs any any[]

The node reference or the array of node references.

inABGRFormat boolean false

This flag indicates to return the tint color in the ABGR format, if it equals false then the color is returned in the CSS color format.

getVisibilityChanges

Gets the visibility changes in the current ViewStateManager object.

getVisibilityState

Gets the visibility state of nodes.

If a single node is passed to the method then a single visibility state is returned.
If an array of nodes is passed to the method then an array of visibility states is returned.

Param Type DefaultValue Description
nodeRefs any any[]

The node reference or the array of node references.

resetNodeProperty

Reset node property to the value defined by current view..

Param Type DefaultValue Description
nodeRef object

reference to node.

property string

node property

setHighlightColor

Sets the default highlighting color

Param Type DefaultValue Description
color sap.ui.vk.CSSColor string int

The new highlighting color. The value can be defined as a string in the CSS color format or as an integer in the ABGR format. If null is passed then the tint color is reset and the node's own tint color should be used.

setOpacity

Sets the opacity of the nodes.

Param Type DefaultValue Description
nodeRefs any any[]

The node reference or the array of node references.

opacity float float[] null

The new opacity of the nodes. If null is passed then the opacity is reset and the node's own opacity should be used.

recursive boolean false

This flag is not used, as opacity is always recursively applied to the offspring nodes by multiplication

setOutlineColor

Sets the outline color

Param Type DefaultValue Description
color sap.ui.vk.CSSColor string int

The new outline color. The value can be defined as a string in the CSS color format or as an integer in the ABGR format. If null is passed then the tint color is reset and the node's own tint color should be used.

setOutlineWidth

Sets the outline width

Param Type DefaultValue Description
width float

width of outline

setOutliningStates

Sets or resets the outlining state of the nodes.

Param Type DefaultValue Description
outlinedNodeRefs any any[]

The node reference or the array of node references of outlined nodes.

unoutlinedNodeRefs any any[]

The node reference or the array of node references of un-outlined nodes.

recursive boolean

The flags indicates if the change needs to propagate recursively to child nodes.

blockNotification boolean

The flag to suppress outlineChanged event.

setSelectionState

Sets the selection state of the nodes.

Param Type DefaultValue Description
nodeRefs any any[]

The node reference or the array of node references.

selected boolean

The new selection state of the nodes.

recursive boolean

The flags indicates if the change needs to propagate recursively to child nodes.

blockNotification boolean

The flag to suppress selectionChanged event.

setSelectionStates

Sets or resets the selection state of the nodes.

Param Type DefaultValue Description
selectedNodeRefs any any[]

The node reference or the array of node references of selected nodes.

unselectedNodeRefs any any[]

The node reference or the array of node references of unselected nodes.

recursive boolean

The flags indicates if the change needs to propagate recursively to child nodes.

blockNotification boolean

The flag to suppress selectionChanged event.

setShowSelectionBoundingBox

Sets if showing the bounding box when nodes are selected

Param Type DefaultValue Description
val boolean

true if bounding boxes of selected nodes are shown, false otherwise.

setTintColor

Sets the tint color of the nodes.

Param Type DefaultValue Description
nodeRefs any any[]

The node reference or the array of node references.

tintColor sap.ui.vk.CSSColor int sap.ui.vk.CSSColor[] int[] null

The new tint color of the nodes. The value can be defined as a string in the CSS color format or as an integer in the ABGR format or it could be array of these values. If null is passed then the tint color is reset and the node's own tint color should be used.

recursive boolean false

This flag indicates if the change needs to propagate recursively to child nodes.

setVisibilityState

Sets the visibility state of the nodes.

Param Type DefaultValue Description
nodeRefs any any[]

The node reference or the array of node references.

visible boolean boolean[]

The new visibility state or array of states of the nodes.

recursive boolean

The flags indicates if the change needs to propagate recursively to child nodes.

force boolean

If a node is made visible but its parent is hidden then it will still be hidden in Viewport. This flag will force node to be visible regardless of parent's state.