User Manual

82 Location Software Library PLUS System Manual
Proprietary Information: Do not disclose unless authorized under a Nondisclosure Agreement and the Partner Agreement.
replaced with the nearest point on the tracking cell boundary. If the computed distance is larger that this value,
the position is discarded.
bufferSize is the number of values in the tracking cell. Each point requires two values, an X and Y value. For
example if four points define a tracking cell then the buffer would contain eight values.
trackingCellPoints is a buffer containing the points that define a tracking cell. Each point is the x,y position of that
point.
Returns
0 - Success
less than zero – Invalid map parameters.
4.5.2.6.2 GetMapParms Function
public virtual int GetMapParms( int mapIndex,
int out flags,
double out snapDist ,
int bufferSize,
int out bufferUsed,
double * trackingCellPoints)
This function retrieves the parameters for a map. A map can have a tracking cell which is a polygon boundary
limiting where Tag positions can be computed. The map must exist or an error is returned.
mapIndex is the ID for the map. Must be greater or equal to zero.
flags is a bit field that controls the map characteristics
Bit 0 - Map Tracking Cell is enabled
snapDist is used to control the “snap to” feature. If a position is outside the tracking cell, the distance to the
nearest point on the tracking cell boundary is computed. If that distance is less than this value, the position is
replaced with the nearest point on the tracking cell boundary. If the computed distance is larger that this value,
the position is discarded.
bufferSize is the number of values in the tracking cell. Each point requires two values, an X and Y value. For
example if four points define a tracking cell then the buffer would contain eight values.
trackingCellPoints is a buffer containing the points that define a tracking cell. Each point is the x,y position of that
point.
Returns
0 - Success
less than zero – Invalid mapIndex.
4.5.2.7 Calibration Tag Configuration
The functions in this section are used to configure the Location Software’s internal database of
calibration Tags.