class sap.ui.vk.tools.RotateTool

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

Tool to rotate 3D objects in space


Constructor

Constructor for a new RotateTool.

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.RotateTool(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
axis sap.ui.vk.tools.RotatableAxis All

Controls which axis are rotatable around. Can be All, X, Y, or Z

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 rotating 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
axisChanged
coordinateSystemChanged

This event will be fired when the coordinate system changes.

placementModeChanged
rotated

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

rotating

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

axisChanged

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

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

placementModeChanged

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

rotated

This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that is array of objects, each object has five properties: {any} node: node reference, {float[]} offsetToRest, quaternion relative to rest position in parent coordinates {float[]} offsetToPrevious, euler rotation relative to end position of previous sequence, or euler rotation relative to rest position if no previous sequence in parent coordinates {float[]} absolute, quaternion in parent coordinates {float[]} world, quaternion in world coordinates {float[]} restDifference, change of rest position quaternion in parent coordinates {float[]} restDifferenceInCoordinates, change of rest position in euler rotation 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[]

rotating

This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that is array of objects, each object has five properties: {any} node: node reference, {float[]} offsetToRest, quaternion relative to rest position in parent coordinates {float[]} offsetToPrevious, euler rotation relative to end position of previous sequence, or euler rotation relative to rest position if no previous sequence in parent coordinates {float[]} absolute, quaternion in parent coordinates {float[]} world, quaternion in world coordinates {float[]} restDifference, change of rest position quaternion in parent coordinates {float[]} restDifferenceInCoordinates, change of rest position in euler rotation 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[]

Methods Overview

Method Description
attachAxisChanged

Attaches event handler fnFunction to the axisChanged event of this sap.ui.vk.tools.RotateTool.

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

attachCoordinateSystemChanged

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

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

This event will be fired when the coordinate system changes.

attachPlacementModeChanged

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

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

attachRotated

Attaches event handler fnFunction to the rotated event of this sap.ui.vk.tools.RotateTool.

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

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

attachRotating

Attaches event handler fnFunction to the rotating event of this sap.ui.vk.tools.RotateTool.

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

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

detachAxisChanged

Detaches event handler fnFunction from the axisChanged event of this sap.ui.vk.tools.RotateTool.

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

detachCoordinateSystemChanged

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

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.RotateTool.

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

detachRotated

Detaches event handler fnFunction from the rotated event of this sap.ui.vk.tools.RotateTool.

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

detachRotating

Detaches event handler fnFunction from the rotating event of this sap.ui.vk.tools.RotateTool.

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

sap.ui.vk.tools.RotateTool.extend

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

fireAxisChanged

Fires event axisChanged to attached listeners.

fireCoordinateSystemChanged

Fires event coordinateSystemChanged to attached listeners.

firePlacementModeChanged

Fires event placementModeChanged to attached listeners.

fireRotated

Fires event rotated to attached listeners.

fireRotating

Fires event rotating 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.

getAxis

Gets current value of property axis.

Controls which axis are rotatable around. Can be All, X, Y, or Z

Default value is All.

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 rotating 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.RotateTool.getMetadata

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

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.

queueCommand

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

rotate

Performs rotation of selected objects. If coordinate system is specified a moved event is fired

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.

setAxis

Sets a new value for property axis.

Controls which axis are rotatable around. Can be All, X, Y, or Z

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

Default value is All.

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 rotating 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.

attachAxisChanged

Attaches event handler fnFunction to the axisChanged event of this sap.ui.vk.tools.RotateTool.

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

attachCoordinateSystemChanged

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

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

attachPlacementModeChanged

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

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

attachRotated

Attaches event handler fnFunction to the rotated event of this sap.ui.vk.tools.RotateTool.

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

This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that is array of objects, each object has five properties: {any} node: node reference, {float[]} offsetToRest, quaternion relative to rest position in parent coordinates {float[]} offsetToPrevious, euler rotation relative to end position of previous sequence, or euler rotation relative to rest position if no previous sequence in parent coordinates {float[]} absolute, quaternion in parent coordinates {float[]} world, quaternion in world coordinates {float[]} restDifference, change of rest position quaternion in parent coordinates {float[]} restDifferenceInCoordinates, change of rest position in euler rotation 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.RotateTool itself

attachRotating

Attaches event handler fnFunction to the rotating event of this sap.ui.vk.tools.RotateTool.

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

This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that is array of objects, each object has five properties: {any} node: node reference, {float[]} offsetToRest, quaternion relative to rest position in parent coordinates {float[]} offsetToPrevious, euler rotation relative to end position of previous sequence, or euler rotation relative to rest position if no previous sequence in parent coordinates {float[]} absolute, quaternion in parent coordinates {float[]} world, quaternion in world coordinates {float[]} restDifference, change of rest position quaternion in parent coordinates {float[]} restDifferenceInCoordinates, change of rest position in euler rotation 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.RotateTool itself

detachAxisChanged

Detaches event handler fnFunction from the axisChanged event of this sap.ui.vk.tools.RotateTool.

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

detachCoordinateSystemChanged

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

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.RotateTool.

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

detachRotated

Detaches event handler fnFunction from the rotated event of this sap.ui.vk.tools.RotateTool.

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

detachRotating

Detaches event handler fnFunction from the rotating event of this sap.ui.vk.tools.RotateTool.

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

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

fireAxisChanged

Fires event axisChanged to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

axis sap.ui.vk.tools.RotatableAxis

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

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

fireRotated

Fires event rotated to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

x float
y float
z float
nodesProperties any[]

fireRotating

Fires event rotating to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

x float
y float
z float
nodesProperties any[]

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.

getAxis

Gets current value of property axis.

Controls which axis are rotatable around. Can be All, X, Y, or Z

Default value is All.

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 rotating 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.RotateTool.getMetadata

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

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.

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.

rotate

Performs rotation of selected objects. If coordinate system is specified a moved event is fired

Param Type DefaultValue Description
x float

Euler rotation x axis angle in degrees.

y float

Euler rotation y axis angle in degrees.

z float

Euler rotation z axis angle in degrees.

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.

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

setAxis

Sets a new value for property axis.

Controls which axis are rotatable around. Can be All, X, Y, or Z

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

Default value is All.

Param Type DefaultValue Description
sAxis sap.ui.vk.tools.RotatableAxis All

New value for property axis

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 rotating 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