class sap.ui.vk.tools.AnchorPointTool

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

Tool used to define an anchor point and orientation in 3D space which can be used to rotate, move or scale one or more selected objects


Constructor

Constructor for an AnchorPointTool.

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.AnchorPointTool(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
allowOperation sap.ui.vk.tools.AnchorPointToolOperation All

Indicates the type of allowed operations

Visibility: public
enableStepping boolean false

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

Visibility: public
position any

The anchor point tool position in the world coordinate system. This property is read-only.

Visibility: public
quaternion any

The anchor point tool quaternion. This property is read-only.

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
moved

This event will be fired when movement finished.

moving

This event will be fired when movement occurs.

rotated

This event will be fired when rotation finished.

rotating

This event will be fired when rotation occurs.

moved

This event will be fired when movement finished.

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

moving

This event will be fired when movement occurs.

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

rotated

This event will be fired when rotation finished.

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

rotating

This event will be fired when rotation occurs.

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

Methods Overview

Method Description
alignTo

Aligns the anchor point rotation to the object rotation.

alignToScreen

Aligns the anchor point rotation to the camera rotation.

alignToWorld

Aligns the anchor point rotation to the world coordinate system.

attachMoved

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

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

This event will be fired when movement finished.

attachMoving

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

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

This event will be fired when movement occurs.

attachRotated

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

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

This event will be fired when rotation finished.

attachRotating

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

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

This event will be fired when rotation occurs.

detachMoved

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

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

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

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

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

sap.ui.vk.tools.AnchorPointTool.extend

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

fireMoved

Fires event moved to attached listeners.

fireMoving

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

getAllowOperation

Gets current value of property allowOperation.

Indicates the type of allowed operations

Default value is All.

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

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

getPosition

Gets current value of property position.

The anchor point tool position in the world coordinate system. This property is read-only.

getQuaternion

Gets current value of property quaternion.

The anchor point tool quaternion. This property is read-only.

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 the anchor point.

moveTo

Moves the anchor point to the center of objects or object's origin.

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 the anchor point.

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.

setAllowOperation

Sets a new value for property allowOperation.

Indicates the type of allowed operations

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

Default value is All.

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.

setPosition

Sets a new value for property position.

The anchor point tool position in the world coordinate system. This property is read-only.

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

setQuaternion

Sets a new value for property quaternion.

The anchor point tool quaternion. This property is read-only.

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

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.

alignTo

Aligns the anchor point rotation to the object rotation.

Param Type DefaultValue Description
target any

The node reference or Matrix4.

alignToScreen

Aligns the anchor point rotation to the camera rotation.

alignToWorld

Aligns the anchor point rotation to the world coordinate system.

attachMoved

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

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

This event will be fired when movement finished.

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

attachMoving

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

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

This event will be fired when movement 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.AnchorPointTool itself

attachRotated

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

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

This event will be fired when rotation finished.

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

attachRotating

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

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

detachMoved

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

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

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

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

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

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

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

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

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

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

getAllowContextMenu

Gets current value of property allowContextMenu.

Whether or not to allow context menu on right-click

Default value is true.

getAllowOperation

Gets current value of property allowOperation.

Indicates the type of allowed operations

Default value is All.

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

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

getPosition

Gets current value of property position.

The anchor point tool position in the world coordinate system. This property is read-only.

getQuaternion

Gets current value of property quaternion.

The anchor point tool quaternion. This property is read-only.

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 the anchor point.

Param Type DefaultValue Description
x float

Movement offset along x axis.

y float

Movement offset along y axis.

z float

Movement offset along z axis.

moveTo

Moves the anchor point to the center of objects or object's origin.

Param Type DefaultValue Description
target any any[]

The node reference or the array of node references or Matrix4.

useObjectsOrigin boolean

Use the object's origin if true or the center of objects if 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 the anchor point.

Param Type DefaultValue Description
x float

Rotation angle around x axis in degrees.

y float

Rotation angle around y axis in degrees.

z float

Rotation angle around z axis in degrees.

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

setAllowOperation

Sets a new value for property allowOperation.

Indicates the type of allowed operations

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
sAllowOperation sap.ui.vk.tools.AnchorPointToolOperation All

New value for property allowOperation

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

setPosition

Sets a new value for property position.

The anchor point tool position in the world coordinate system. This property is read-only.

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

Param Type DefaultValue Description
oPosition any

New value for property position

setQuaternion

Sets a new value for property quaternion.

The anchor point tool quaternion. This property is read-only.

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

Param Type DefaultValue Description
oQuaternion any

New value for property quaternion

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