Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## TUIO
Class TuioCursor

    java.lang.Object
      TUIO.TuioPoint
          TUIO.TuioCursor

    public class TuioCursor

extends TuioPoint

The TuioCursor class encapsulates /tuio/2Dcur TUIO cursors.

Field Summary
`protected int` | `cursor_id` The individual cursor ID number that is assigned to each TuioCursor.
`protected float` | `motion_accel` The motion acceleration value.
`protected float` | `motion_speed` The motion speed value.
`protected java.util.Vector<TuioPoint>` | `path` A Vector of TuioPoints containing all the previous positions of the TUIO component.
`protected long` | `session_id` The unique session ID number that is assigned to each TUIO object or cursor.
`protected int` | `state` Reflects the current state of the TuioComponent
`static int` | `TUIO_ACCELERATING` Defines the ACCELERATING state.
`static int` | `TUIO_ADDED` Defines the ADDED state.
`static int` | `TUIO_DECELERATING` Defines the DECELERATING state.
`static int` | `TUIO_REMOVED` Defines the REMOVED state.
`static int` | `TUIO_STOPPED` Defines the STOPPED state.
`protected float` | `x_speed` The X-axis velocity value.
`protected float` | `y_speed` The Y-axis velocity value.

Fields inherited from class TUIO.TuioPoint
`currentTime, startTime, xpos, ypos`

Constructor Summary
`TuioCursor(long si, int ci, float xp, float yp)` This constructor takes the provided Session ID, Cursor ID, X and Y coordinate and assigs these values to the newly created TuioCursor.
`TuioCursor(TuioCursor tcur)` This constructor takes the atttibutes of the provided TuioCursor and assigs these values to the newly created TuioCursor.
`TuioCursor(TuioTime ttime, long si, int ci, float xp, float yp)` This constructor takes a TuioTime argument and assigns it along with the provided Session ID, Cursor ID, X and Y coordinate to the newly created TuioCursor.

Method Summary
`int` | `getCursorID()` Returns the Cursor ID of this TuioCursor.
`float` | `getMotionAccel()` Returns the motion acceleration of this TuioContainer.
`float` | `getMotionSpeed()` Returns the motion speed of this TuioContainer.
`java.util.Vector<TuioPoint>` | `getPath()` Returns the path of this TuioContainer.
`TuioPoint` | `getPosition()` Returns the position of this TuioContainer.
`long` | `getSessionID()` Returns the Session ID of this TuioContainer.
`int` | `getTuioState()` Returns the TUIO state of this TuioContainer.
`float` | `getXSpeed()` Returns the X velocity of this TuioContainer.
`float` | `getYSpeed()` Returns the Y velocity of this TuioContainer.
`boolean` | `isMoving()` Returns true of this TuioContainer is moving.
`void` | `remove(TuioTime ttime)` Assigns the REMOVE state to this TuioContainer and sets its TuioTime time stamp to the provided TuioTime argument.
`void` | `stop(TuioTime ttime)` This method is used to calculate the speed and acceleration values of TuioContainers with unchanged positions.
`void` | `update(float xp, float yp, float xs, float ys, float ma)` Assigns the provided X and Y coordinate, X and Y velocity and acceleration to the private TuioContainer attributes.
`void` | `update(TUIO.TuioContainer tcon)` Takes the atttibutes of the provided TuioContainer and assigs these values to this TuioContainer.
`void` | `update(TuioTime ttime, float xp, float yp)` Takes a TuioTime argument and assigns it along with the provided X and Y coordinate to the private TuioContainer attributes.
`void` | `update(TuioTime ttime, float xp, float yp, float xs, float ys, float ma)` Takes a TuioTime argument and assigns it along with the provided X and Y coordinate, X and Y velocity and acceleration to the private TuioContainer attributes.

Methods inherited from class TUIO.TuioPoint
`getAngle, getAngle, getAngleDegrees, getAngleDegrees, getDistance, getDistance, getScreenX, getScreenY, getStartTime, getTuioTime, getX, getY, update, update`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### cursor_id

    protected int cursor_id

  The individual cursor ID number that is assigned to each TuioCursor.

### session_id

    protected long session_id

  The unique session ID number that is assigned to each TUIO object or cursor.

### x_speed

    protected float x_speed

  The X-axis velocity value.

### y_speed

    protected float y_speed

  The Y-axis velocity value.

### motion_speed

    protected float motion_speed

  The motion speed value.

### motion_accel

    protected float motion_accel

  The motion acceleration value.

### path

    protected java.util.Vector<TuioPoint> path

  A Vector of TuioPoints containing all the previous positions of the TUIO component.

### TUIO_ADDED

    public static final int TUIO_ADDED

  Defines the ADDED state.

  See Also:
    Constant Field Values

### TUIO_ACCELERATING

    public static final int TUIO_ACCELERATING

  Defines the ACCELERATING state.

  See Also:
    Constant Field Values

### TUIO_DECELERATING

    public static final int TUIO_DECELERATING

  Defines the DECELERATING state.

  See Also:
    Constant Field Values

