Click or drag to resize
SoTouchEvent Class

Base class for touch events.

Inheritance Hierarchy
SystemObject
  OIV.InventorSoNetBase
    OIV.Inventor.EventsSoEvent
      OIV.Inventor.Touch.EventsSoTouchEvent

Namespace: OIV.Inventor.Touch.Events
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.2.2.0 (10.16.2.0)
Syntax
public class SoTouchEvent : SoEvent

The SoTouchEvent type exposes the following members.

Constructors
  NameDescription
Public methodSoTouchEvent

Constructor.

Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetAcceleration

Gets the acceleration vector (in pixels per second squared) between the previous event and the current one.

Public methodGetDisplacement

Gets the deplacement vector (in pixels) between the previous event and the current one.

Public methodGetElapsedTimeSincePreviousEvent

Gets the elapsed time since previous event, triggered by the same finger, in seconds.

Public methodGetElapsedTimeUntilPreviousEvent

Gets the elapsed time between the first contact and previous event, for the finger identified by OIV.Inventor.Touch.Events.SoTouchEvent.GetFingerId(), in seconds.

Public methodGetFingerId

Gets the id of the finger triggering this event.

Public methodGetFirstContactTime

Gets the time of first contact in seconds of the finger identified by OIV.Inventor.Touch.Events.SoTouchEvent.GetFingerId().

Public methodGetFirstPosition

Gets the first position (in pixels).

Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetNormalizedPosition

Gets the normalized location of the cursor when the event occurred, relative to the specified viewport region.

(Inherited from SoEvent.)
Public methodGetPosition

Returns the window pixel location of the cursor when the event occurred as integer values.

(Inherited from SoEvent.)
Public methodGetPosition(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.

(Inherited from SoEvent.)
Public methodGetPositionFloat

Returns the window pixel location of the cursor when the event occurred as float values.

(Inherited from SoEvent.)
Public methodGetPositionFloat(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.

(Inherited from SoEvent.)
Public methodGetPreviousEventTime

Gets the time of previous event of the finger identified by OIV.Inventor.Touch.Events.SoTouchEvent.GetFingerId().

Public methodGetPreviousPosition

Gets the previous position of the same finger (in pixels).

Public methodGetPreviousSpeed

Gets the previous speed (in pixels per second).

Public methodGetSpeed

Gets the speed (in pixels per second) between the previous event and the current one.

Public methodGetState

Gets the touch event state (Up, Down, Move or Unknown).

Public methodGetTime

Gets the time at which the event occurred.

(Inherited from SoEvent.)
Public methodGetTouchManager

Gets the corresponding TouchManager for this event.

Public methodGetTrackerInfo

Gets whether an event object has associated tracker information.

(Inherited from SoEvent.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodSetAltDown

Sets whether the ALT key was down when the event occurred.

(Inherited from SoEvent.)
Public methodSetButton1Down

Sets whether mouse Button 1 was down when the event occurred.

(Inherited from SoEvent.)
Public methodSetCtrlDown

Sets whether the CTRL key was down when the event occurred.

(Inherited from SoEvent.)
Public methodSetFingerId

Sets the id of the finger triggering this event.

Public methodSetFirstPosition

Sets the first position (in pixels).

Public methodSetPosition(SbVec2f) (Inherited from SoEvent.)
Public methodSetPosition(SbVec2s)

Sets the window pixel location of the cursor when the event occurred.

(Inherited from SoEvent.)
Public methodSetPreviousSpeed

Sets the previous speed in pixels per second.

Public methodSetShiftDown

Sets whether the shift key was down when the event occurred.

(Inherited from SoEvent.)
Public methodSetState

Sets the state of the touch event.

Public methodSetTime

Sets the time at which the event occurred.

(Inherited from SoEvent.)
Public methodSetTouchManager

Sets the TouchManager for this event.

Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWasAltDown

Returns true if the ALT key was down when the event occurred.

(Inherited from SoEvent.)
Public methodWasButton1Down

Returns true if mouse button 1 was down when the event occurred.

(Inherited from SoEvent.)
Public methodWasCtrlDown

Returns true if the CTRL key was down when the event occurred.

(Inherited from SoEvent.)
Public methodWasShiftDown

Returns true if the shift key was down when the event occurred.

(Inherited from SoEvent.)
Top
Remarks

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