class sap.ui.vk.tools.ExplodeTool

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

Tool used to move objects in 3D space


Constructor

Constructor for a new ExplodeTool.

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

ID of the new tool instance. sIdis generated automatically if no non-empty ID is given. Note: this can be omitted, regardless of whether mSettings will be provided or not.

mSettings? object

An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance.


Properties

Name Type Default Value Description
anchor float[] 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1 Visibility: public
axis sap.ui.vk.tools.ExplodeAxis Visibility: public
direction sap.ui.vk.tools.ExplodeDirection Visibility: public
magnitude float 0 Visibility: public
type sap.ui.vk.tools.ExplodeType Linear Visibility: public

Borrowed Properties

Name Type Default Value Description
active boolean false

Used to control the tool rendering and interaction pipeline.

Visibility: public
footprint string[]

Used to decide whether this tool should be enabled for the target viewport.

Visibility: public
targetViewportType any Visibility: public
toolid string

GUID identifier for the tool to prevent naming conflicts.

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
items 0..n sap.ui.vk.tools.ExplodeItemGroup

Borrowed Aggregations

Name Cardinality Type Description
gizmo 0..1 sap.ui.vk.tools.Gizmo

sap.ui.vk.tools.Gizmo owned by this control and used for rendering floating UI


Associations

Name Cardinality Type Description
selectedItem 0..1 sap.ui.vk.tools.ExplodeItemGroup

Events Overview

Event Description
axisSelected
itemPositionAdjusted
itemPositionAdjusting
itemSequenceChangePressed
magnitudeChanged
magnitudeChanging

axisSelected

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
axis sap.ui.vk.tools.ExplodeAxis
direction sap.ui.vk.tools.ExplodeDirection

itemPositionAdjusted

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
item sap.ui.vk.tools.ExplodeItemGroup
magnitudeAdjustmentMultiplier float

itemPositionAdjusting

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
item sap.ui.vk.tools.ExplodeItemGroup
magnitudeAdjustmentMultiplier float

itemSequenceChangePressed

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
item sap.ui.vk.tools.ExplodeItemGroup
moveUp boolean

magnitudeChanged

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
type sap.ui.vk.tools.ExplodeType
axis sap.ui.vk.tools.ExplodeAxis
direction sap.ui.vk.tools.ExplodeDirection
magnitude float

magnitudeChanging

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
type sap.ui.vk.tools.ExplodeType
axis sap.ui.vk.tools.ExplodeAxis
direction sap.ui.vk.tools.ExplodeDirection
magnitude float

Methods Overview

Method Description
addItem

Adds some item to the aggregation items.

attachAxisSelected

Attaches event handler fnFunction to the axisSelected event of this sap.ui.vk.tools.ExplodeTool.

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.vk.tools.ExplodeTool itself.

attachItemPositionAdjusted

Attaches event handler fnFunction to the itemPositionAdjusted event of this sap.ui.vk.tools.ExplodeTool.

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.vk.tools.ExplodeTool itself.

attachItemPositionAdjusting

Attaches event handler fnFunction to the itemPositionAdjusting event of this sap.ui.vk.tools.ExplodeTool.

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.vk.tools.ExplodeTool itself.

attachItemSequenceChangePressed

Attaches event handler fnFunction to the itemSequenceChangePressed event of this sap.ui.vk.tools.ExplodeTool.

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.vk.tools.ExplodeTool itself.

attachMagnitudeChanged

Attaches event handler fnFunction to the magnitudeChanged event of this sap.ui.vk.tools.ExplodeTool.

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.vk.tools.ExplodeTool itself.

attachMagnitudeChanging

Attaches event handler fnFunction to the magnitudeChanging event of this sap.ui.vk.tools.ExplodeTool.

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.vk.tools.ExplodeTool itself.

destroyItems

Destroys all the items in the aggregation items.

detachAxisSelected

Detaches event handler fnFunction from the axisSelected event of this sap.ui.vk.tools.ExplodeTool.

The passed function and listener object must match the ones used for event registration.

detachItemPositionAdjusted

Detaches event handler fnFunction from the itemPositionAdjusted event of this sap.ui.vk.tools.ExplodeTool.

The passed function and listener object must match the ones used for event registration.

detachItemPositionAdjusting

Detaches event handler fnFunction from the itemPositionAdjusting event of this sap.ui.vk.tools.ExplodeTool.

The passed function and listener object must match the ones used for event registration.

detachItemSequenceChangePressed

