class sap.ui.vk.tools.AxisAngleRotationTool

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

Tool to rotate 3D objects in space


Constructor

Constructor for a new AxisAngleRotationTool.

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.AxisAngleRotationTool(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
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
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
rotated

This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that is array of objects, each object has five properties:

  • node: any - A node reference.
  • angle: float - An angle of rotation about the axis.
  • azimuth: float - An azimuth of the axis of rotation in degrees in the parent's space.
  • elevation: float - An elevation of the axis of rotation in degrees in the parent's space.
  • axis: float[] - An axis of rotation in cartesian coordinates in the parent's space.
An axis of rotation in animation keys is stored in cartesian coordinates, in UI an axis of rotation is displayed in polar coordinates using azimuth and elevation.

rotating

This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that is array of objects, each object has five properties:

  • node: any - A node reference.
  • angle: float - An angle of rotation about the axis.
  • azimuth: float - An azimuth of the axis of rotation in degrees in the parent's space.
  • elevation: float - An elevation of the axis of rotation in degrees in the parent's space.
  • axis: float[] - An axis of rotation in cartesian coordinates in the parent's space.
An axis of rotation in animation keys is stored in cartesian coordinates, in UI an axis of rotation is displayed in polar coordinates using azimuth and elevation.

rotated

This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that is array of objects, each object has five properties:

An axis of rotation in animation keys is stored in cartesian coordinates, in UI an axis of rotation is displayed in polar coordinates using azimuth and elevation.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
nodesProperties object[]

rotating

This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that is array of objects, each object has five properties:

An axis of rotation in animation keys is stored in cartesian coordinates, in UI an axis of rotation is displayed in polar coordinates using azimuth and elevation.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
nodesProperties object[]

Methods Overview

Method Description
attachRotated

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

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

This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that is array of objects, each object has five properties:

  • node: any - A node reference.
  • angle: float - An angle of rotation about the axis.
  • azimuth: float - An azimuth of the axis of rotation in degrees in the parent's space.
  • elevation: float - An elevation of the axis of rotation in degrees in the parent's space.
  • axis: float[] - An axis of rotation in cartesian coordinates in the parent's space.
An axis of rotation in animation keys is stored in cartesian coordinates, in UI an axis of rotation is displayed in polar coordinates using azimuth and elevation.

attachRotating

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

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

This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that is array of objects, each object has five properties:

  • node: any - A node reference.
  • angle: float - An angle of rotation about the axis.
  • azimuth: float - An azimuth of the axis of rotation in degrees in the parent's space.
  • elevation: float - An elevation of the axis of rotation in degrees in the parent's space.
  • axis: float[] - An axis of rotation in cartesian coordinates in the parent's space.
An axis of rotation in animation keys is stored in cartesian coordinates, in UI an axis of rotation is displayed in polar coordinates using azimuth and elevation.

detachRotated

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

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

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

sap.ui.vk.tools.AxisAngleRotationTool.extend

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

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.

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.AxisAngleRotationTool.getMetadata

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

getNodeSet

Gets current value of property nodeSet.

Determine what set of nodes will be transformed with this tool

Default value is Highlight.

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.

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.

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.

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.

attachRotated

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

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

This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that is array of objects, each object has five properties:

An axis of rotation in animation keys is stored in cartesian coordinates, in UI an axis of rotation is displayed in polar coordinates using azimuth and elevation.

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

attachRotating

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

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

This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that is array of objects, each object has five properties:

An axis of rotation in animation keys is stored in cartesian coordinates, in UI an axis of rotation is displayed in polar coordinates using azimuth and elevation.

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

detachRotated

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

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

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

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

fireRotated

Fires event rotated to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

nodesProperties object[]

fireRotating

Fires event rotating to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

nodesProperties object[]

getAllowContextMenu

Gets current value of property allowContextMenu.

Whether or not to allow context menu on right-click

Default value is true.

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.AxisAngleRotationTool.getMetadata

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

getNodeSet

Gets current value of property nodeSet.

Determine what set of nodes will be transformed with this tool

Default value is Highlight.

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.

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

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

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