TrackingTable Class Reference

#include <ttable.h>

List of all members.

Public Member Functions
	TrackingTable ()
	Constructor.
	~TrackingTable ()
	destructor
void	AddRow (int bodyID, Body::BodyType type, int sceneId, int SceneNode, Condition condition, TTableEntry::TransformMode mode, float scale)
	Adds new row to table.
void	AddRow (int bodyID, Body::BodyType type, int sceneId, int SceneNode, int pressed, int released, float ctrl1, float ctrl2, TTableEntry::TransformMode mode, float scale)
	Adds new row to table.
void	UpdateRow (int bodyID, Body::BodyType type, int sceneID, int sceneNode, Condition condition, TTableEntry::TransformMode mode, float scale)
	Update table entry or add new one.
void	UpdateRow (int row, Condition condition, TTableEntry::TransformMode mode, float scale)
	Update specified row with new condition, transformation mode and scale.
int	GetFirstRow (int idBody, Body::BodyType type, int scene, int sceneNode)
	returns index to first row with specified key;
int	GetNextRow ()
	returns next row with key used in previous GetFirstRow() method call...
int	GetSceneID (int row)
int	GetSceneNodeID (int row)
void	SetScale (int row, float scale)
	Set scale parameter to entry on specified row.
void	SetTransformMode (int row, TTableEntry::TransformMode mod)
	Set transformation mode to specified row.
void	SetCondition (int row, Condition condition)
	Set another condition to specified row.
float	GetScale (int row)
	returns value of scale on specified row
TTableEntry::TransformMode	GetTransformationMode (int row)
	returns transformation mode from specified row
Condition	GetCondition (int row)
	returns Condition object of specified row
TTableEntry *	getTableEntry (int row)
	returns table entry
void	ProcessTable (Body::BodyType type, int bodyID, MATRIX bodyMatrix, int buttons, float ctrl1, float ctrl2, VRUT::SceneModule *module)
	Compares table with parameters and generate transformation events.
bool	InsertLine (int bodyID, Body::BodyType type, int sceneID, int sceneNode, int pressed, int released, float ctrl1, float ctrl2, TTableEntry::TransformMode mode, float scale)
	Insert a line with specified values returns true if line was added.
bool	EraseLine (int bodyID, Body::BodyType type, int sceneID, int sceneNode, int pressed, int released, float ctrl1, float ctrl2, TTableEntry::TransformMode mode, float scale)
	Find and delete line. returns true if line was deleted.
void	ClearTable ()
	clear all table
wxString	GetAsString ()
	Return all table as string.
void	WriteToLog ()
Private Attributes
std::vector< TTableEntry >	table
	implementation of table
int	iterator
	Iterator helps to browse rows with the same tracked device.
int	idBody
	Body identificator. It helps to browse rows with the same tracked device.
Body::BodyType	type
	the type of tracked device. It helps to browse rows with the same device
int	SceneId
	identificator of scene
int	SceneNodeID
	identificator od node in scene graph

---

Detailed Description

Tracking table. It connects the node of specified scene and tracked device and making scene transformations based on transformation of tracked device. The transformation is also subject to specified condition. Table can have more then one row with connection between specific Tracked device and Node of scene It is because there may be more then one condition on how to handle with transformations Please be sure to use exclusive Conditions on the rows connecting the same scene nodes and tracked devices

Definition at line 231 of file ttable.h.

---

Constructor & Destructor Documentation

TrackingTable::TrackingTable

(

)

Constructor.

Definition at line 357 of file ttable.cpp.

{
       iterator    = -1;
       idBody     = -1;
       SceneId     = -1;
       SceneNodeID = -1;
}

TrackingTable::~TrackingTable

(

)

destructor

Definition at line 364 of file ttable.cpp.

{}

---

Member Function Documentation

void TrackingTable::AddRow	(	int	bodyID,
		Body::BodyType	type,
		int	sceneId,
		int	SceneNode,
		Condition	condition,
		TTableEntry::TransformMode	mode,
		float	scale
	)

