MarkerButton Class Reference

A predefined tool for a button. More...

Inheritance diagram for MarkerButton:

Public Attributes
MarkerData	buttonPressMarker
	Inspector, Code The tracking data for the button press marker.
MarkerData	buttonReferenceMarker
	Inspector, Code The tracking data for the reference marker.
string	value
	Inspector, Code Identifies the state of the button as either up and pressed down.
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
TMP_Text	buttonPressIdText
	Inspector UI TMP_Text to label the ID of the button press marker.
Image	buttonPressImage
	Inspector UI Image to visualize the position of the button press marker.
TMP_Text	buttonReferenceIdText
	Inspector UI TMP_Text to label the ID of the reference marker.
Image	buttonReferencePointImage
	Inspector UI Image to visualize the position of the reference marker.
TMP_Text	buttonValueText
	Inspector UI TMP_Text to label the FAST.MarkerButton.value.

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 button.

This is a physical button with 2 states, up and pressed down. One marker is placed on the button housing as reference for the button position and must always be visible. A second marker is placed on a mechanism that moves down button the button is pressed and up when released. The second marker is only visible in the up state and occluded in the down state.

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

See also

UnityEngine.UI.Image

TMPro.TMP_Text

Member Data Documentation

buttonPressIdText

TMP_Text buttonPressIdText

private

Inspector
UI TMP_Text to label the ID of the button press marker.

buttonPressImage

Image buttonPressImage

private

Inspector
UI Image to visualize the position of the button press marker.

buttonPressMarker

MarkerData buttonPressMarker

Inspector, Code
The tracking data for the button press marker.

buttonReferenceIdText

TMP_Text buttonReferenceIdText

private

Inspector
UI TMP_Text to label the ID of the reference marker.

buttonReferenceMarker

MarkerData buttonReferenceMarker

Inspector, Code
The tracking data for the reference marker.

buttonReferencePointImage

Image buttonReferencePointImage

private

Inspector
UI Image to visualize the position of the reference marker.

buttonValueText

TMP_Text buttonValueText

private

Inspector
UI TMP_Text to label the FAST.MarkerButton.value.

value

string value

Inspector, Code
Identifies the state of the button as either up and pressed down.

---

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

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