XML Documentation for gmTrack

This page lists elements defined in the gmTrack module and parameters (P), containers (C), their types and their corresponding C++ methods.

Parameters are set either as attributes or with the param tag, e.g. <param name="fullscreen" value="true">. Containers are typically automatically associated with the child type, through the Object::getDefaultKey() method, however it can be explicitly controlled through the KEY="container" attribute. Observe also that futher documentation for how an attribute should be used is sometimes available adjacent to the C++ methods.

XML attributes are parsed by stream operators. For more information about how this is done, refer to the documentation of the respective stream operator in the gramods namespace.

AnalogsMapper

Analogs filter that re-maps analog indices to a standard order for application compatibility between tracker systems. (more)

	Attribute	Type	Method	Documentation
C	analogsTracker	AnalogsTracker	setAnalogsTracker	Sets the analogs tracker to re-map.
P	horizontalAnalog	int	setHorizontalAnalog	Sets which analog to map to horizontal analog, as an index starting at zero.
P	mapping	size2	addMapping	Adds a mapping in the form of two integer indices: from and to button index, respectively.
P	triggerAnalog	int	setTriggerAnalog	Sets which analog to map to trigger analog, as an index starting at zero.
P	verticalAnalog	int	setVerticalAnalog	Sets which analog to map to vertical analog, as an index starting at zero.

ButtonsMapper

Buttons filter that re-maps button indices to a standard order for application compatibility between tracker systems. (more)

	Attribute	Type	Method	Documentation
C	buttonsTracker	ButtonsTracker	setButtonsTracker	Sets the buttons tracker to re-map.
P	mainButton	int	setMainButton	Sets which button to map to main button, as an index starting at zero.
P	mapping	size2	addMapping	Adds a mapping in the form of two integer indices: from and to button index, respectively.
P	menuButton	int	setMenuButton	Sets which button to map to menu button, as an index starting at zero.
P	secondaryButton	int	setSecondaryButton	Sets which button to map to secondary button, as an index starting at zero.

Controller

A controller is a combination of one or more of a pose tracker, buttons tracker and analogs tracker, also called Wand. (more)

	Attribute	Type	Method	Documentation
C	analogsTracker	AnalogsTracker	setAnalogsTracker	Sets the analogs tracker associated with this controller.
C	buttonsTracker	ButtonsTracker	setButtonsTracker	Sets the buttons tracker associated with this controller.
C	singlePoseTracker	SinglePoseTracker	setSinglePoseTracker	Sets the pose tracker associated with this controller.

MultiToSinglePoseTracker

The base of MultiToSinglePoseTrackers. (more)

	Attribute	Type	Method	Documentation
C	multiPoseTracker	MultiPoseTracker	setMultiPoseTracker	Sets the MultiPoseTracker to extract a single sensor data from.
P	sensor	int	setSensor	Sets the index from the MultiPoseTracker to extract as SinglePoseTracker.

OffsetSinglePoseTracker

Provides the pose as an offset from another single pose tracker. (more)

	Attribute	Type	Method	Documentation
P	offsetMatrix	Matrix4f	setOffsetMatrix	Sets the orientation and position offset by extracting these data from an offset matrix.
P	orientationOffset	Quaternionf	setOrientationOffset	Sets the orientation offset, in local tracker coordinates, to add to the pose data.
P	positionOffset	Vector3f	setPositionOffset	Sets the position offset, in local tracker coordinates, to add to the pose data.
C	singlePoseTracker	SinglePoseTracker	setSinglePoseTracker	Sets the SinglePoseTracker to register data from.

PoseRegistrationEstimator (extends SampleCollector)

The PoseRegistrationEstimator is a utility for estimating the base of a tracking system's coordinates, i e registration of the tracking system into room or display system coordinates. (more)

	Attribute	Type	Method	Documentation
P	actualPosition	Vector3f	addActualPosition	Adds a known calibration point, in room coordinates.

RegisteredMultiPoseTracker

Provides the pose from another multi pose tracker in a registered coordinate system. (more)

	Attribute	Type	Method	Documentation
P	biasMatrix	Matrix4f	setBiasMatrix	Sets the matrix that describes the transform from the tracker space to the registered space.
P	orientationBias	Quaternionf	setOrientationBias	Sets an orientation bias to the registration.
P	positionBias	Vector3f	setPositionBias	Sets a position bias to the registration.
P	registrationMatrix	Matrix4f	setRegistrationMatrix	Sets the matrix that describes the transform from the tracker space to the registered space.
C	singlePoseTracker	MultiPoseTracker	setMultiPoseTracker	Sets the MultiPoseTracker to register data from.

