class sap.ui.vk.tools.RotateOrbitTool

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

Tool to rotate scene in orbit mode


Constructor

Constructor for a new RotateOrbitTool tool.

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

ID of the new content resource. 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.

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
rotate

This event will be fired when rotation occurs.

rotate

This event will be fired when rotation occurs.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
dx int
dy int

Methods Overview

Method Description
attachRotate

Attaches event handler fnFunction to the rotate event of this sap.ui.vk.tools.RotateOrbitTool.

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

This event will be fired when rotation occurs.

detachRotate

Detaches event handler fnFunction from the rotate event of this sap.ui.vk.tools.RotateOrbitTool.

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

sap.ui.vk.tools.RotateOrbitTool.extend

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

fireRotate

Fires event rotate to attached listeners.

sap.ui.vk.tools.RotateOrbitTool.getMetadata

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

rotate

Executes Orbit rotation for the target Viewport.

attachRotate

Attaches event handler fnFunction to the rotate event of this sap.ui.vk.tools.RotateOrbitTool.

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

This event will be fired when rotation occurs.

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

detachRotate

Detaches event handler fnFunction from the rotate event of this sap.ui.vk.tools.RotateOrbitTool.

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

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

fireRotate

Fires event rotate to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

dx int
dy int

sap.ui.vk.tools.RotateOrbitTool.getMetadata

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

rotate

Executes Orbit rotation for the target Viewport.

Param Type DefaultValue Description
dx int

The change in x-coordinate used to define the desired rotation.

dy int

The change in y-coordinate used to define the desired rotation.