org.ximtec.igesture.io.tuio.tuio3D
Class TuioCursor3D

java.lang.Object
  org.ximtec.igesture.io.tuio.tuio3D.TuioPoint3D
      org.ximtec.igesture.io.tuio.tuio3D.TuioCursor3D

All Implemented Interfaces:

AbstractTuioContainer, AbstractTuioCursor, AbstractTuioPoint

public class TuioCursor3D
extends TuioPoint3D
implements AbstractTuioCursor

The TuioCursor3D class encapsulates /tuio/3Dcur TUIO cursors.

Version:

1.4

Author:

Martin Kaltenbrunner, Bjorn Puype

Field Summary

protected int	cursor_id The individual cursor ID number that is assigned to each TuioCursor3D.
protected float	motion_accel The motion acceleration value.
protected float	motion_speed The motion speed value.
protected Vector<TuioPoint3D>	path A Vector of TuioPoint3Ds 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.
protected float	z_speed The Z-axis velocity value.

Fields inherited from class org.ximtec.igesture.io.tuio.tuio3D.TuioPoint3D

currentTime, startTime, xpos, XY, XZ, ypos, YZ, zpos

Constructor Summary

TuioCursor3D(long si, int ci, float xp, float yp, float zp)
This constructor takes the provided Session ID, Cursor ID, X, Y and Z coordinate and assigns these values to the newly created TuioCursor3D.

TuioCursor3D(TuioCursor3D tcur)
This constructor takes the attributes of the provided TuioCursor3D and assigns these values to the newly created TuioCursor3D.

TuioCursor3D(TuioTime ttime, long si, int ci, float xp, float yp, float zp)
This constructor takes a TuioTime argument and assigns it along with the provided Session ID, Cursor ID, X, Y and Z coordinate to the newly created TuioCursor3D.

Method Summary

int	getCursorID() Returns the Cursor ID of this TuioCursor3D.
float	getMotionAccel() Returns the motion acceleration of this TuioContainer3D.
float	getMotionSpeed() Returns the motion speed of this TuioContainer3D.
Vector<TuioPoint3D>	getPath() Returns the path of this TuioContainer3D.
TuioPoint3D	getPosition() Returns the position of this TuioContainer3D.
long	getSessionID() Returns the Session ID of this TuioContainer3D.
int	getTuioState() Returns the TUIO state of this TuioContainer3D.
float	getXSpeed() Returns the X velocity of this TuioContainer3D.
float	getYSpeed() Returns the Y velocity of this TuioContainer3D.
float	getZSpeed() Returns the Z velocity of this TuioContainer3D.
boolean	isMoving() Returns true of this TuioContainer3D is moving.
void	remove(TuioTime ttime) Assigns the REMOVE state to this TuioContainer3D 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 TuioContainer3Ds with unchanged positions.
void	update(float xp, float yp, float zp, float xs, float ys, float zs, float ma) Assigns the provided X, Y and Z coordinate; X, Y and Z velocity and acceleration to the private TuioContainer attributes.
void	update(org.ximtec.igesture.io.tuio.tuio3D.TuioContainer3D tcon) Takes the attributes of the provided TuioContainer3D and assigns these values to this TuioContainer3D.
void	update(TuioTime ttime, float xp, float yp, float zp) Takes a TuioTime argument and assigns it along with the provided X, Y and Z coordinate to the private TuioContainer3D attributes.
void	update(TuioTime ttime, float xp, float yp, float zp, float xs, float ys, float zs, float ma) Takes a TuioTime argument and assigns it along with the provided X, Y and Z coordinate; X, Y and Z velocity and acceleration to the private TuioContainer3D attributes.

Methods inherited from class org.ximtec.igesture.io.tuio.tuio3D.TuioPoint3D

getAngle, getAngle, getAngleDegrees, getAngleDegrees, getDistance, getDistance, getScreenX, getScreenY, getScreenZ, getStartTime, getTuioTime, getX, getY, getZ, 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 TuioCursor3D.

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.

z_speed

protected float z_speed

The Z-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 Vector<TuioPoint3D> path

A Vector of TuioPoint3Ds 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

TuioCursor3D

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

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

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

zp - the Z coordinate to assign

TuioCursor3D

public TuioCursor3D(long si,
                    int ci,
                    float xp,
                    float yp,
                    float zp)

This constructor takes the provided Session ID, Cursor ID, X, Y and Z coordinate and assigns these values to the newly created TuioCursor3D.

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

zp - the Z coordinate to assign

TuioCursor3D

public TuioCursor3D(TuioCursor3D tcur)

This constructor takes the attributes of the provided TuioCursor3D and assigns these values to the newly created TuioCursor3D.

Parameters:

tcur - the TuioCursor to assign

Method Detail

getCursorID

public int getCursorID()

Returns the Cursor ID of this TuioCursor3D.

Returns:

the Cursor ID of this TuioCursor3D

update

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

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

Overrides:

update in class TuioPoint3D

Parameters:

ttime - the TuioTime to assign

xp - the X coordinate to assign

yp - the Y coordinate to assign

zp - the Z coordinate to assign

stop

public void stop(TuioTime ttime)

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

update

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

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

Parameters:

ttime - the TuioTime to assign

xp - the X coordinate to assign

yp - the Y coordinate to assign

zp - the Z coordinate to assign

xs - the X velocity to assign

ys - the Y velocity to assign

zs - the Z velocity to assign

ma - the acceleration to assign

update

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

Assigns the provided X, Y and Z coordinate; X, Y and Z 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

zp - the Z coordinate to assign

xs - the X velocity to assign

ys - the Y velocity to assign

zs - the Z velocity to assign

ma - the acceleration to assign

update

public void update(org.ximtec.igesture.io.tuio.tuio3D.TuioContainer3D tcon)

Takes the attributes of the provided TuioContainer3D and assigns these values to this TuioContainer3D. The TuioTime time stamp of this TuioContainer3D remains unchanged.

Parameters:

tcon - the TuioContainer3D to assign

remove

public void remove(TuioTime ttime)

Assigns the REMOVE state to this TuioContainer3D 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 TuioContainer3D.

Returns:

the Session ID of this TuioContainer3D

getXSpeed

public float getXSpeed()

Returns the X velocity of this TuioContainer3D.

Returns:

the X velocity of this TuioContainer3D

getYSpeed

public float getYSpeed()

Returns the Y velocity of this TuioContainer3D.

Returns:

the Y velocity of this TuioContainer3D

getZSpeed

public float getZSpeed()

Returns the Z velocity of this TuioContainer3D.

Returns:

the Z velocity of this TuioContainer3D

getPosition

public TuioPoint3D getPosition()

Returns the position of this TuioContainer3D.

Returns:

the position of this TuioContainer3D

getPath

public Vector<TuioPoint3D> getPath()

Returns the path of this TuioContainer3D.

Returns:

the path of this TuioContainer3D

getMotionSpeed

public float getMotionSpeed()

Returns the motion speed of this TuioContainer3D.

Returns:

the motion speed of this TuioContainer3D

getMotionAccel

public float getMotionAccel()

Returns the motion acceleration of this TuioContainer3D.

Returns:

the motion acceleration of this TuioContainer3D

getTuioState

public int getTuioState()

Returns the TUIO state of this TuioContainer3D.

Returns:

the TUIO state of this TuioContainer3D

isMoving

public boolean isMoving()

Returns true of this TuioContainer3D is moving.

Returns:

true of this TuioContainer3D is moving