Adds new row to table.

Parameters:

	bodyID	Number identificator of tracked device
	type	The type of specified body
	sceneId	- Identificator of scene
	SceneNode	Identificator of node in scene graph

Definition at line 366 of file ttable.cpp.

{
       TTableEntry entry(bodyID, type, sceneId, SceneNode, condition, mode,scale);
       table.push_back(entry);
}

void TrackingTable::AddRow	(	int	bodyID,
		Body::BodyType	type,
		int	sceneId,
		int	SceneNode,
		int	pressed,
		int	released,
		float	ctrl1,
		float	ctrl2,
		TTableEntry::TransformMode	mode,
		float	scale
	)

Adds new row to table.

Parameters:

	bodyID	Number identificator of tracked device
	type	The type of specified body
	sceneId	- Identificator of scene
	SceneNode	Identificator of node in scene graph
	pressed	- parameter of Condition (see Condition class description)
	released	- parameter of Condition
	ctrl1	- parameter of Condition
	ctrl2	- parameter of Condition

Definition at line 371 of file ttable.cpp.

{
       Condition condition(pressed,released,ctrl1, ctrl2);
       TTableEntry entry(bodyID, type, sceneId, SceneNode, condition, mode,scale);
       table.push_back(entry);
}

void TrackingTable::UpdateRow	(	int	bodyID,
		Body::BodyType	type,
		int	sceneID,
		int	sceneNode,
		Condition	condition,
		TTableEntry::TransformMode	mode,
		float	scale
	)

Update table entry or add new one.

If there is no row with specified: bodyID, type, sceneId and SceneNode it adds new one. If there are some lines. First of them will be updated

Parameters:

	bodyID	Part of the primary key : Tracked device number identificator
	type	Part of the primary key : Tracked device type identificator
	sceneID	Part of the primary key : Id of the scene
	sceneNode	Part of the primary key : Identificator of the node in scene graph
	condition	Condition parameter to be updated
	mode	Transformation Mode parameter to be updated
	scale	Scale parameter to be updated

Definition at line 377 of file ttable.cpp.

{
       int iter = this->GetFirstRow(bodyID, type, sceneID, sceneNode);
       if (iter == -1)
       {
              AddRow(bodyID, type, sceneID, sceneNode, condition, mode, scale);
       }
       else
       {
              UpdateRow(iter, condition, mode, scale);
       }
}

void TrackingTable::UpdateRow	(	int	row,
		Condition	condition,
		TTableEntry::TransformMode	mode,
		float	scale
	)

Update specified row with new condition, transformation mode and scale.

if specified row is not in scope of table nothing will be done

Parameters:

	row	- number of row to be updated - use GetFirstRow() or GetNextRow() to determine this parameter
	condition	Condition parameter to be updated
	mode	Transformation Mode parameter to be updated
	scale	Scale parameter to be updated

Definition at line 389 of file ttable.cpp.

{
       if (row >= (int)table.size()) return;
       table[row].SetCondition(condition);
       table[row].SetTransformMode(mode);
       table[row].SetScale(scale);
}

int TrackingTable::GetFirstRow	(	int	idBody,
		Body::BodyType	type,
		int	scene,
		int	sceneNode
	)

returns index to first row with specified key;

-1 is returned if no row was found

Parameters:

	idBody	Number identificator of tracked device.
	type	The type of specified body.
	scene	Identificator of scene.
	sceneNode	Identificator of node in scene graph.

Definition at line 397 of file ttable.cpp.

{
       iterator = -1;
       this->idBody = idBody;
       this->type = type;
       this->SceneId = scene;
       this->SceneNodeID = sceneNode;
       for (size_t i = 0; i < table.size(); i++)
       {
              if (table[i].GetBodyID() == idBody && table[i].GetBodyType() == type && table[i].GetSceneID() == scene && table[i].GetSceneNodeID() == sceneNode)
              {
                     iterator = (int)i;
                     return iterator;
              }
       }
       return iterator;
}