### TUIO_STOPPED

    public static final int TUIO_STOPPED

  Defines the STOPPED state.

  See Also:
    Constant Field Values

### TUIO_REMOVED

    public static final int TUIO_REMOVED

  Defines the REMOVED state.

  See Also:
    Constant Field Values

### state

    protected int state

  Reflects the current state of the TuioComponent

Constructor Detail

### TuioCursor

    public TuioCursor(TuioTime ttime,
                      long si,
                      int ci,
                      float xp,
                      float yp)

  This constructor takes a TuioTime argument and assigns it along with the provided Session ID, Cursor ID, X and Y coordinate to the newly created TuioCursor.

  Parameters:
    `ttime` - the TuioTime to assign
    `si` - the Session ID to assign
    `ci` - the Cursor ID to assign
    `xp` - the X coordinate to assign
    `yp` - the Y coordinate to assign

### TuioCursor

    public TuioCursor(long si,
                      int ci,
                      float xp,
                      float yp)

  This constructor takes the provided Session ID, Cursor ID, X and Y coordinate and assigs these values to the newly created TuioCursor.

  Parameters:
    `si` - the Session ID to assign
    `ci` - the Cursor ID to assign
    `xp` - the X coordinate to assign
    `yp` - the Y coordinate to assign

### TuioCursor

    public TuioCursor(TuioCursor tcur)

  This constructor takes the atttibutes of the provided TuioCursor and assigs these values to the newly created TuioCursor.

  Parameters:
    `tcur` - the TuioCursor to assign

Method Detail

### getCursorID

    public int getCursorID()

  Returns the Cursor ID of this TuioCursor.

  Returns:
    the Cursor ID of this TuioCursor

### update

    public void update(TuioTime ttime,
                       float xp,
                       float yp)

  Takes a TuioTime argument and assigns it along with the provided X and Y coordinate to the private TuioContainer attributes. The speed and accleration values are calculated accordingly.

  Overrides:
    `update` in class `TuioPoint`
  Parameters:
    `ttime` - the TuioTime to assign
    `xp` - the X coordinate to assign
    `yp` - the Y coordinate to assign

### stop

    public void stop(TuioTime ttime)

  This method is used to calculate the speed and acceleration values of TuioContainers with unchanged positions.

### update

    public void update(TuioTime ttime,
                       float xp,
                       float yp,
                       float xs,
                       float ys,
                       float ma)

  Takes a TuioTime argument and assigns it along with the provided X and Y coordinate, X and Y velocity and acceleration to the private TuioContainer attributes.

  Parameters:
    `ttime` - the TuioTime to assign
    `xp` - the X coordinate to assign
    `yp` - the Y coordinate to assign
    `xs` - the X velocity to assign
    `ys` - the Y velocity to assign
    `ma` - the acceleration to assign

### update

    public void update(float xp,
                       float yp,
                       float xs,
                       float ys,
                       float ma)

  Assigns the provided X and Y coordinate, X and Y velocity and acceleration to the private TuioContainer attributes. The TuioTime time stamp remains unchanged.

  Parameters:
    `xp` - the X coordinate to assign
    `yp` - the Y coordinate to assign
    `xs` - the X velocity to assign
    `ys` - the Y velocity to assign
    `ma` - the acceleration to assign

### update

    public void update(TUIO.TuioContainer tcon)

  Takes the atttibutes of the provided TuioContainer and assigs these values to this TuioContainer. The TuioTime time stamp of this TuioContainer remains unchanged.

  Parameters:
    `tcon` - the TuioContainer to assign

### remove

    public void remove(TuioTime ttime)

  Assigns the REMOVE state to this TuioContainer and sets its TuioTime time stamp to the provided TuioTime argument.

  Parameters:
    `ttime` - the TuioTime to assign

### getSessionID

    public long getSessionID()

  Returns the Session ID of this TuioContainer.

  Returns:
    the Session ID of this TuioContainer

### getXSpeed

    public float getXSpeed()

  Returns the X velocity of this TuioContainer.

  Returns:
    the X velocity of this TuioContainer

### getYSpeed

    public float getYSpeed()

  Returns the Y velocity of this TuioContainer.

  Returns:
    the Y velocity of this TuioContainer

### getPosition

    public TuioPoint getPosition()

  Returns the position of this TuioContainer.

  Returns:
    the position of this TuioContainer

### getPath

    public java.util.Vector<TuioPoint> getPath()

  Returns the path of this TuioContainer.

  Returns:
    the path of this TuioContainer

### getMotionSpeed

    public float getMotionSpeed()

  Returns the motion speed of this TuioContainer.

  Returns:
    the motion speed of this TuioContainer

### getMotionAccel

    public float getMotionAccel()

  Returns the motion acceleration of this TuioContainer.

  Returns:
    the motion acceleration of this TuioContainer

### getTuioState

    public int getTuioState()

  Returns the TUIO state of this TuioContainer.

  Returns:
    the TUIO state of this TuioContainer

### isMoving

    public boolean isMoving()

  Returns true of this TuioContainer is moving.

  Returns:
    true of this TuioContainer is moving

Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD