A window containing a gl-object's parameter. More...

#include <GUIParameterTableWindow.h>

Inheritance diagram for GUIParameterTableWindow:

Collaboration diagram for GUIParameterTableWindow:

Public Member Functions
void	closeBuilding (const Parameterised *p=0)
	Closes the building of the table. More...

	GUIParameterTableWindow (GUIMainWindow &app, GUIGlObject &o, int noRows)
	Constructor. More...

void	removeObject (GUIGlObject *const o)
	Lets this window know the object shown is being deleted. More...

	~GUIParameterTableWindow ()
	Destructor. More...

Row adding functions
void	mkItem (const char name, bool dynamic, ValueSource< unsigned > src)
	Adds a row which obtains its value from an unsigned-ValueSource. More...

void	mkItem (const char name, bool dynamic, ValueSource< int > src)
	Adds a row which obtains its value from an integer-ValueSource. More...

void	mkItem (const char name, bool dynamic, ValueSource< double > src)
	Adds a row which obtains its value from an double-ValueSource. More...

void	mkItem (const char *name, bool dynamic, std::string value)
	Adds a row which shows a string-value. More...

void	mkItem (const char *name, bool dynamic, unsigned value)
	Adds a row which shows a unsigned-value. More...

void	mkItem (const char *name, bool dynamic, int value)
	Adds a row which shows a integer-value. More...

void	mkItem (const char *name, bool dynamic, long long int value)
	Adds a row which shows a 64 bit integer-value. More...

void	mkItem (const char *name, bool dynamic, double value)
	Adds a row which shows a double-value. More...

FOX-callbacks
long	onSimStep (FXObject , FXSelector, void )
	Updates the table due to a simulation step. More...

long	onTableSelected (FXObject , FXSelector, void )
	Does nothing. More...

long	onTableDeselected (FXObject , FXSelector, void )
	Does nothing. More...

long	onRightButtonPress (FXObject , FXSelector, void )
	Shows a popup. More...

Static Public Member Functions
static void	updateAll ()
	Updates all instances. More...

Protected Member Functions
	GUIParameterTableWindow ()
	FOX needs this. More...

void	updateTable ()
	Updates the table. More...

Static Protected Attributes
static std::vector< GUIParameterTableWindow * >	myContainer
	The container of items that shall be updated. More...

static MFXMutex	myGlobalContainerLock
	The mutex used to avoid concurrent updates of the instance container. More...

Static Private Member Functions
static int	numParams (const GUIGlObject *obj)
	returns the number of parameters if obj is Parameterised and 0 otherwise More...

Private Attributes
GUIMainWindow *	myApplication
	The main application window. More...

unsigned	myCurrentPos
	The index of the next row to add - used while building. More...

std::vector< GUIParameterTableItemInterface * >	myItems
	The list of table rows. More...

MFXMutex	myLock
	A lock assuring save updates in case of object deletion. More...

GUIGlObject *	myObject
	The object to get the information from. More...

FXTable *	myTable
	The table to display the information in. More...

Detailed Description

A window containing a gl-object's parameter.

This class realises a view on some parameter of a gl-object. The gl-object itself is responsible for filling this table.

After allocating such a table, the object should fill the rows by calling one of the mkItem-methods for each. The building is closed using closeBuilding what forces the table to be displayed.

Each row is represented using an instance of GUIParameterTableItemInterface.

Definition at line 70 of file GUIParameterTableWindow.h.

Constructor & Destructor Documentation

GUIParameterTableWindow::GUIParameterTableWindow	(	GUIMainWindow &	app,
		GUIGlObject &	o,
		int	noRows
	)

Constructor.

Parameters

[in]	app	The application this window belongs to
[in]	o	The gl-object this table describes
[in]	noRows	Number of rows to allocate

Definition at line 69 of file GUIParameterTableWindow.cpp.

References GUIIconSubSys::getIcon(), ICON_APP_TABLE, and MID_TABLE.

GUIParameterTableWindow::~GUIParameterTableWindow ( )

Destructor.

Definition at line 100 of file GUIParameterTableWindow.cpp.

References MFXMutex::lock(), myApplication, myContainer, myGlobalContainerLock, myItems, myLock, myObject, GUIMainWindow::removeChild(), GUIGlObject::removeParameterTable(), and MFXMutex::unlock().

GUIParameterTableWindow::GUIParameterTableWindow ( )

inlineprotected

FOX needs this.

Definition at line 263 of file GUIParameterTableWindow.h.

Member Function Documentation

void GUIParameterTableWindow::closeBuilding ( const Parameterised * p = 0 )

