class sap.ui.vtm.extensions.SceneNodeHoverHighlightExtension

Visiblity: public
UX Guidelines:
Implements: sap.ui.vtm.interfaces.ISceneNodeHoverHighlightExtension
Available since: N/A
Module: sap/ui/vtm/extensions/SceneNodeHoverHighlightExtension
Application Component:

Adds a behaviour which highlights a scene node when the mouse hovers over it.


Constructor

Constructor for a new SceneNodeHoverTooltipExtension.

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

id for the new instance.

mSettings object

Object with initial property values, aggregated objects etc. for the new instance.


Properties

Name Type Default Value Description
highlightColor sap.ui.core.CSSColor rgba(0, 0, 255, 0.7)

The highlight color to use for the scene node being hovered over.

Visibility: public

Borrowed Properties

Name Type Default Value Description
enabled boolean true

Controls whether the extension is enabled.

Visibility: public

Methods Overview

Method Description
sap.ui.vtm.extensions.SceneNodeHoverHighlightExtension.extend

Creates a new subclass of class sap.ui.vtm.extensions.SceneNodeHoverHighlightExtension 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.vtm.Extension.extend.

getHighlightColor

Gets current value of property highlightColor.

The highlight color to use for the scene node being hovered over.

Default value is "rgba(0, 0, 255, 0.7)".

sap.ui.vtm.extensions.SceneNodeHoverHighlightExtension.getMetadata

Returns a metadata object for class sap.ui.vtm.extensions.SceneNodeHoverHighlightExtension.

setHighlightColor

Sets a new value for property highlightColor.

The highlight color to use for the scene node being hovered over.

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

Default value is "rgba(0, 0, 255, 0.7)".

sap.ui.vtm.extensions.SceneNodeHoverHighlightExtension.extend

Creates a new subclass of class sap.ui.vtm.extensions.SceneNodeHoverHighlightExtension 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.vtm.Extension.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 current value of property highlightColor.

The highlight color to use for the scene node being hovered over.

Default value is "rgba(0, 0, 255, 0.7)".

sap.ui.vtm.extensions.SceneNodeHoverHighlightExtension.getMetadata

Returns a metadata object for class sap.ui.vtm.extensions.SceneNodeHoverHighlightExtension.

setHighlightColor

Sets a new value for property highlightColor.

The highlight color to use for the scene node being hovered over.

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

Default value is "rgba(0, 0, 255, 0.7)".

Param Type DefaultValue Description
sHighlightColor sap.ui.core.CSSColor "rgba(0, 0, 255, 0.7)"

New value for property highlightColor