A control that contains a 3D viewport.
This class is not intended to be instantiated directly by application code. A sap.ui.vtm.Viewport object is created when a sap.ui.vtm.Panel object is instantiated.
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.Viewport()
Name | Type | Default Value | Description |
---|---|---|---|
backgroundGradientBottomColor | sap.ui.core.CSSColor | white | The background gradient bottom color Visibility: public |
backgroundGradientTopColor | sap.ui.core.CSSColor | black | The background gradient top color. Visibility: public |
contextDisplayGroups | object[] | Allows the calculated display state for scene nodes whose display state is not determined by tree item associations or override display groups to be specified. A set of sap.ui.vtm.DisplayGroup objects objects that describe display states to apply to scene nodes. Precedence is inherent in the array ordering. Call #refresh to recalculate the display state in the viewport after modifying override display groups. Visibility: public |
|
overrideDisplayGroups | object[] | Allows the calculated display state of scene nodes in the viewport o be overridden. A set of sap.ui.vtm.DisplayGroup objects that each specify the display state for a set of scene nodes. Precedence is inherent in the array ordering. Any display state specified in this way takes precedence over display states specified for geometry associated with tree items or specified using #contextGroups. Call #refresh to recalculate the display state in the viewport after modifying override display groups. Visibility: public |
Name | Cardinality | Type | Description |
---|---|---|---|
headerControls | 0..n | sap.ui.core.Control |
A set of controls such as toolbars to appear above the 3D viewport. |
Event | Description |
---|---|
beginGesture |
Raised when a gesture begins. |
endGesture |
Raised when a gesture ends. |
hover |
Raised on mouse move over viewport. |
nodeClicked |
Raised when a node in the viewport is clicked. |
refreshRequested |
Raised when refresh is called. This event can be used by code that is managing the viewport display state. |
selectionChanged |
Raised when the selection is changed due to a click in the viewport (either on a node or in empty space). |
viewChanged |
Raised when viewport's camera view changed. |
visibilityChanged |
Raised when the visibility of scene nodes changed in the viewport. |
Raised when a gesture begins.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object |
Raised when a gesture ends.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object |
Raised on mouse move over viewport.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
x | float |
Mouse X-coordinate within viewport |
y | float |
Mouse Y-coordinate within viewport |
nodeId | string |
The ID of the node that is under the viewport coordinates (x, y). |
Raised when a node in the viewport is clicked.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object |
Raised when refresh is called. This event can be used by code that is managing the viewport display state.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object |
Raised when the selection is changed due to a click in the viewport (either on a node or in empty space).
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
selectedIds | string[] |
IDs of newly selected nodes. |
unselectedIds | string[] |
IDs of newly unselected nodes. |
userInteraction | boolean |
|
Raised when viewport's camera view changed.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
cameraInfo | object |
Information about the current camera view. Can be passed to setCameraInfo. |
Raised when the visibility of scene nodes changed in the viewport.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
visibleIds | string[] |
The IDs of newly shown nodes. |
hiddenIds | string[] |
The IDs of newly hidden nodes. |
userInteraction | boolean |
|
Method | Description |
---|---|
addContextDisplayGroup |
Adds an override display group to the |
addHeaderControl |
Adds some headerControl into the association headerControls. |
addOverrideDisplayGroup |
Adds an override display group to the |
attachBeginGesture |
Attaches event handler When called, the context of the event handler (its Raised when a gesture begins. |
attachEndGesture |
Attaches event handler When called, the context of the event handler (its Raised when a gesture ends. |
attachHover |
Attaches event handler When called, the context of the event handler (its Raised on mouse move over viewport. |
attachNodeClicked |
Attaches event handler When called, the context of the event handler (its Raised when a node in the viewport is clicked. |
attachRefreshRequested |
Attaches event handler When called, the context of the event handler (its Raised when refresh is called. This event can be used by code that is managing the viewport display state. |
attachSelectionChanged |
Attaches event handler When called, the context of the event handler (its Raised when the selection is changed due to a click in the viewport (either on a node or in empty space). |
attachViewChanged |
Attaches event handler When called, the context of the event handler (its Raised when viewport's camera view changed. |
attachVisibilityChanged |
Attaches event handler When called, the context of the event handler (its Raised when the visibility of scene nodes changed in the viewport. |
detachBeginGesture |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachEndGesture |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachHover |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachNodeClicked |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachRefreshRequested |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachSelectionChanged |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachViewChanged |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachVisibilityChanged |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.ui.vtm.Viewport.extend |
Creates a new subclass of class sap.ui.vtm.Viewport with name
|
fireBeginGesture |
Fires event beginGesture to attached listeners. |
fireEndGesture |
Fires event endGesture to attached listeners. |
fireHover |
Fires event hover to attached listeners. |
fireNodeClicked |
Fires event nodeClicked to attached listeners. |
fireRefreshRequested |
Fires event refreshRequested to attached listeners. |
fireSelectionChanged |
Fires event selectionChanged to attached listeners. |
fireViewChanged |
Fires event viewChanged to attached listeners. |
fireVisibilityChanged |
Fires event visibilityChanged to attached listeners. |
getBackgroundGradientBottomColor |
Gets current value of property backgroundGradientBottomColor. The background gradient bottom color Default value is |
getBackgroundGradientTopColor |
Gets current value of property backgroundGradientTopColor. The background gradient top color. Default value is |
getCameraInfo |
Retrieves an object containing the current camera information for this viewport. This value can then be passed to setCameraInfo to restore the camera position at a later point in time. |
getContextDisplayGroups |
Gets current value of property contextDisplayGroups. Allows the calculated display state for scene nodes whose display state is not determined by tree item associations or override display groups to be specified. A set of sap.ui.vtm.DisplayGroup objects objects that describe display states to apply to scene nodes. Precedence is inherent in the array ordering. Call #refresh to recalculate the display state in the viewport after modifying override display groups. Default value is |
getHeaderControls |
Returns array of IDs of the elements which are the current targets of the association headerControls. |
getHighlightColor |
Gets the highlight colors for a set of scene nodes in this viewport. |
getInitialized |
Returns whether the sap.ui.vtm.Viewport has been initialized. |
sap.ui.vtm.Viewport.getMetadata |
Returns a metadata object for class sap.ui.vtm.Viewport. |
getOpacity |
Gets the opacity for a set of scene nodes in this viewport. Opacity is specified as a floating point value in the interval [0,1]. |
getOverrideDisplayGroups |
Gets current value of property overrideDisplayGroups. Allows the calculated display state of scene nodes in the viewport o be overridden. A set of sap.ui.vtm.DisplayGroup objects that each specify the display state for a set of scene nodes. Precedence is inherent in the array ordering. Any display state specified in this way takes precedence over display states specified for geometry associated with tree items or specified using #contextGroups. Call #refresh to recalculate the display state in the viewport after modifying override display groups. Default value is |
getPanel |
Gets the panel this viewport belongs to. |
getScene |
Gets the sap.ui.vtm.Scene used by this sap.ui.vtm.Viewport. |
getSelected |
Gets the selection state for a set of scene nodes in this viewport. |
getSelectedIds |
Gets the IDs of the scene nodes that are selected in this viewport. |
getVisibility |
Gets the visibility state for a set of scene nodes in this viewport. |
refresh |
Fires a |
removeAllHeaderControls |
Removes all the controls in the association named headerControls. |
removeHeaderControl |
Removes an headerControl from the association named headerControls. |
setBackgroundGradientBottomColor |
Sets a new value for property backgroundGradientBottomColor. The background gradient bottom color When called with a value of Default value is |
setBackgroundGradientTopColor |
Sets a new value for property backgroundGradientTopColor. The background gradient top color. When called with a value of Default value is |
setCameraInfo |
Updates the camera for this viewport. |
setContextDisplayGroups |
Sets a new value for property contextDisplayGroups. Allows the calculated display state for scene nodes whose display state is not determined by tree item associations or override display groups to be specified. A set of sap.ui.vtm.DisplayGroup objects objects that describe display states to apply to scene nodes. Precedence is inherent in the array ordering. Call #refresh to recalculate the display state in the viewport after modifying override display groups. When called with a value of Default value is |
setHighlightColor |
Sets the highlight color for a set of scene nodes in this viewport. This method should not be called by application code when an extension implementing sap.ui.vtm.interfaces.IDisplayStateCalculationExtension is being used. In that case the extension implementing sap.ui.vtm.interfaces.IDisplayStateCalculationExtension should perform all management of scene node visibility in the viewports. |
setOpacity |
Sets the opacity for a set of scene nodes in this viewport. Opacity is specified as a floating point value in the interval [0,1]. This method should not be called by application code when an extension implementing sap.ui.vtm.interfaces.IDisplayStateCalculationExtension is being used. In that case the extension implementing sap.ui.vtm.interfaces.IDisplayStateCalculationExtension should perform all management of scene node visibility in the viewports. |
setOverrideDisplayGroups |
Sets a new value for property overrideDisplayGroups. Allows the calculated display state of scene nodes in the viewport o be overridden. A set of sap.ui.vtm.DisplayGroup objects that each specify the display state for a set of scene nodes. Precedence is inherent in the array ordering. Any display state specified in this way takes precedence over display states specified for geometry associated with tree items or specified using #contextGroups. Call #refresh to recalculate the display state in the viewport after modifying override display groups. When called with a value of Default value is |
setPredefinedView |
Sets the view in the current viewport to one of the predefined views. |
setSelected |
Sets the selection state for a set of scene nodes in this viewport. This method should not be called by application code when an extension implementing sap.ui.vtm.interfaces.IViewportSelectionLinkingExtension is being used. In that case the extension implementing sap.ui.vtm.interfaces.IViewportSelectionLinkingExtension should perform all management of scene node selection in the viewports. |
setVisibility |
Sets the visibility state for a set of scene nodes in this viewport. This method should not be called by application code when an extension implementing sap.ui.vtm.interfaces.IDisplayStateCalculationExtension is being used. In that case the extension implementing sap.ui.vtm.interfaces.IDisplayStateCalculationExtension should perform all management of scene node visibility in the viewports. |
zoomToAll |
Zooms to a view in the current viewport that can fit all geometry in the scene (visible or not). |
zoomToFit |
Calls zoomToSelected if any geometry is selected in this viewport, otherwise calls zoomToAll. |
zoomToSelected |
Zooms to the set of geometry that is selected in the current viewport. If no geometry is selected, no action is taken. |
zoomToVisible |
Zooms to the set of geometry that is visible in the current viewport. If no geometry is visible, this zooms to all geometry in the current viewport. |
Adds an override display group to the overrideDisplayGroups
property.
Param | Type | DefaultValue | Description |
---|---|---|---|
contextDisplayGroup | sap.ui.vtm.DisplayGroup |
The context display group to add to the |
Adds some headerControl into the association headerControls.
Param | Type | DefaultValue | Description |
---|---|---|---|
vHeaderControl | sap.ui.core.ID sap.ui.core.Control |
The headerControls to add; if empty, nothing is inserted |
Adds an override display group to the overrideDisplayGroups
property.
Param | Type | DefaultValue | Description |
---|---|---|---|
overrideDisplayGroup | sap.ui.vtm.DisplayGroup |
The override display group to add to the |
Attaches event handler fnFunction
to the beginGesture event of this sap.ui.vtm.Viewport
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.vtm.Viewport
itself.
Raised when a gesture begins.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the endGesture event of this sap.ui.vtm.Viewport
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.vtm.Viewport
itself.
Raised when a gesture ends.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the hover event of this sap.ui.vtm.Viewport
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.vtm.Viewport
itself.
Raised on mouse move over viewport.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the nodeClicked event of this sap.ui.vtm.Viewport
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.vtm.Viewport
itself.
Raised when a node in the viewport is clicked.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the refreshRequested event of this sap.ui.vtm.Viewport
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.vtm.Viewport
itself.
Raised when refresh is called. This event can be used by code that is managing the viewport display state.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the selectionChanged event of this sap.ui.vtm.Viewport
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.vtm.Viewport
itself.
Raised when the selection is changed due to a click in the viewport (either on a node or in empty space).
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the viewChanged event of this sap.ui.vtm.Viewport
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.vtm.Viewport
itself.
Raised when viewport's camera view changed.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the visibilityChanged event of this sap.ui.vtm.Viewport
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.vtm.Viewport
itself.
Raised when the visibility of scene nodes changed in the viewport.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Detaches event handler fnFunction
from the beginGesture event of this sap.ui.vtm.Viewport
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the endGesture event of this sap.ui.vtm.Viewport
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the hover event of this sap.ui.vtm.Viewport
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the nodeClicked event of this sap.ui.vtm.Viewport
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the refreshRequested event of this sap.ui.vtm.Viewport
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the selectionChanged event of this sap.ui.vtm.Viewport
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the viewChanged event of this sap.ui.vtm.Viewport
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the visibilityChanged event of this sap.ui.vtm.Viewport
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Creates a new subclass of class sap.ui.vtm.Viewport 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.Control.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 |
Fires event beginGesture to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Fires event endGesture to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Fires event hover to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
x | float |
Mouse X-coordinate within viewport |
|
y | float |
Mouse Y-coordinate within viewport |
|
nodeId | string |
The ID of the node that is under the viewport coordinates (x, y). |
Fires event nodeClicked to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Fires event refreshRequested to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Fires event selectionChanged to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
selectedIds | string[] |
IDs of newly selected nodes. |
|
unselectedIds | string[] |
IDs of newly unselected nodes. |
|
userInteraction | boolean |
|
Fires event viewChanged to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
cameraInfo | object |
Information about the current camera view. Can be passed to setCameraInfo. |
Fires event visibilityChanged to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
visibleIds | string[] |
The IDs of newly shown nodes. |
|
hiddenIds | string[] |
The IDs of newly hidden nodes. |
|
userInteraction | boolean |
|
Gets current value of property backgroundGradientBottomColor.
The background gradient bottom color
Default value is "white"
.
Gets current value of property backgroundGradientTopColor.
The background gradient top color.
Default value is "black"
.
Retrieves an object containing the current camera information for this viewport.
This value can then be passed to setCameraInfo to restore the camera position at a later point in time.
Gets current value of property contextDisplayGroups.
Allows the calculated display state for scene nodes whose display state is not determined by tree item associations or override display groups to be specified.
A set of sap.ui.vtm.DisplayGroup objects objects that describe display states to apply to scene nodes. Precedence is inherent in the array ordering. Call #refresh to recalculate the display state in the viewport after modifying override display groups.
Default value is []
.
Returns array of IDs of the elements which are the current targets of the association headerControls.
Gets the highlight colors for a set of scene nodes in this viewport.
Param | Type | DefaultValue | Description |
---|---|---|---|
sceneNodeIds | string string[] |
A scene node ID or an array of scene node IDs. |
Gets the opacity for a set of scene nodes in this viewport. Opacity is specified as a floating point value in the interval [0,1].
Param | Type | DefaultValue | Description |
---|---|---|---|
sceneNodeIds | string string[] |
A scene node ID or an array of scene node IDs. |
Gets current value of property overrideDisplayGroups.
Allows the calculated display state of scene nodes in the viewport o be overridden.
A set of sap.ui.vtm.DisplayGroup objects that each specify the display state for a set of scene nodes. Precedence is inherent in the array ordering. Any display state specified in this way takes precedence over display states specified for geometry associated with tree items or specified using #contextGroups. Call #refresh to recalculate the display state in the viewport after modifying override display groups.
Default value is []
.
Gets the selection state for a set of scene nodes in this viewport.
Param | Type | DefaultValue | Description |
---|---|---|---|
sceneNodeIds | string string[] |
A scene node ID or an array of scene node IDs. |
Gets the visibility state for a set of scene nodes in this viewport.
Param | Type | DefaultValue | Description |
---|---|---|---|
sceneNodeIds | string string[] |
A scene node ID or an array of scene node IDs. |
Removes an headerControl from the association named headerControls.
Param | Type | DefaultValue | Description |
---|---|---|---|
vHeaderControl | int sap.ui.core.ID sap.ui.core.Control |
The headerControl to be removed or its index or ID |
Sets a new value for property backgroundGradientBottomColor.
The background gradient bottom color
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is "white"
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sBackgroundGradientBottomColor | sap.ui.core.CSSColor | "white" |
New value for property |
Sets a new value for property backgroundGradientTopColor.
The background gradient top color.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is "black"
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sBackgroundGradientTopColor | sap.ui.core.CSSColor | "black" |
New value for property |
Updates the camera for this viewport.
Param | Type | DefaultValue | Description |
---|---|---|---|
cameraInfo | object |
An object containing camera information returned by getCameraInfo. |
|
flyToDuration | float |
A duration in seconds for the transition to the new camera position. Defaults to 0. |
Sets a new value for property contextDisplayGroups.
Allows the calculated display state for scene nodes whose display state is not determined by tree item associations or override display groups to be specified.
A set of sap.ui.vtm.DisplayGroup objects objects that describe display states to apply to scene nodes. Precedence is inherent in the array ordering. Call #refresh to recalculate the display state in the viewport after modifying override display groups.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is []
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sContextDisplayGroups | object[] | [] |
New value for property |
Sets the highlight color for a set of scene nodes in this viewport.
This method should not be called by application code when an extension implementing sap.ui.vtm.interfaces.IDisplayStateCalculationExtension is being used. In that case the extension implementing sap.ui.vtm.interfaces.IDisplayStateCalculationExtension should perform all management of scene node visibility in the viewports.
Param | Type | DefaultValue | Description |
---|---|---|---|
sceneNodeIds | string string[] |
A scene node ID or an array of scene node IDs. |
|
color | sap.ui.core.CSSColor null |
The highlight color to apply to the relevant scene nodes. If null, the highlight color is removed. |
|
recursive | boolean |
If true the specified highlight color will be applied to the descendants of the specified scene nodes. |
Sets the opacity for a set of scene nodes in this viewport. Opacity is specified as a floating point value in the interval [0,1].
This method should not be called by application code when an extension implementing sap.ui.vtm.interfaces.IDisplayStateCalculationExtension is being used. In that case the extension implementing sap.ui.vtm.interfaces.IDisplayStateCalculationExtension should perform all management of scene node visibility in the viewports.
Param | Type | DefaultValue | Description |
---|---|---|---|
sceneNodeIds | string string[] |
A scene node ID or an array of scene node IDs. |
|
opacity | number |
The opacity state to apply to the relevant scene nodes. |
|
recursive | boolean |
If true the specified opacity state will be applied to the descendants of the specified scene nodes. |
Sets a new value for property overrideDisplayGroups.
Allows the calculated display state of scene nodes in the viewport o be overridden.
A set of sap.ui.vtm.DisplayGroup objects that each specify the display state for a set of scene nodes. Precedence is inherent in the array ordering. Any display state specified in this way takes precedence over display states specified for geometry associated with tree items or specified using #contextGroups. Call #refresh to recalculate the display state in the viewport after modifying override display groups.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is []
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sOverrideDisplayGroups | object[] | [] |
New value for property |
Sets the view in the current viewport to one of the predefined views.
Param | Type | DefaultValue | Description |
---|---|---|---|
view | sap.ui.vtm.PredefinedView |
The predefined view to apply. |
Sets the selection state for a set of scene nodes in this viewport.
This method should not be called by application code when an extension implementing sap.ui.vtm.interfaces.IViewportSelectionLinkingExtension is being used. In that case the extension implementing sap.ui.vtm.interfaces.IViewportSelectionLinkingExtension should perform all management of scene node selection in the viewports.
Param | Type | DefaultValue | Description |
---|---|---|---|
sceneNodeIds | string string[] |
A scene node ID or an array of scene node IDs. |
|
selected | boolean |
The new selection state of the nodes. |
|
recursive | boolean |
The flags indicates if the change needs to propagate recursively to child nodes. |
Sets the visibility state for a set of scene nodes in this viewport.
This method should not be called by application code when an extension implementing sap.ui.vtm.interfaces.IDisplayStateCalculationExtension is being used. In that case the extension implementing sap.ui.vtm.interfaces.IDisplayStateCalculationExtension should perform all management of scene node visibility in the viewports.
Param | Type | DefaultValue | Description |
---|---|---|---|
sceneNodeIds | string string[] |
A scene node ID or an array of scene node IDs. |
|
visibility | boolean |
The visibility state to apply to the relevant scene nodes. |
|
recursive | boolean |
If true the specified visibility state will be applied to the descendants of the specified scene nodes. |
Zooms to a view in the current viewport that can fit all geometry in the scene (visible or not).
Param | Type | DefaultValue | Description |
---|---|---|---|
durationInSeconds | number |
The duration of the zoom animation in seconds. |
Calls zoomToSelected if any geometry is selected in this viewport, otherwise calls zoomToAll.
Param | Type | DefaultValue | Description |
---|---|---|---|
durationInSeconds | number |
The duration of the zoom animation in seconds. |