TUIO::TuioContainer Class Reference

#include <TuioContainer.h>

Inheritance diagram for TUIO::TuioContainer:

List of all members.

Public Member Functions

TuioContainer (TuioTime ttime, long si, float xp, float yp)

TuioContainer (long si, float xp, float yp)

TuioContainer (TuioContainer *tcon)

virtual ~TuioContainer ()

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

virtual void stop (TuioTime ttime)

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

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

virtual void update (TuioContainer *tcon)

virtual void remove (TuioTime ttime)

virtual long getSessionID ()

virtual float getXSpeed ()

virtual float getYSpeed ()

virtual TuioPoint getPosition ()

virtual std::list< TuioPoint > getPath ()

virtual float getMotionSpeed ()

virtual float getMotionAccel ()

virtual int getTuioState ()

virtual bool isMoving ()

Protected Attributes

long session_id

float x_speed

float y_speed

float motion_speed

float motion_accel

std::list< TuioPoint > path

int state

Detailed Description

The abstract TuioContainer class defines common attributes that apply to both subclasses TuioObject and TuioCursor.

Author:: Martin Kaltenbrunner

Version:: 1.4

Constructor & Destructor Documentation

TUIO::TuioContainer::TuioContainer	(	TuioTime	ttime,
		long	si,
		float	xp,
		float	yp
	)			`[inline]`

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

Parameters:

	ttime	the TuioTime to assign
	si	the Session ID to assign
	xp	the X coordinate to assign
	yp	the Y coordinate to assign

TUIO::TuioContainer::TuioContainer	(	long	si,
		float	xp,
		float	yp
	)			`[inline]`

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

Parameters:

	si	the Session ID to assign
	xp	the X coordinate to assign
	yp	the Y coordinate to assign

TUIO::TuioContainer::TuioContainer ( TuioContainer * tcon ) [inline]

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

Parameters:

tcon

the TuioContainer to assign

virtual TUIO::TuioContainer::~TuioContainer ( ) [inline, virtual]

The destructor is doing nothing in particular.

Member Function Documentation

virtual void TUIO::TuioContainer::update	(	TuioTime	ttime,
		float	xp,
		float	yp
	)			`[inline, virtual]`

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.

Parameters:

	ttime	the TuioTime to assign
	xp	the X coordinate to assign
	yp	the Y coordinate to assign

Reimplemented from TUIO::TuioPoint.

virtual void TUIO::TuioContainer::stop ( TuioTime ttime ) [inline, virtual]

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

Reimplemented in TUIO::TuioObject.

virtual void TUIO::TuioContainer::update	(	TuioTime	ttime,
		float	xp,
		float	yp,
		float	xs,
		float	ys,
		float	ma
	)			`[inline, virtual]`

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

virtual void TUIO::TuioContainer::update	(	float	xp,
		float	yp,
		float	xs,
		float	ys,
		float	ma
	)			`[inline, virtual]`

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

virtual void TUIO::TuioContainer::update ( TuioContainer * tcon ) [inline, virtual]

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

virtual void TUIO::TuioContainer::remove ( TuioTime ttime ) [inline, virtual]

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

Parameters:

ttime

the TuioTime to assign

virtual long TUIO::TuioContainer::getSessionID ( ) [inline, virtual]

Returns the Session ID of this TuioContainer.

Returns:: the Session ID of this TuioContainer

virtual float TUIO::TuioContainer::getXSpeed ( ) [inline, virtual]

Returns the X velocity of this TuioContainer.

Returns:: the X velocity of this TuioContainer

virtual float TUIO::TuioContainer::getYSpeed ( ) [inline, virtual]

Returns the Y velocity of this TuioContainer.

Returns:: the Y velocity of this TuioContainer

virtual TuioPoint TUIO::TuioContainer::getPosition ( ) [inline, virtual]

Returns the position of this TuioContainer.

Returns:: the position of this TuioContainer

virtual std::list<TuioPoint> TUIO::TuioContainer::getPath ( ) [inline, virtual]

Returns the path of this TuioContainer.

Returns:: the path of this TuioContainer

virtual float TUIO::TuioContainer::getMotionSpeed ( ) [inline, virtual]

Returns the motion speed of this TuioContainer.

Returns:: the motion speed of this TuioContainer

virtual float TUIO::TuioContainer::getMotionAccel ( ) [inline, virtual]

Returns the motion acceleration of this TuioContainer.

Returns:: the motion acceleration of this TuioContainer

virtual int TUIO::TuioContainer::getTuioState ( ) [inline, virtual]

Returns the TUIO state of this TuioContainer.

Returns:: the TUIO state of this TuioContainer

virtual bool TUIO::TuioContainer::isMoving ( ) [inline, virtual]

Returns true of this TuioContainer is moving.

Returns:: true of this TuioContainer is moving

Reimplemented in TUIO::TuioObject.

Member Data Documentation

long TUIO::TuioContainer::session_id [protected]

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

float TUIO::TuioContainer::x_speed [protected]

The X-axis velocity value.

float TUIO::TuioContainer::y_speed [protected]

The Y-axis velocity value.

float TUIO::TuioContainer::motion_speed [protected]

The motion speed value.

float TUIO::TuioContainer::motion_accel [protected]

The motion acceleration value.

std::list<TuioPoint> TUIO::TuioContainer::path [protected]

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

int TUIO::TuioContainer::state [protected]

Reflects the current state of the TuioComponent

The documentation for this class was generated from the following file:

TuioContainer.h


Public Member Functions
	TuioContainer (TuioTime ttime, long si, float xp, float yp)
	TuioContainer (long si, float xp, float yp)
	TuioContainer (TuioContainer *tcon)
virtual	~TuioContainer ()
virtual void	update (TuioTime ttime, float xp, float yp)
virtual void	stop (TuioTime ttime)
virtual void	update (TuioTime ttime, float xp, float yp, float xs, float ys, float ma)
virtual void	update (float xp, float yp, float xs, float ys, float ma)
virtual void	update (TuioContainer *tcon)
virtual void	remove (TuioTime ttime)
virtual long	getSessionID ()
virtual float	getXSpeed ()
virtual float	getYSpeed ()
virtual TuioPoint	getPosition ()
virtual std::list< TuioPoint >	getPath ()
virtual float	getMotionSpeed ()
virtual float	getMotionAccel ()
virtual int	getTuioState ()
virtual bool	isMoving ()
Protected Attributes
long	session_id
float	x_speed
float	y_speed
float	motion_speed
float	motion_accel
std::list< TuioPoint >	path
int	state