When user clicks/taps inside of 3D Viewport this tool can be used to find if there is an object at this point
Constructor for a new HitTestTool 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.HitTestTool(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 |
---|---|---|---|
IdMode | sap.ui.vk.tools.HitTestIdMode | ThreeJS | Indicates what schema the tool should use to extract IDs from hit objects 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 |
---|---|
hit |
This event will be fired when 3D object is detected under hit position. |
Method | Description |
---|---|
attachHit |
Attaches event handler When called, the context of the event handler (its This event will be fired when 3D object is detected under hit position. |
detachHit |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.ui.vk.tools.HitTestTool.extend |
Creates a new subclass of class sap.ui.vk.tools.HitTestTool with name
|
fireHit |
Fires event hit to attached listeners. |
getIdMode |
Gets current value of property IdMode. Indicates what schema the tool should use to extract IDs from hit objects Default value is |
sap.ui.vk.tools.HitTestTool.getMetadata |
Returns a metadata object for class sap.ui.vk.tools.HitTestTool. |
hitTest |
Figure out which helper is needed and execute hit test |
queueCommand |
Queues a command for execution during the rendering cycle. All gesture operations should be called using this method. |
setIdMode |
Sets a new value for property IdMode. Indicates what schema the tool should use to extract IDs from hit objects When called with a value of Default value is |
Attaches event handler fnFunction
to the hit event of this sap.ui.vk.tools.HitTestTool
.
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.HitTestTool
itself.
This event will be fired when 3D object is detected under hit position.
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 hit event of this sap.ui.vk.tools.HitTestTool
.
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.HitTestTool 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 hit to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
id | any | ||
object | any | ||
point | any | ||
clickType | sap.ui.vk.tools.HitTestClickType |
Gets current value of property IdMode.
Indicates what schema the tool should use to extract IDs from hit objects
Default value is ThreeJS
.
Returns a metadata object for class sap.ui.vk.tools.HitTestTool.
Figure out which helper is needed and execute hit test
Param | Type | DefaultValue | Description |
---|---|---|---|
x | int |
The tap gesture's x-coordinate. |
|
y | int |
The tap gesture's y-coordinate. |
|
scene | sap.ui.vk.Scene |
Scene object used in current viewport. |
|
camera | sap.ui.vk.Camera |
Current viewport's camera. |
|
clickType | sap.ui.vk.tools.HitTestClickType |
One of predefined click types, this is passed to the hit event |
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 IdMode.
Indicates what schema the tool should use to extract IDs from hit objects
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is ThreeJS
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sIdMode | sap.ui.vk.tools.HitTestIdMode | ThreeJS |
New value for property |