Detaches event handler fnFunction from the itemSequenceChangePressed event of this sap.ui.vk.tools.ExplodeTool.

The passed function and listener object must match the ones used for event registration.

detachMagnitudeChanged

Detaches event handler fnFunction from the magnitudeChanged event of this sap.ui.vk.tools.ExplodeTool.

The passed function and listener object must match the ones used for event registration.

detachMagnitudeChanging

Detaches event handler fnFunction from the magnitudeChanging event of this sap.ui.vk.tools.ExplodeTool.

The passed function and listener object must match the ones used for event registration.

sap.ui.vk.tools.ExplodeTool.extend

Creates a new subclass of class sap.ui.vk.tools.ExplodeTool 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.tools.Tool.extend.

fireAxisSelected

Fires event axisSelected to attached listeners.

fireItemPositionAdjusted

Fires event itemPositionAdjusted to attached listeners.

fireItemPositionAdjusting

Fires event itemPositionAdjusting to attached listeners.

fireItemSequenceChangePressed

Fires event itemSequenceChangePressed to attached listeners.

fireMagnitudeChanged

Fires event magnitudeChanged to attached listeners.

fireMagnitudeChanging

Fires event magnitudeChanging to attached listeners.

getAnchor

Gets current value of property anchor.

Default value is [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1].

getAxis

Gets current value of property axis.

getDirection

Gets current value of property direction.

getItems

Gets content of aggregation items.

getMagnitude

Gets current value of property magnitude.

Default value is 0.0.

sap.ui.vk.tools.ExplodeTool.getMetadata

Returns a metadata object for class sap.ui.vk.tools.ExplodeTool.

getSelectedItem

ID of the element which is the current target of the association selectedItem, or null.

getType

Gets current value of property type.

Default value is Linear.

indexOfItem

Checks for the provided sap.ui.vk.tools.ExplodeItemGroup in the aggregation items. and returns its index if found or -1 otherwise.

insertItem

Inserts a item into the aggregation items.

queueCommand

MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should be called using this method.

removeAllItems

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

removeItem

Removes a item from the aggregation items.

setAnchor

Sets a new value for property anchor.

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

Default value is [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1].

setAxis

Sets a new value for property axis.

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

setDirection

Sets a new value for property direction.

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

setMagnitude

Sets a new value for property magnitude.

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

Default value is 0.0.

setSelectedItem

Sets the associated selectedItem.

setType

Sets a new value for property type.

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

Default value is Linear.

addItem

Adds some item to the aggregation items.

Param Type DefaultValue Description
oItem sap.ui.vk.tools.ExplodeItemGroup

The item to add; if empty, nothing is inserted

attachAxisSelected

Attaches event handler fnFunction to the axisSelected event of this sap.ui.vk.tools.ExplodeTool.

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.vk.tools.ExplodeTool itself.

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 sap.ui.vk.tools.ExplodeTool itself

attachItemPositionAdjusted

Attaches event handler fnFunction to the itemPositionAdjusted event of this sap.ui.vk.tools.ExplodeTool.

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.vk.tools.ExplodeTool itself.

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 sap.ui.vk.tools.ExplodeTool itself

attachItemPositionAdjusting

Attaches event handler fnFunction to the itemPositionAdjusting event of this sap.ui.vk.tools.ExplodeTool.

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.vk.tools.ExplodeTool itself.

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 sap.ui.vk.tools.ExplodeTool itself

attachItemSequenceChangePressed

Attaches event handler fnFunction to the itemSequenceChangePressed event of this sap.ui.vk.tools.ExplodeTool.

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.vk.tools.ExplodeTool itself.

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 sap.ui.vk.tools.ExplodeTool itself

attachMagnitudeChanged

Attaches event handler fnFunction to the magnitudeChanged event of this sap.ui.vk.tools.ExplodeTool.

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.vk.tools.ExplodeTool itself.

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 sap.ui.vk.tools.ExplodeTool itself

attachMagnitudeChanging

Attaches event handler fnFunction to the magnitudeChanging event of this sap.ui.vk.tools.ExplodeTool.

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.vk.tools.ExplodeTool itself.

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 sap.ui.vk.tools.ExplodeTool itself

destroyItems

Destroys all the items in the aggregation items.

detachAxisSelected

Detaches event handler fnFunction from the axisSelected event of this sap.ui.vk.tools.ExplodeTool.

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

detachItemPositionAdjusted

