com.openinventor.inventor.touch.events

Class SoTouchEvent

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.events.SoEvent

com.openinventor.inventor.touch.events.SoTouchEvent

public class SoTouchEvent
extends SoEvent

Base class for 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. SoTouchEvent is an SoEvent with touch information including the displacement and speed of the finger and the state (UP, DOWN or MOVE).

The 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 SoGestureEvent) such as pinch and rotate. Gesture events are generated by gesture recognizers (see SoGestureRecognizer) which analyze a series of touch events.

Note: Unlike mouse and keyboard events, the application must explicitly register a touch screen device (SoWinTouchScreen, SoQtTouchScreen, etc) in order to get touch events.

See also:

SoEvent, SoButtonEvent, SoMouseButtonEvent, SoKeyboardEvent, SoLocation2Event, SoMotion3Event, SoSpaceballButtonEvent, SoTouchManager

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoTouchEvent.States The different states a touch event can have.

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
static int	DOWN Deprecated. Use SoTouchEvent.States.DOWN instead.
static int	MOVE Deprecated. Use SoTouchEvent.States.MOVE instead.
static int	UNKNOWN Deprecated. Use SoTouchEvent.States.UNKNOWN instead.
static int	UP Deprecated. Use SoTouchEvent.States.UP instead.

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoTouchEvent() Constructor.

Method Summary

Modifier and Type	Method and Description
SbVec2f	getAcceleration() Gets the acceleration vector (in pixels per second squared) between the previous event and the current one.
SbVec2f	getDisplacement() Gets the deplacement vector (in pixels) between the previous event and the current one.
SbTime	getElapsedTimeSincePreviousEvent() Gets the elapsed time since previous event, triggered by the same finger, in seconds.
SbTime	getElapsedTimeUntilPreviousEvent() Gets the elapsed time between the first contact and previous event, for the finger identified by getFingerId(), in seconds.
long	getFingerId() Gets the id of the finger triggering this event.
SbTime	getFirstContactTime() Gets the time of first contact in seconds of the finger identified by getFingerId().
SbVec2f	getFirstPosition() Gets the first position (in pixels).
SbTime	getPreviousEventTime() Gets the time of previous event of the finger identified by getFingerId().
SbVec2f	getPreviousPosition() Gets the previous position of the same finger (in pixels).
SbVec2f	getPreviousSpeed() Gets the previous speed (in pixels per second).
SbVec2f	getSpeed() Gets the speed (in pixels per second) between the previous event and the current one.
SoTouchEvent.States	getState() Gets the touch event state (Up, Down, Move or Unknown).
SoTouchManager	getTouchManager() Gets the corresponding TouchManager for this event.
void	setFingerId(long idFinger) Sets the id of the finger triggering this event.
void	setFirstPosition(SbVec2f name_27681) Sets the first position (in pixels).
void	setPosition(SbVec2f p) Sets the current position (in pixels) and the displacement vector.
void	setPosition(SbVec2s p) Sets the window pixel location of the cursor when the event occurred.
void	setPreviousSpeed() Sets the previous speed in pixels per second.
void	setState(SoTouchEvent.States b) Sets the state of the touch event.
void	setTime(SbTime t) Sets the time at which the event occurred.
void	setTouchManager(SoTouchManager manager) Sets the TouchManager for this event.

Methods inherited from class com.openinventor.inventor.events.SoEvent

getNormalizedPosition, getPosition, getPosition, getPositionFloat, getPositionFloat, getTime, setAltDown, setButton1Down, setCtrlDown, setShiftDown, wasAltDown, wasButton1Down, wasCtrlDown, wasShiftDown

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UNKNOWN

@Deprecated
public static final int UNKNOWN

Deprecated. Use SoTouchEvent.States.UNKNOWN instead.

UP

@Deprecated
public static final int UP

Deprecated. Use SoTouchEvent.States.UP instead.

DOWN

@Deprecated
public static final int DOWN

Deprecated. Use SoTouchEvent.States.DOWN instead.

MOVE

@Deprecated
public static final int MOVE

Deprecated. Use SoTouchEvent.States.MOVE instead.

Constructor Detail

SoTouchEvent

public SoTouchEvent()

Constructor.

Method Detail

setTime

public void setTime(SbTime t)

Sets the time at which the event occurred.

Overrides:

setTime in class SoEvent

getElapsedTimeUntilPreviousEvent

public SbTime getElapsedTimeUntilPreviousEvent()

Gets the elapsed time between the first contact and previous event, for the finger identified by getFingerId(), in seconds.

setPosition

public void setPosition(SbVec2s p)

Description copied from class: SoEvent

Sets the window pixel location of the cursor when the event occurred. The position is relative to the lower left corner of the window in which the event occurred.

Overrides:

setPosition in class SoEvent

getSpeed

public SbVec2f getSpeed()

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

getPreviousEventTime

public SbTime getPreviousEventTime()

Gets the time of previous event of the finger identified by getFingerId(). If current event is a DOWN, the function returns the current time.

setPreviousSpeed

public void setPreviousSpeed()

Sets the previous speed in pixels per second.

setFirstPosition

public void setFirstPosition(SbVec2f name_27681)

Sets the first position (in pixels).

setPosition

public void setPosition(SbVec2f p)

Sets the current position (in pixels) and the displacement vector.

Overrides:

setPosition in class SoEvent

getTouchManager

public SoTouchManager getTouchManager()

Gets the corresponding TouchManager for this event.

getDisplacement

public SbVec2f getDisplacement()

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

setTouchManager

public void setTouchManager(SoTouchManager manager)

Sets the TouchManager for this event.

getFirstContactTime

public SbTime getFirstContactTime()

Gets the time of first contact in seconds of the finger identified by getFingerId(). This date is set when the DOWN event occurs.

getPreviousSpeed

public SbVec2f getPreviousSpeed()

Gets the previous speed (in pixels per second).

getElapsedTimeSincePreviousEvent

public SbTime getElapsedTimeSincePreviousEvent()

Gets the elapsed time since previous event, triggered by the same finger, in seconds. If the current event is a DOWN, the function returns 0.

getFingerId

public long getFingerId()

Gets the id of the finger triggering this event.

getState

public SoTouchEvent.States getState()

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

setFingerId

public void setFingerId(long idFinger)

Sets the id of the finger triggering this event.

getAcceleration

public SbVec2f getAcceleration()

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

getFirstPosition

public SbVec2f getFirstPosition()

Gets the first position (in pixels). This position is set when the DOWN event occurs.

getPreviousPosition

public SbVec2f getPreviousPosition()

Gets the previous position of the same finger (in pixels). If current event is a DOWN, the function returns the current position.

setState

public void setState(SoTouchEvent.States b)

Sets the state of the touch event.