MarkerToggle Class Reference

A predefined tool for a 2-state toggle. More...

Inheritance diagram for MarkerToggle:

Public Attributes
MarkerData	optionAMarker
	Inspector, Code The tracking data for the marker used by state A.
MarkerData	optionBMarker
	Inspector, Code The tracking data for the marker used by state B.
string	value
	Inspector, Code Identifies the state of the toggle that is currently being tracked.
Public Attributes inherited from MarkerTool
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.

Private Attributes
string	optionA
	Inspector The identifier to use for when state A is being tracked.
TMP_Text	optionAIdText
	Inspector UI TMP_Text to label the ID of the marker used by state A.
Image	optionAPointImage
	Inspector UI Image to visualize the position of the marker used by state A.
TMP_Text	optionAValueText
	Inspector UI TMP_Text to label the value of state A.
string	optionB
	Inspector The identifier to use for when state B is being tracked.
TMP_Text	optionBIdText
	Inspector UI TMP_Text to label the ID of the marker used by state B.
Image	optionBPointImage
	Inspector UI Image to visualize the position of the marker used by state B.
TMP_Text	optionBValueText
	Inspector UI TMP_Text to label the value of state B.

Additional Inherited Members
Public Member Functions inherited from MarkerTool
void	OnToggleUI ()
	Toggles the visualization of this tool on/off.
Protected Member Functions inherited from MarkerTool
void	DrawTool ()
	Override this function to implement the visualization of this tool.
Protected Attributes inherited from MarkerTool
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 predefined tool for a 2-state toggle.

The toggle is a physical switch with 2 states, A and B. A marker is placed in each state, such that only 1 mark is visible and tracked at a time.

Use the Marker Toggle Prefab to instantiate this tool with default attributes and assignments.

See also

UnityEngine.UI.Image

TMPro.TMP_Text

Member Data Documentation

optionA

string optionA

private

Inspector
The identifier to use for when state A is being tracked.

optionAIdText

TMP_Text optionAIdText

private

Inspector
UI TMP_Text to label the ID of the marker used by state A.

optionAMarker

MarkerData optionAMarker

Inspector, Code
The tracking data for the marker used by state A.

optionAPointImage

Image optionAPointImage

private

Inspector
UI Image to visualize the position of the marker used by state A.

optionAValueText

TMP_Text optionAValueText

private

Inspector
UI TMP_Text to label the value of state A.

optionB

string optionB

private

Inspector
The identifier to use for when state B is being tracked.

optionBIdText

TMP_Text optionBIdText

private

Inspector
UI TMP_Text to label the ID of the marker used by state B.

optionBMarker

MarkerData optionBMarker

Inspector, Code
The tracking data for the marker used by state B.

optionBPointImage

Image optionBPointImage

private

Inspector
UI Image to visualize the position of the marker used by state B.

optionBValueText

TMP_Text optionBValueText

private

Inspector
UI TMP_Text to label the value of state B.

value

string value

Inspector, Code
Identifies the state of the toggle that is currently being tracked.

---

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

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