RegisteredSinglePoseTracker

Provides the pose from another single pose tracker in a registered coordinate system. (more)

	Attribute	Type	Method	Documentation
P	biasMatrix	Matrix4f	setBiasMatrix	Sets a bias to the registration.
P	orientationBias	Quaternionf	setOrientationBias	Sets an orientation bias to the registration.
P	positionBias	Vector3f	setPositionBias	Sets a position bias to the registration.
P	registrationMatrix	Matrix4f	setRegistrationMatrix	Sets the matrix that describes the transform from the tracker space to the registered space.
C	singlePoseTracker	SinglePoseTracker	setSinglePoseTracker	Sets the SinglePoseTracker to register data from.

RelativeSinglePoseTracker

The base of RelativeSinglePoseTrackers. (more)

	Attribute	Type	Method	Documentation
C	originTracker	SinglePoseTracker	setOriginTracker	Sets the tracker to be used to read off the origin pose of the target tracker.
C	targetTracker	SinglePoseTracker	setTargetTracker	Sets the tracker to be used to read off the target pose relative to the pose extracted from the origin tracker.

SampleCollector

The SampleCollector is a utility for sampling tracker data. (more)

	Attribute	Type	Method	Documentation
C	controller	Controller	::setController
P	orientationWarningThreshold	float	::setOrientationWarningThreshold
P	samplesPerSecond	float	::setSamplesPerSecond
P	trackerOrientation	Quaternionf	::addTrackerOrientation
P	trackerPosition	Vector3f	::addTrackerPosition
P	warningThreshold	float	::setWarningThreshold

SingleToMultiPoseTracker

The base of SingleToMultiPoseTrackers. (more)

	Attribute	Type	Method	Documentation
C	singlePoseTracker	SinglePoseTracker	addSinglePoseTracker	Adds the SinglePoseTracker to extract a sensor data from.

TimeSampleAnalogsTracker

This analogs tracker reports analog states as specified in the samples of the node. (more)

	Attribute	Type	Method	Documentation
P	analogs	float3	addAnalogs	Adds an analogs sample as three floats representing three analog inputs.
P	time	double	addTime	Adds a time sample in seconds, from the start of the program.

TimeSampleButtonsTracker

This buttons tracker reports button states as specified in the samples of the node. (more)

	Attribute	Type	Method	Documentation
P	time	double	addTime	Adds a time sample in seconds, from the start of the program.

TimeSamplePoseTracker

Pose tracker plays back linear interpolation between specified samples. (more)

	Attribute	Type	Method	Documentation
P	orientation	Quaternionf	addOrientation	Add a orientation sample.
P	position	Vector3f	addPosition	Adds a position sample, in xml as (x y z).
P	time	double	addTime	Adds a time sample in seconds, from the start of the program.

VrpnAnalogsTracker

Analogs tracker reading data off a VRPN server. (more)

	Attribute	Type	Method	Documentation
P	connectionString	string	setConnectionString	The address to the button tracker at the VRPN server, such as "tracker@localhost".

VrpnButtonsTracker

Buttons tracker reading data off a VRPN server. (more)

	Attribute	Type	Method	Documentation
P	connectionString	string	setConnectionString	The address to the button tracker at the VRPN server, such as "tracker@localhost".

VrpnPoseTracker

Pose tracker reading data off a VRPN server. (more)

	Attribute	Type	Method	Documentation
P	connectionString	string	setConnectionString	The address to the pose tracker at the VRPN server, such as "tracker@localhost".

VrpnServer

This class sets up a VRPN server that post data from AnalogsTracker, ButtonsTracker, SinglePoseTracker and MultiPoseTracker instances. (more)

	Attribute	Type	Method	Documentation
C	analogsTracker	AnalogsTracker	addAnalogsTracker	Add an AnalogsTracker to serve from this VRPN server.
C	buttonsTracker	ButtonsTracker	addButtonsTracker	Add a ButtonsTracker to serve from this VRPN server.
C	multiPoseTracker	MultiPoseTracker	addMultiPoseTracker	Add a MultiPoseTracker to serve from this VRPN server.
P	port	int	setPort	Sets the port to bind the VRPN server to.
C	singlePoseTracker	SinglePoseTracker	addSinglePoseTracker	Add a SinglePoseTracker to serve from this VRPN server.
P	trackerName	string	addTrackerName	Add a name to associate with a tracker in this VRPN server.