| SoTouchEvent Class |
Base class for touch events.
Inheritance HierarchyNamespace: OIV.Inventor.Touch.Events
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoTouchEvent type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoTouchEvent | Constructor. |
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| GetAcceleration | Gets the acceleration vector (in pixels per second squared) between the previous event and the current one. |
| GetDisplacement | Gets the deplacement vector (in pixels) between the previous event and the current one. |
| GetElapsedTimeSincePreviousEvent | Gets the elapsed time since previous event, triggered by the same finger, in seconds. |
| GetElapsedTimeUntilPreviousEvent | Gets the elapsed time between the first contact and previous event, for the finger identified by OIV.Inventor.Touch.Events.SoTouchEvent.GetFingerId(), in seconds. |
| GetFingerId | Gets the id of the finger triggering this event. |
| GetFirstContactTime | Gets the time of first contact in seconds of the finger identified by OIV.Inventor.Touch.Events.SoTouchEvent.GetFingerId(). |
| GetFirstPosition | Gets the first position (in pixels). |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetNormalizedPosition | Gets the normalized location of the cursor when the event occurred, relative to the specified viewport region. |
| GetPosition | Returns the window pixel location of the cursor when the event occurred as integer values. |
| GetPosition(SbViewportRegion) | Gets the viewport pixel location of the cursor when the event occurred, relative to the origin of the specified viewport region, as integer values. |
| GetPositionFloat | Returns the window pixel location of the cursor when the event occurred as float values. |
| GetPositionFloat(SbViewportRegion) | Gets the viewport pixel location of the cursor when the event occurred, relative to the origin of the specified viewport region, as float values. |
| GetPreviousEventTime | Gets the time of previous event of the finger identified by OIV.Inventor.Touch.Events.SoTouchEvent.GetFingerId(). |
| GetPreviousPosition | Gets the previous position of the same finger (in pixels). |
| GetPreviousSpeed | Gets the previous speed (in pixels per second). |
| GetSpeed | Gets the speed (in pixels per second) between the previous event and the current one. |
| GetState | Gets the touch event state (Up, Down, Move or Unknown). |
| GetTime | Gets the time at which the event occurred. |
| GetTouchManager | Gets the corresponding TouchManager for this event. |
| GetTrackerInfo | Gets whether an event object has associated tracker information. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| SetAltDown | Sets whether the ALT key was down when the event occurred. |
| SetButton1Down | Sets whether mouse Button 1 was down when the event occurred. |
| SetCtrlDown | Sets whether the CTRL key was down when the event occurred. |
| SetFingerId | Sets the id of the finger triggering this event. |
| SetFirstPosition | Sets the first position (in pixels). |
| SetPosition(SbVec2f) | Float version of OIV.Inventor.Events.SoEvent.SetPosition(OIV.Inventor.SbVec2s). |
| SetPosition(SbVec2s) | Sets the window pixel location of the cursor when the event occurred. |
| SetPreviousSpeed | Sets the previous speed in pixels per second. |
| SetShiftDown | Sets whether the shift key was down when the event occurred. |
| SetState | Sets the state of the touch event. |
| SetTime | Sets the time at which the event occurred. |
| SetTouchManager | Sets the TouchManager for this event. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| WasAltDown | Returns true if the ALT key was down when the event occurred. |
| WasButton1Down | Returns true if mouse button 1 was down when the event occurred. |
| WasCtrlDown | Returns true if the CTRL key was down when the event occurred. |
| WasShiftDown | Returns true if the shift key was down when the event occurred. |
RemarksOIV.Inventor.Touch.Events.SoTouchEvent is the base class for touch events in the Open Inventor event model. A touch event typically represents a user finger action on a touch screen input device, such as putting a finger down on the screen. OIV.Inventor.Touch.Events.SoTouchEvent is an OIV.Inventor.Events.SoEvent with touch information including the displacement and speed of the finger and the state (UP, DOWN or MOVE).
The OIV.Inventor.Touch.Events.SoTouchEvent.GetTouchManager() method can be use to retrieve the corresponding touch device currently used and information about other fingers touching the screen at the same time.
Open Inventor also supports gesture events (see OIV.Inventor.Gestures.Events.SoGestureEvent) such as pinch and rotate. Gesture events are generated by gesture recognizers (see OIV.Inventor.Gestures.Recognizers.SoGestureRecognizer) which analyze a series of touch events.
Note: Unlike mouse and keyboard events, the application must explicitly register a touch screen device (OIV.Inventor.Touch.Devices.SoWinTouchScreen, SoQtTouchScreen, etc) in order to get touch events.
See Also