int TrackingTable::GetNextRow

(

)

returns next row with key used in previous GetFirstRow() method call...

if -1 is returned no new line was found;

Definition at line 414 of file ttable.cpp.

{
       if (iterator == -1) iterator = 0;
       for (size_t i = iterator; i < table.size(); i++)
       {
              if (table[i].GetBodyID() == idBody && table[i].GetBodyType() == type && table[i].GetSceneID() == SceneId && table[i].GetSceneNodeID() == SceneNodeID)
              {
                     iterator = (int)i;
                     return iterator;
              }
       }
       iterator = -1;
       return iterator;
}

int TrackingTable::GetSceneID

(

int

row

)

Definition at line 453 of file ttable.cpp.

{
       //if (row >= (int)table.size()) return ;
       return table[row].GetSceneID();
}

int TrackingTable::GetSceneNodeID

(

int

row

)

Definition at line 458 of file ttable.cpp.

{
       //if (row >= (int)table.size()) return ;
       return table[row].GetSceneNodeID();
}

void TrackingTable::SetScale	(	int	row,
		float	scale
	)

Set scale parameter to entry on specified row.

Parameters:

	row	- row where to update paramter
	scale	- new value of scale for specified row

Definition at line 428 of file ttable.cpp.

{
       if (row >= (int)table.size()) return;
       table[row].SetScale(scale);
}

void TrackingTable::SetTransformMode	(	int	row,
		TTableEntry::TransformMode	mod
	)

Set transformation mode to specified row.

Parameters:

	row	- row where to update paramter
	mod	- new value of transformation mode for specified row

Definition at line 433 of file ttable.cpp.

{
       if (row >= (int)table.size()) return;
       table[row].SetTransformMode(mod);
}

void TrackingTable::SetCondition	(	int	row,
		Condition	condition
	)

Set another condition to specified row.

Parameters:

	row	- row where to update paramter
	condition	- new value of condition for specified row (see Condition class description)

Definition at line 438 of file ttable.cpp.

{
       if (row >= (int)table.size()) return;
       table[row].SetCondition(cond);
}

float TrackingTable::GetScale

(

int

row

)

returns value of scale on specified row

Definition at line 443 of file ttable.cpp.

{
       //if (row >= (int)table.size()) return 0;
       return table[row].GetScale();
}

TTableEntry::TransformMode TrackingTable::GetTransformationMode

(

int

row

)

returns transformation mode from specified row

Definition at line 448 of file ttable.cpp.

{
       //if (row >= (int)table.size()) return ;
       return table[row].GetTransformationMode();
}

Condition TrackingTable::GetCondition

(

int

row

)

returns Condition object of specified row

Definition at line 463 of file ttable.cpp.

{
       //if (row >= (int)table.size()) return ;
       return table[row].GetCondition();
}

TTableEntry * TrackingTable::getTableEntry

(

int

row

)

returns table entry

please avoid to use this method

Definition at line 468 of file ttable.cpp.

{
       //if (row >= (int)table.size()) return ;
       return &table[row];
}

void TrackingTable::ProcessTable	(	Body::BodyType	type,
		int	bodyID,
		MATRIX	bodyMatrix,
		int	buttons,
		float	ctrl1,
		float	ctrl2,
		VRUT::SceneModule *	module
	)

Compares table with parameters and generate transformation events.

Parameters:

	type	The type of tracked device
	bodyID	The number identificator of tracked device
	bodyMatrix	Current Matrix with transformation and rotation of tracked device
	buttons	Mask of currently pressed buttons
	ctrl1	Current value of Control 1 (Flystick 2 joystick left-right)
	ctrl2	Current value of Control 2 (Flystick 3 joystick up-down)

Definition at line 473 of file ttable.cpp.