Detaches event handler fnFunction from the itemPositionAdjusted event of this sap.ui.vk.tools.ExplodeTool.

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

detachItemPositionAdjusting

Detaches event handler fnFunction from the itemPositionAdjusting event of this sap.ui.vk.tools.ExplodeTool.

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

detachItemSequenceChangePressed

Detaches event handler fnFunction from the itemSequenceChangePressed event of this sap.ui.vk.tools.ExplodeTool.

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

detachMagnitudeChanged

Detaches event handler fnFunction from the magnitudeChanged event of this sap.ui.vk.tools.ExplodeTool.

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

detachMagnitudeChanging

Detaches event handler fnFunction from the magnitudeChanging event of this sap.ui.vk.tools.ExplodeTool.

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

sap.ui.vk.tools.ExplodeTool.extend

Creates a new subclass of class sap.ui.vk.tools.ExplodeTool 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.tools.Tool.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

fireAxisSelected

Fires event axisSelected to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

axis sap.ui.vk.tools.ExplodeAxis
direction sap.ui.vk.tools.ExplodeDirection

fireItemPositionAdjusted

Fires event itemPositionAdjusted to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

item sap.ui.vk.tools.ExplodeItemGroup
magnitudeAdjustmentMultiplier float

fireItemPositionAdjusting

Fires event itemPositionAdjusting to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

item sap.ui.vk.tools.ExplodeItemGroup
magnitudeAdjustmentMultiplier float

fireItemSequenceChangePressed

Fires event itemSequenceChangePressed to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

item sap.ui.vk.tools.ExplodeItemGroup
moveUp boolean

fireMagnitudeChanged

Fires event magnitudeChanged to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

type sap.ui.vk.tools.ExplodeType
axis sap.ui.vk.tools.ExplodeAxis
direction sap.ui.vk.tools.ExplodeDirection
magnitude float

fireMagnitudeChanging

Fires event magnitudeChanging to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

type sap.ui.vk.tools.ExplodeType
axis sap.ui.vk.tools.ExplodeAxis
direction sap.ui.vk.tools.ExplodeDirection
magnitude float

getAnchor

Gets current value of property anchor.

Default value is [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1].

getAxis

Gets current value of property axis.

getDirection

Gets current value of property direction.

getItems

Gets content of aggregation items.

getMagnitude

Gets current value of property magnitude.

Default value is 0.0.

sap.ui.vk.tools.ExplodeTool.getMetadata

Returns a metadata object for class sap.ui.vk.tools.ExplodeTool.

getSelectedItem

ID of the element which is the current target of the association selectedItem, or null.

getType

Gets current value of property type.

Default value is Linear.

indexOfItem

Checks for the provided sap.ui.vk.tools.ExplodeItemGroup in the aggregation items. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oItem sap.ui.vk.tools.ExplodeItemGroup

The item whose index is looked for

insertItem

Inserts a item into the aggregation items.

Param Type DefaultValue Description
oItem sap.ui.vk.tools.ExplodeItemGroup

The item to insert; if empty, nothing is inserted

iIndex int

The 0-based index the item should be inserted at; for a negative value of iIndex, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position

queueCommand

MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should be called using this method.

Param Type DefaultValue Description
command function

The command to be executed.

removeAllItems

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

removeItem

Removes a item from the aggregation items.

Param Type DefaultValue Description
vItem int string sap.ui.vk.tools.ExplodeItemGroup

The item to remove or its index or id

setAnchor

Sets a new value for property anchor.

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

Default value is [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1].

Param Type DefaultValue Description
sAnchor float[] [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]

New value for property anchor

setAxis

Sets a new value for property axis.

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

Param Type DefaultValue Description
sAxis sap.ui.vk.tools.ExplodeAxis

New value for property axis

setDirection

Sets a new value for property direction.

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

Param Type DefaultValue Description
sDirection sap.ui.vk.tools.ExplodeDirection

New value for property direction

setMagnitude

Sets a new value for property magnitude.

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

Default value is 0.0.

Param Type DefaultValue Description
fMagnitude float 0.0

New value for property magnitude

setSelectedItem

Sets the associated selectedItem.

Param Type DefaultValue Description
oSelectedItem sap.ui.core.ID sap.ui.vk.tools.ExplodeItemGroup

ID of an element which becomes the new target of this selectedItem association; alternatively, an element instance may be given

setType

Sets a new value for property type.

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

Default value is Linear.

Param Type DefaultValue Description
sType sap.ui.vk.tools.ExplodeType Linear

New value for property type