FAST SDK Coding Reference 1.0.3
Loading...
Searching...
No Matches
MarkerTrackingSystem Class Reference

Manages marker tracking in terms of receiving, filtering, storing, accessing, and visualizing the marker data. More...

Public Member Functions

void OnToggleUI ()
 Toggles the visualization of markers on/off.
 

Public Attributes

MarkerData[] markerDataLUT
 The most recently recieved marker tracking data ordered by FAST.MarkerData.id.
 

Properties

float Height [get]
 Returns the height of the FAST.MarkerTrackingSystem.trackingArea.
 
float Width [get]
 Returns the width of the FAST.MarkerTrackingSystem.trackingArea.
 

Private Attributes

bool isDrawMarkers
 Inspector
Set to true if the tracked markers should be visualized.
 
GameObject markerParent
 Inspector
The parent GameObject where Marker Prefabs will be added at runtime to visualize the markers.
 
GameObject markerPrefab
 Inspector
The prefab to use as a visualization of a marker at runtime.
 
GameObject[] markers
 Runtime
The array of marker visualization GameObjects instantiated from FAST.MarkerTrackingSystem.markerPrefab at runtime.
 
int maxNumMarkers = 24
 Settings
The maximum number of markers that this marker tracking system can track.
 
float positionFilterAmount = 0.5f
 Inspector
The amount of filtering to apply to the marker position and size.
 
float rotationFilterAmount = 0.25f
 Inspector
The amount of filtering to apply to the marker orientation.
 
RectTransform trackingArea
 Inspector
The RectTransform that represents the marker tracking area.
 
double trackingTimeout = 0.25
 Inspector
The amount of time in seconds before the marker tracking changes from FAST.MarkerData.TrackingState.Inferred to FAST.MarkerData.TrackingState.NotTracked when a marker isn't detected.
 
UdpConnection udpConnection
 Settings
The FAST.UdpConnection to receive marker tracking data from.
 

Detailed Description

Manages marker tracking in terms of receiving, filtering, storing, accessing, and visualizing the marker data.

Use the Marker Tracking System Prefab to instantiate a MarkerTrackingSystem with default attributes and assignments.

See also
UnityEngine.GameObject
UnityEngine.RectTransform

Member Function Documentation

◆ OnToggleUI()

void OnToggleUI ( )

Toggles the visualization of markers on/off.

Member Data Documentation

◆ isDrawMarkers

bool isDrawMarkers
private

Inspector
Set to true if the tracked markers should be visualized.

◆ markerDataLUT

MarkerData [] markerDataLUT

The most recently recieved marker tracking data ordered by FAST.MarkerData.id.

◆ markerParent

GameObject markerParent
private

Inspector
The parent GameObject where Marker Prefabs will be added at runtime to visualize the markers.

This will already be assigned if you use the Marker Tracking System Prefab.

◆ markerPrefab

GameObject markerPrefab
private

Inspector
The prefab to use as a visualization of a marker at runtime.

This will already be assigned as the Marker Prefab if you use the Marker Tracking System Prefab.

◆ markers

GameObject [] markers
private

Runtime
The array of marker visualization GameObjects instantiated from FAST.MarkerTrackingSystem.markerPrefab at runtime.

◆ maxNumMarkers

int maxNumMarkers = 24
private

Settings
The maximum number of markers that this marker tracking system can track.

This value can be found in the Computer Vision app, but the default is 24.

◆ positionFilterAmount

float positionFilterAmount = 0.5f
private

Inspector
The amount of filtering to apply to the marker position and size.

0 is the new raw position/size and 1 is the previous filtered position/size. Any value in between is linearly interpolated.

◆ rotationFilterAmount

float rotationFilterAmount = 0.25f
private

Inspector
The amount of filtering to apply to the marker orientation.

0 is the new raw orientation and 1 is the previous filtered orientation. Any value in between is linearly interpolated.

◆ trackingArea

RectTransform trackingArea
private

Inspector
The RectTransform that represents the marker tracking area.

This will already be assigned if you use the Marker Tracking System Prefab.

Specifying the tracking area as a RectTransform allows a FAST.AlignmentRectTransform to be used where the size is specified in the activity settings XML file.

◆ trackingTimeout

double trackingTimeout = 0.25
private

Inspector
The amount of time in seconds before the marker tracking changes from FAST.MarkerData.TrackingState.Inferred to FAST.MarkerData.TrackingState.NotTracked when a marker isn't detected.

◆ udpConnection

UdpConnection udpConnection
private

Settings
The FAST.UdpConnection to receive marker tracking data from.

Property Documentation

◆ Height

float Height
get

Returns the height of the FAST.MarkerTrackingSystem.trackingArea.

◆ Width

float Width
get

Returns the width of the FAST.MarkerTrackingSystem.trackingArea.


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