{
//     LOG(wxT("Processing table..."));
//     LOG(wxString::Format(wxT("type %i, id %i"), type, bodyID));
       if (ctrl1 < -1 || ctrl1 > 1) ctrl1 = 0;
       if (ctrl2 < -1 || ctrl2 > 1) ctrl2 = 0;
       for (size_t i = 0 ; i < table.size(); i++)
       {
//            LOG(wxString::Format(wxT("Entries:: type %i, id %i"), (int)table[i].GetBodyType(), table[i].GetBodyID()));
              if (bodyID == table[i].GetBodyID() && type == (int)table[i].GetBodyType())
              {
//                   LOG(wxT("Entry found..."));
                     table[i].generateEvent(bodyMatrix, buttons, ctrl1, ctrl2, module);
              }
       }
}

bool TrackingTable::InsertLine	(	int	bodyID,
		Body::BodyType	type,
		int	sceneID,
		int	sceneNode,
		int	pressed,
		int	released,
		float	ctrl1,
		float	ctrl2,
		TTableEntry::TransformMode	mode,
		float	scale
	)

Insert a line with specified values returns true if line was added.

This method shloud be useful when the table is controlled by events this method works nearly as the AddRow, the differene is that it checks if there is not the same line and also checks validity of condition parameters (pressed, released, ctrl1, ctrl2) (Some devices do not have buttons or controls so they shouldn't affect transformations). If there is already a line with the same values nothing will be done

Parameters:

	bodyID	Part of the primary key : Tracked device number identificator
	type	Part of the primary key : Tracked device type identificator
	sceneID	Part of the primary key : Id of the scene
	sceneNode	Part of the primary key : Identificator of the node in scene graph
	condition	Condition parameter to be updated
	mode	Transformation Mode parameter to be updated
	scale	Scale parameter to be updated

Definition at line 489 of file ttable.cpp.

{
       if (type != Body::B6DF2) // check if the body doesn't have controls
       {
              ctrl1 = ctrl2 = 0;
       }
       if (type == Body::B6D || type == Body::B3D || type == Body::BGL) // check if the body doesn't have buttons
       {
              pressed = released = 0;
       }
       std::vector<TTableEntry>::iterator i;
       for (i = table.begin(); i != table.end(); i++)
       {
              Condition cond = (*i).GetCondition();
              if ((*i).GetBodyID()             == bodyID    &&
                     (*i).GetBodyType()           == type      &&
                     (*i).GetSceneID()            == sceneID   &&
                     (*i).GetSceneNodeID()        == sceneNode &&
                     cond.PressedMask()           == pressed   &&
                     cond.ReleasedMask()          == released  &&
                     cond.Control1()              == ctrl1     &&
                     cond.Control2()              == ctrl2       &&
                     (*i).GetTransformationMode() == mode      &&
                     (*i).GetScale()              == scale       ) return false;
       }
       // if not returned after the same row found...
       this->AddRow(bodyID, type, sceneID, sceneNode, pressed, released, ctrl1, ctrl2, mode, scale);
       return true;
}

bool TrackingTable::EraseLine	(	int	bodyID,
		Body::BodyType	type,
		int	sceneID,
		int	sceneNode,
		int	pressed,
		int	released,
		float	ctrl1,
		float	ctrl2,
		TTableEntry::TransformMode	mode,
		float	scale
	)

Find and delete line. returns true if line was deleted.

ths method should be useful when the table is controlled by events. Condition parameters are checked for validity (pressed, released, ctrl1, ctrl2) and corrected. (Some devices specified with the type doesn't have any button or control)
Note that this method goes through table and deletes first occurence of the line. If there are some duplicities they will be not deleted. Please be sure to not inserting duplicities while using this class or call this method until it returns false;

Parameters:

	bodyID	Part of the primary key : Tracked device number identificator
	type	Part of the primary key : Tracked device type identificator
	sceneID	Part of the primary key : Id of the scene
	sceneNode	Part of the primary key : Identificator of the node in scene graph
	condition	Condition parameter to be updated
	mode	Transformation Mode parameter to be updated
	scale	Scale parameter to be updated

Definition at line 518 of file ttable.cpp.

{
       if (type != Body::B6DF2) // check if the body doesn't have controls
       {
              ctrl1 = ctrl2 = 0;
       }
       if (type == Body::B6D || type == Body::B3D || type == Body::BGL) // check if the body doesn't have buttons
       {
              pressed = released = 0;
       }
       std::vector<TTableEntry>::iterator i;
       for (i = table.begin(); i != table.end(); i++)
       {
              Condition cond = (*i).GetCondition();
              if ((*i).GetBodyID()             == bodyID    &&
                     (*i).GetBodyType()           == type      &&
                     (*i).GetSceneID()            == sceneID   &&
                     (*i).GetSceneNodeID()        == sceneNode &&
                     cond.PressedMask()           == pressed   &&
                     cond.ReleasedMask()          == released  &&
                     cond.Control1()              == ctrl1     &&
                     cond.Control2()              == ctrl2       &&
                     (*i).GetTransformationMode() == mode      &&
                     (*i).GetScale()              == scale       )
              {
                     table.erase(i);
                     return true;
              }
       }
       return false;
}

void TrackingTable::ClearTable

(

)

clear all table

Definition at line 549 of file ttable.cpp.

{
       table.clear();
}

wxString TrackingTable::GetAsString

(

)

Return all table as string.

Parameters:

	lineSeparator	- character (op possibly string) used as separator to differ lines of the table
	atributeSeparator	- character (or possibly string) used as separator to differ atributes within the line

Definition at line 554 of file ttable.cpp.

{
       wxString dump = wxT("");
       size_t  max = table.size();
       for (size_t i = 0; i < max; i++)
       {
              dump << table[i].GetAsString() << wxT("\n");
       }
       return dump;
}

void TrackingTable::WriteToLog

(

)

Definition at line 564 of file ttable.cpp.

{
       size_t max = table.size();
       if (max == 0) 
       {
              LOG(wxT("<TrackingManipulator> Table empty!"));
              return;
       }
       else
       {
              wxString dump = wxT("<TrackingManipulator> Table: (scene node type id mode pressed released ctrl1 ctrl2 scale)\n");
              for (size_t i = 0; i < max; i++)
              {
                     Condition c = table[i].GetCondition();
                     dump << table[i].GetSceneID() << wxT(" ") << table[i].GetSceneNodeID()
                             << wxT(" ") << table[i].GetBodyType() << wxT(" ") << table[i].GetBodyID()
                             << wxT(" ") << table[i].GetTransformationMode() << wxT(" ") << c.PressedMask()
                             << wxT(" ") << c.ReleasedMask() << wxT(" ") << c.Control1() << wxT(" ") << c.Control2()
                             << wxT(" ") << table[i].GetScale() <<wxT("\n");
              }
              LOG(dump);
       }
}

---

Member Data Documentation

std::vector<TTableEntry> TrackingTable::table [private]

implementation of table

Definition at line 235 of file ttable.h.

int TrackingTable::iterator [private]

Iterator helps to browse rows with the same tracked device.

Definition at line 237 of file ttable.h.

int TrackingTable::idBody [private]

Body identificator. It helps to browse rows with the same tracked device.

Definition at line 239 of file ttable.h.

Body::BodyType TrackingTable::type [private]

the type of tracked device. It helps to browse rows with the same device

Definition at line 241 of file ttable.h.

int TrackingTable::SceneId [private]

identificator of scene

Definition at line 243 of file ttable.h.

int TrackingTable::SceneNodeID [private]

identificator od node in scene graph

Definition at line 245 of file ttable.h.

---

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

• /cygdrive/d/src/svn/vrut/trunk/modules/trackingmanipulator/ttable.h
• /cygdrive/d/src/svn/vrut/trunk/modules/trackingmanipulator/ttable.cpp