class sap.ui.vk.tools.MoveTool

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

Tool used to move objects in 3D space


Constructor

Constructor for a new MoveTool.

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.MoveTool(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
allowContextMenu boolean true

Whether or not to allow context menu on right-click

Visibility: public
autoResetValues boolean true

Determines if auto reset values mode is enabled

Visibility: public
coordinateSystem sap.ui.vk.tools.CoordinateSystem World

Select coordinate system in which this tool operates. Can be Local, World, Parent, Screen or Custom

Visibility: public
enableSnapping boolean false

Determines if snapping when moving is enabled

Visibility: public
enableStepping boolean false

If set to true values will change in round number increments instead of continual change

Visibility: public
nodeSet sap.ui.vk.tools.ToolNodeSet Highlight

Determine what set of nodes will be transformed with this tool

Visibility: public
placementMode sap.ui.vk.tools.GizmoPlacementMode Default

Sets the placement mode. Can be Default, ObjectCenter, or OnScreen

Visibility: public
showEditingUI boolean false

Display text box with current value, which can also be used to directly modify the value

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

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


Events Overview

Event Description
coordinateSystemChanged

This event will be fired when the coordinate system changes.

moved

This event will be fired when movement finished. This event contains parameter 'nodesProperties' that is array of objects, each object has four properties: {any} node: node reference, {float[]} offsetToRest, translate relative to rest position in local coordinates {float[]} offsetToPrevious, translate relative to end position of previous sequence or rest position if no previous sequence in local coordinates {float[]} absolute, translate in parent coordinates {float[]} world, translate in world coordinates {float[]} restDifference, change of rest position translation in parent coordinates {float[]} restDifferenceInCoordinates, change of rest position translation in current coordinates

moving

This event will be fired when movement occurs. This event contains parameter 'nodesProperties' that is array of objects, each object has four properties: {any} node: node reference, {float[]} offsetToRest, translate relative to rest position in local coordinates {float[]} offsetToPrevious, translate relative to end position of previous sequence or rest position if no previous sequence in local coordinates {float[]} absolute, translate in parent coordinates {float[]} world, translate in world coordinates {float[]} restDifference, change of rest position translation in parent coordinates {float[]} restDifferenceInCoordinates, change of rest position translation in current coordinates

placementModeChanged

coordinateSystemChanged

This event will be fired when the coordinate system changes.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
coordinateSystem sap.ui.vk.tools.CoordinateSystem

moved

This event will be fired when movement finished. This event contains parameter 'nodesProperties' that is array of objects, each object has four properties: {any} node: node reference, {float[]} offsetToRest, translate relative to rest position in local coordinates {float[]} offsetToPrevious, translate relative to end position of previous sequence or rest position if no previous sequence in local coordinates {float[]} absolute, translate in parent coordinates {float[]} world, translate in world coordinates {float[]} restDifference, change of rest position translation in parent coordinates {float[]} restDifferenceInCoordinates, change of rest position translation in current coordinates

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
x float
y float
z float
nodesProperties any[]

moving

This event will be fired when movement occurs. This event contains parameter 'nodesProperties' that is array of objects, each object has four properties: {any} node: node reference, {float[]} offsetToRest, translate relative to rest position in local coordinates {float[]} offsetToPrevious, translate relative to end position of previous sequence or rest position if no previous sequence in local coordinates {float[]} absolute, translate in parent coordinates {float[]} world, translate in world coordinates {float[]} restDifference, change of rest position translation in parent coordinates {float[]} restDifferenceInCoordinates, change of rest position translation in current coordinates

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
x float
y float
z float
nodesProperties any[]

placementModeChanged

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
placementMode sap.ui.vk.tools.GizmoPlacementMode

Methods Overview

Method Description
attachCoordinateSystemChanged

Attaches event handler fnFunction to the coordinateSystemChanged event of this sap.ui.vk.tools.MoveTool.

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.MoveTool itself.

This event will be fired when the coordinate system changes.

attachMoved

Attaches event handler fnFunction to the moved event of this sap.ui.vk.tools.MoveTool.

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.MoveTool itself.

This event will be fired when movement finished. This event contains parameter 'nodesProperties' that is array of objects, each object has four properties: {any} node: node reference, {float[]} offsetToRest, translate relative to rest position in local coordinates {float[]} offsetToPrevious, translate relative to end position of previous sequence or rest position if no previous sequence in local coordinates {float[]} absolute, translate in parent coordinates {float[]} world, translate in world coordinates {float[]} restDifference, change of rest position translation in parent coordinates {float[]} restDifferenceInCoordinates, change of rest position translation in current coordinates

attachMoving

Attaches event handler fnFunction to the moving event of this sap.ui.vk.tools.MoveTool.

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.MoveTool itself.

This event will be fired when movement occurs. This event contains parameter 'nodesProperties' that is array of objects, each object has four properties: {any} node: node reference, {float[]} offsetToRest, translate relative to rest position in local coordinates {float[]} offsetToPrevious, translate relative to end position of previous sequence or rest position if no previous sequence in local coordinates {float[]} absolute, translate in parent coordinates {float[]} world, translate in world coordinates {float[]} restDifference, change of rest position translation in parent coordinates {float[]} restDifferenceInCoordinates, change of rest position translation in current coordinates

attachPlacementModeChanged

Attaches event handler fnFunction to the placementModeChanged event of this sap.ui.vk.tools.MoveTool.

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.MoveTool itself.

detachCoordinateSystemChanged

Detaches event handler fnFunction from the coordinateSystemChanged event of this sap.ui.vk.tools.MoveTool.

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

detachMoved

Detaches event handler fnFunction from the moved event of this sap.ui.vk.tools.MoveTool.

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

detachMoving

Detaches event handler fnFunction from the moving event of this sap.ui.vk.tools.MoveTool.

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

detachPlacementModeChanged

Detaches event handler fnFunction from the placementModeChanged event of this sap.ui.vk.tools.MoveTool.

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

sap.ui.vk.tools.MoveTool.extend

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

fireCoordinateSystemChanged

Fires event coordinateSystemChanged to attached listeners.

fireMoved

Fires event moved to attached listeners.

fireMoving

Fires event moving to attached listeners.

firePlacementModeChanged

Fires event placementModeChanged to attached listeners.

getAllowContextMenu

Gets current value of property allowContextMenu.

Whether or not to allow context menu on right-click

Default value is true.

getAutoResetValues

Gets current value of property autoResetValues.

Determines if auto reset values mode is enabled

Default value is true.

getCoordinateSystem

Gets current value of property coordinateSystem.

Select coordinate system in which this tool operates. Can be Local, World, Parent, Screen or Custom

Default value is World.

getEnableSnapping

Gets current value of property enableSnapping.

Determines if snapping when moving is enabled

Default value is false.

getEnableStepping

Gets current value of property enableStepping.

If set to true values will change in round number increments instead of continual change

Default value is false.

sap.ui.vk.tools.MoveTool.getMetadata

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

getNodeSet

Gets current value of property nodeSet.

Determine what set of nodes will be transformed with this tool

Default value is Highlight.

getPlacementMode

Gets current value of property placementMode.

Sets the placement mode. Can be Default, ObjectCenter, or OnScreen

Default value is Default.

getShowEditingUI

Gets current value of property showEditingUI.

Display text box with current value, which can also be used to directly modify the value

Default value is false.

move

Performs movement of selected objects.

queueCommand

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

setAllowContextMenu

Sets a new value for property allowContextMenu.

Whether or not to allow context menu on right-click

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

Default value is true.

setAutoResetValues

Sets a new value for property autoResetValues.

Determines if auto reset values mode is enabled

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

Default value is true.

setCoordinateSystem

Sets a new value for property coordinateSystem.

Select coordinate system in which this tool operates. Can be Local, World, Parent, Screen or Custom

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

Default value is World.

setEnableSnapping

Sets a new value for property enableSnapping.

Determines if snapping when moving is enabled

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

Default value is false.

setEnableStepping

Sets a new value for property enableStepping.

If set to true values will change in round number increments instead of continual change

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

Default value is false.

setNodeSet

Sets a new value for property nodeSet.

Determine what set of nodes will be transformed with this tool

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

Default value is Highlight.

setPlacementMode

Sets a new value for property placementMode.

Sets the placement mode. Can be Default, ObjectCenter, or OnScreen

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

Default value is Default.

setShowEditingUI

Sets a new value for property showEditingUI.

Display text box with current value, which can also be used to directly modify the value

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

Default value is false.

attachCoordinateSystemChanged

Attaches event handler fnFunction to the coordinateSystemChanged event of this sap.ui.vk.tools.MoveTool.

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.MoveTool itself.

This event will be fired when the coordinate system changes.

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.MoveTool itself

attachMoved

Attaches event handler fnFunction to the moved event of this sap.ui.vk.tools.MoveTool.

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.MoveTool itself.

This event will be fired when movement finished. This event contains parameter 'nodesProperties' that is array of objects, each object has four properties: {any} node: node reference, {float[]} offsetToRest, translate relative to rest position in local coordinates {float[]} offsetToPrevious, translate relative to end position of previous sequence or rest position if no previous sequence in local coordinates {float[]} absolute, translate in parent coordinates {float[]} world, translate in world coordinates {float[]} restDifference, change of rest position translation in parent coordinates {float[]} restDifferenceInCoordinates, change of rest position translation in current coordinates

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.MoveTool itself

attachMoving

Attaches event handler fnFunction to the moving event of this sap.ui.vk.tools.MoveTool.

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.MoveTool itself.

This event will be fired when movement occurs. This event contains parameter 'nodesProperties' that is array of objects, each object has four properties: {any} node: node reference, {float[]} offsetToRest, translate relative to rest position in local coordinates {float[]} offsetToPrevious, translate relative to end position of previous sequence or rest position if no previous sequence in local coordinates {float[]} absolute, translate in parent coordinates {float[]} world, translate in world coordinates {float[]} restDifference, change of rest position translation in parent coordinates {float[]} restDifferenceInCoordinates, change of rest position translation in current coordinates

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.MoveTool itself

attachPlacementModeChanged

Attaches event handler fnFunction to the placementModeChanged event of this sap.ui.vk.tools.MoveTool.

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.MoveTool 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.MoveTool itself

detachCoordinateSystemChanged

Detaches event handler fnFunction from the coordinateSystemChanged event of this sap.ui.vk.tools.MoveTool.

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

detachMoved

Detaches event handler fnFunction from the moved event of this sap.ui.vk.tools.MoveTool.

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

detachMoving

Detaches event handler fnFunction from the moving event of this sap.ui.vk.tools.MoveTool.

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

detachPlacementModeChanged

Detaches event handler fnFunction from the placementModeChanged event of this sap.ui.vk.tools.MoveTool.

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.MoveTool.extend

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

fireCoordinateSystemChanged

Fires event coordinateSystemChanged to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

coordinateSystem sap.ui.vk.tools.CoordinateSystem

fireMoved

Fires event moved to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

x float
y float
z float
nodesProperties any[]

fireMoving

Fires event moving to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

x float
y float
z float
nodesProperties any[]

firePlacementModeChanged

Fires event placementModeChanged to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

placementMode sap.ui.vk.tools.GizmoPlacementMode

getAllowContextMenu

Gets current value of property allowContextMenu.

Whether or not to allow context menu on right-click

Default value is true.

getAutoResetValues

Gets current value of property autoResetValues.

Determines if auto reset values mode is enabled

Default value is true.

getCoordinateSystem

Gets current value of property coordinateSystem.

Select coordinate system in which this tool operates. Can be Local, World, Parent, Screen or Custom

Default value is World.

getEnableSnapping

Gets current value of property enableSnapping.

Determines if snapping when moving is enabled

Default value is false.

getEnableStepping

Gets current value of property enableStepping.

If set to true values will change in round number increments instead of continual change

Default value is false.

sap.ui.vk.tools.MoveTool.getMetadata

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

getNodeSet

Gets current value of property nodeSet.

Determine what set of nodes will be transformed with this tool

Default value is Highlight.

getPlacementMode

Gets current value of property placementMode.

Sets the placement mode. Can be Default, ObjectCenter, or OnScreen

Default value is Default.

getShowEditingUI

Gets current value of property showEditingUI.

Display text box with current value, which can also be used to directly modify the value

Default value is false.

move

Performs movement of selected objects.

Param Type DefaultValue Description
x float

Movement offset of x component in currently selected coordinate system.

y float

Movement offset of y component in currently selected coordinate system.

z float

Movement offset of z component in currently selected coordinate system.

coordinateSystem sap.ui.vk.tools.CoordinateSystem

Optional parameter to define coordinate system to be used when these coordinates are applied. If not specified then currently set coordinate system will be used.

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.

setAllowContextMenu

Sets a new value for property allowContextMenu.

Whether or not to allow context menu on right-click

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

Default value is true.

Param Type DefaultValue Description
bAllowContextMenu boolean true

New value for property allowContextMenu

setAutoResetValues

Sets a new value for property autoResetValues.

Determines if auto reset values mode is enabled

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

Default value is true.

Param Type DefaultValue Description
bAutoResetValues boolean true

New value for property autoResetValues

setCoordinateSystem

Sets a new value for property coordinateSystem.

Select coordinate system in which this tool operates. Can be Local, World, Parent, Screen or Custom

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

Default value is World.

Param Type DefaultValue Description
sCoordinateSystem sap.ui.vk.tools.CoordinateSystem World

New value for property coordinateSystem

setEnableSnapping

Sets a new value for property enableSnapping.

Determines if snapping when moving is enabled

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

Default value is false.

Param Type DefaultValue Description
bEnableSnapping boolean false

New value for property enableSnapping

setEnableStepping

Sets a new value for property enableStepping.

If set to true values will change in round number increments instead of continual change

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

Default value is false.

Param Type DefaultValue Description
bEnableStepping boolean false

New value for property enableStepping

setNodeSet

Sets a new value for property nodeSet.

Determine what set of nodes will be transformed with this tool

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

Default value is Highlight.

Param Type DefaultValue Description
sNodeSet sap.ui.vk.tools.ToolNodeSet Highlight

New value for property nodeSet

setPlacementMode

Sets a new value for property placementMode.

Sets the placement mode. Can be Default, ObjectCenter, or OnScreen

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

Default value is Default.

Param Type DefaultValue Description
sPlacementMode sap.ui.vk.tools.GizmoPlacementMode Default

New value for property placementMode

setShowEditingUI

Sets a new value for property showEditingUI.

Display text box with current value, which can also be used to directly modify the value

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

Default value is false.

Param Type DefaultValue Description
bShowEditingUI boolean false

New value for property showEditingUI