Tool to rotate 3D objects in space
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. |
|
mSettings? | object | An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. |
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 |
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 |
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 |
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 |
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:
|
rotating |
This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that is array of objects, each object has five properties:
|
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.Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
nodesProperties | object[] |
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.Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
nodesProperties | object[] |
Method | Description |
---|---|
attachRotated |
Attaches event handler When called, the context of the event handler (its This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that is array of objects, each object has five properties:
|
attachRotating |
Attaches event handler When called, the context of the event handler (its This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that is array of objects, each object has five properties:
|
detachRotated |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachRotating |
Detaches event handler 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
|
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 |
getEnableSnapping |
Gets current value of property enableSnapping. Determines if snapping when rotating is enabled Default value is |
getEnableStepping |
Gets current value of property enableStepping. If set to Default value is |
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 |
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 |
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 Default value is |
setEnableSnapping |
Sets a new value for property enableSnapping. Determines if snapping when rotating is enabled When called with a value of Default value is |
setEnableStepping |
Sets a new value for property enableStepping. If set to When called with a value of Default value is |
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 Default value is |
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 Default value is |
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.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 |
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.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 |
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 |
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 |
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 |
Fires event rotated to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
nodesProperties | object[] |
Fires event rotating to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
nodesProperties | object[] |
Gets current value of property allowContextMenu.
Whether or not to allow context menu on right-click
Default value is true
.
Gets current value of property enableSnapping.
Determines if snapping when rotating is enabled
Default value is false
.
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
.
Returns a metadata object for class sap.ui.vk.tools.AxisAngleRotationTool.
Gets current value of property nodeSet.
Determine what set of nodes will be transformed with this tool
Default value is Highlight
.
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 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. |
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 |
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 |
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 |
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 |
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 |