MarkerTool Class Reference

A base class to define marker-based tools and interactions. More...

Inheritance diagram for MarkerTool:

Public Member Functions
void	OnToggleUI ()
	Toggles the visualization of this tool on/off.

Public Attributes
bool	isTracked
	Runtime Returns true when enough of the markers that compose the tool are tracked for the tool to function.
int[]	markerIds
	Inspector, Code The IDs of the markers to use for this tool.

Protected Member Functions
void	DrawTool ()
	Override this function to implement the visualization of this tool.

Protected Attributes
CanvasGroup	canvasGroup
	Inspector The CanvasGroup to control the visualization of this tool.
bool	isDrawTool
	Inspector Set to true if the tool should be visualized.
MarkerTrackingSystem	trackingSystem
	Inspector The FAST.MarkerTrackingSystem providing the marker data for this tool.

Detailed Description

A base class to define marker-based tools and interactions.

Derive from this class to make your own custom marker-based tools and interactions, or use one of the 7 pre-defined tools.

See also

UnityEngine.CanvasGroup

Member Function Documentation

DrawTool()

void DrawTool ( )

abstractprotected

Override this function to implement the visualization of this tool.

OnToggleUI()

void OnToggleUI

(

)

Toggles the visualization of this tool on/off.

Member Data Documentation

canvasGroup

CanvasGroup canvasGroup

protected

Inspector
The CanvasGroup to control the visualization of this tool.

This is primarily used to turn the visualization on/off, but you could also control the transparency using CanvasGroup.alpha.

isDrawTool

bool isDrawTool

protected

Inspector
Set to true if the tool should be visualized.

isTracked

bool isTracked

Runtime
Returns true when enough of the markers that compose the tool are tracked for the tool to function.

markerIds

int [] markerIds

Inspector, Code
The IDs of the markers to use for this tool.

trackingSystem

MarkerTrackingSystem trackingSystem

protected

Inspector
The FAST.MarkerTrackingSystem providing the marker data for this tool.

---

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

• C:/Users/cgbrown/Development/git/FAST/FAST-SDK/Runtime/Marker Tracking/Marker Tools/MarkerTool.cs