Closes the building of the table.

Adds the table to the list of child windows of the applications also telling the application that the window should be updated in each simulation step. Shows the table.

See also: GUIMainWindow::addChild

Definition at line 255 of file GUIParameterTableWindow.cpp.

References GUIMainWindow::addChild(), Parameterised::getMap(), mkItem(), myApplication, and myObject.

void GUIParameterTableWindow::mkItem	(	const char *	name,
		bool	dynamic,
		ValueSource< unsigned > *	src
	)

Adds a row which obtains its value from an unsigned-ValueSource.

Parameters

[in]	name	The name of the row entry
[in]	dynamic	Information whether the entry is dynamic
[in]	src	The value source to use

Definition at line 178 of file GUIParameterTableWindow.cpp.

References myCurrentPos, myItems, and myTable.

void GUIParameterTableWindow::mkItem	(	const char *	name,
		bool	dynamic,
		ValueSource< int > *	src
	)

Adds a row which obtains its value from an integer-ValueSource.

Parameters

[in]	name	The name of the row entry
[in]	dynamic	Information whether the entry is dynamic
[in]	src	The value source to use

Definition at line 186 of file GUIParameterTableWindow.cpp.

References myCurrentPos, myItems, and myTable.

void GUIParameterTableWindow::mkItem	(	const char *	name,
		bool	dynamic,
		ValueSource< double > *	src
	)

Adds a row which obtains its value from an double-ValueSource.

Parameters

[in]	name	The name of the row entry
[in]	dynamic	Information whether the entry is dynamic
[in]	src	The value source to use

Definition at line 194 of file GUIParameterTableWindow.cpp.

References myCurrentPos, myItems, and myTable.

void GUIParameterTableWindow::mkItem	(	const char *	name,
		bool	dynamic,
		std::string	value
	)

Adds a row which shows a string-value.

Parameters

[in]	name	The name of the row entry
[in]	dynamic	Information whether the entry is dynamic
[in]	value	The value to show

Todo:: the dynamic-parameter is obsolete(?)

Definition at line 202 of file GUIParameterTableWindow.cpp.

References myCurrentPos, myItems, and myTable.

void GUIParameterTableWindow::mkItem	(	const char *	name,
		bool	dynamic,
		unsigned	value
	)

Adds a row which shows a unsigned-value.

Parameters

[in]	name	The name of the row entry
[in]	dynamic	Information whether the entry is dynamic
[in]	value	The value to show

Todo:: the dynamic-parameter is obsolete

Definition at line 219 of file GUIParameterTableWindow.cpp.

References myCurrentPos, myItems, and myTable.

void GUIParameterTableWindow::mkItem	(	const char *	name,
		bool	dynamic,
		int	value
	)

Adds a row which shows a integer-value.

Parameters

[in]	name	The name of the row entry
[in]	dynamic	Information whether the entry is dynamic
[in]	value	The value to show

Todo:: the dynamic-parameter is obsolete

Definition at line 227 of file GUIParameterTableWindow.cpp.

References myCurrentPos, myItems, and myTable.

void GUIParameterTableWindow::mkItem	(	const char *	name,
		bool	dynamic,
		long long int	value
	)

Adds a row which shows a 64 bit integer-value.

Parameters

[in]	name	The name of the row entry
[in]	dynamic	Information whether the entry is dynamic
[in]	value	The value to show

Todo:: the dynamic-parameter is obsolete

Definition at line 235 of file GUIParameterTableWindow.cpp.

References myCurrentPos, myItems, and myTable.

void GUIParameterTableWindow::mkItem	(	const char *	name,
		bool	dynamic,
		double	value
	)

Adds a row which shows a double-value.

Parameters

[in]	name	The name of the row entry
[in]	dynamic	Information whether the entry is dynamic
[in]	value	The value to show

Todo:: the dynamic-parameter is obsolete

Definition at line 211 of file GUIParameterTableWindow.cpp.

References myCurrentPos, myItems, and myTable.

int GUIParameterTableWindow::numParams ( const GUIGlObject * obj )

staticprivate

returns the number of parameters if obj is Parameterised and 0 otherwise

Definition at line 272 of file GUIParameterTableWindow.cpp.

References Parameterised::getMap().

long GUIParameterTableWindow::onRightButtonPress	(	FXObject *	sender,
		FXSelector	sel,
		void *	data
	)

Shows a popup.

Callback for right-mouse-button pressing event. Obtains the selected row and determines whether it is dynamic. If so, a popup-menu which allows to open a tracker for this value is built and shown.