Tool used to move objects in 3D space
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. |
|
mSettings? | object | An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. |
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 |
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 |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
items | 0..n | sap.ui.vk.tools.ExplodeItemGroup |
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 |
Event | Description |
---|---|
axisSelected | |
itemPositionAdjusted | |
itemPositionAdjusting | |
itemSequenceChangePressed | |
magnitudeChanged | |
magnitudeChanging |
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 |
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
item | sap.ui.vk.tools.ExplodeItemGroup | |
magnitudeAdjustmentMultiplier | float |
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
item | sap.ui.vk.tools.ExplodeItemGroup | |
magnitudeAdjustmentMultiplier | float |
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
item | sap.ui.vk.tools.ExplodeItemGroup | |
moveUp | boolean |
Method | Description |
---|---|
addItem |
Adds some item to the aggregation items. |
attachAxisSelected |
Attaches event handler When called, the context of the event handler (its |
attachItemPositionAdjusted |
Attaches event handler When called, the context of the event handler (its |
attachItemPositionAdjusting |
Attaches event handler When called, the context of the event handler (its |
attachItemSequenceChangePressed |
Attaches event handler When called, the context of the event handler (its |
attachMagnitudeChanged |
Attaches event handler When called, the context of the event handler (its |
attachMagnitudeChanging |
Attaches event handler When called, the context of the event handler (its |
destroyItems |
Destroys all the items in the aggregation items. |
detachAxisSelected |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachItemPositionAdjusted |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachItemPositionAdjusting |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachItemSequenceChangePressed |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachMagnitudeChanged |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachMagnitudeChanging |
Detaches event handler 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
|
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 |
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 |
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 |
getType |
Gets current value of property type. Default value is |
indexOfItem |
Checks for the provided |
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 Default value is |
setAxis |
Sets a new value for property axis. When called with a value of |
setDirection |
Sets a new value for property direction. When called with a value of |
setMagnitude |
Sets a new value for property magnitude. When called with a value of Default value is |
setSelectedItem |
Sets the associated selectedItem. |
setType |
Sets a new value for property type. When called with a value of Default value is |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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]
.
Returns a metadata object for class sap.ui.vk.tools.ExplodeTool.
ID of the element which is the current target of the association selectedItem, or null
.
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 |
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 |
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. |
Removes all the controls from the aggregation items.
Additionally, it unregisters them from the hosting UIArea.
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 |
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 |
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 |
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 |
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 |
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 |
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 |