Manages the visibility and selection states of nodes in the scene.
Constructor for a new ViewStateManager.
new sap.ui.vk.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. |
Method | Description |
---|---|
enumerateOutlinedNodes |
Enumerates IDs of the outlined nodes. |
enumerateSelection |
Enumerates IDs of the selected nodes. |
sap.ui.vk.ViewStateManager.extend |
Creates a new subclass of class sap.ui.vk.ViewStateManager with name
|
getAnimationPlayer |
Gets the Animation player associated with viewManager. |
getHighlightColor |
Gets the default highlighting color |
sap.ui.vk.ViewStateManager.getMetadata |
Returns a metadata object for class sap.ui.vk.ViewStateManager. |
getNodeHierarchy |
Gets the NodeHierarchy object associated with this ViewStateManager object. |
getOpacity |
Gets the opacity of the node. If a single node reference is passed to the method then a single value 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. |
getRestOpacity |
Get node's opacity stored in active view. |
getRestTransformation |
Get node's rest transformation stored in active view. |
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. |
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. |
getVisibilityChanges |
Gets the visibility changes in the current ViewStateManager object. |
getVisibilityState |
Gets the visibility state of nodes. If a single node reference is passed to the method then a single visibility state is returned. |
resetVisibility |
Resets the visibility states of all nodes to the initial states. |
restoreRestOpacity |
Replace node's current opacity with its rest opacity stored in active view.. |
restoreRestTransformation |
Replace node's current transformation with its rest transformation stored in active 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. |
setRestOpacity |
Set node's opacity stored in active view. |
setRestTransformation |
Set node's rest transformation stored in active view. |
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. |
updateRestOpacity |
Copy node's current opacity into its rest opacity stored in active view. |
updateRestTransformation |
Copy node's current transformation into its rest transformation stored in active view. |
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 |
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 |
Creates a new subclass of class sap.ui.vk.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 |
Gets the default highlighting color
Param | Type | DefaultValue | Description |
---|---|---|---|
inABGRFormat | boolean | false |
This flag indicates to return the default highlighting color in the ABGR format, if it equals |
Returns a metadata object for class sap.ui.vk.ViewStateManager.
Gets the opacity 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. |
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 |
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. |
Get node's opacity stored in active view.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRef | any |
The node reference. |
Get node's rest transformation stored in active view.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRef | any |
The node reference. |
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. |
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 |
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 |
Gets the visibility state of nodes.
If a single node reference is passed to the method then a single visibility state is returned.
If an array of node references 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. |
Replace node's current opacity with its rest opacity stored in active view..
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRef | any |
The node reference. |
Replace node's current transformation with its rest transformation stored in active view..
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRef | any |
The node reference. |
Sets the default highlighting color
Param | Type | DefaultValue | Description |
---|---|---|---|
color | sap.ui.vk.CSSColor string int |
The new default highlighting color. The value can be defined as a string in the CSS color format or as an integer in the ABGR format. If |
Sets the opacity of the nodes.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRefs | any any[] |
The node reference or the array of node references. |
|
opacity | float null |
The new opacity of the nodes. If |
|
recursive | boolean | false |
The flags indicates if the change needs to propagate recursively to child nodes. |
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 |
Sets the outline width
Param | Type | DefaultValue | Description |
---|---|---|---|
width | float |
Width of outline |
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 selected nodes. |
|
unoutlinedNodeRefs | 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. |
Set node's opacity stored in active view.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRef | any |
The node reference. |
|
opacity | float |
The node opacity |
Set node's rest transformation stored in active view.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRef | any |
The node reference. |
|
translation | float[] |
vector for position, array of size 3. |
|
quaternion | float[] |
quaternion for rotation, array of size 3. |
|
scale | float[] |
vector for scaling, array of size 3. |
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. |
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. |
Sets if showing the bounding box when nodes are selected
Param | Type | DefaultValue | Description |
---|---|---|---|
val | boolean |
|
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 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. If |
|
recursive | boolean | false |
This flag indicates if the change needs to propagate recursively to child nodes. |
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 |
The new visibility state 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. |