MarkerDial Class Reference

A predefined tool for a dial control. More...

Inheritance diagram for MarkerDial:

Public Attributes
float	angle = 0
	The dial rotation amount in the range of [0, 360] degrees.
MarkerData	dialReferenceMarker
	Inspector, Code The tracking data for the reference marker.
MarkerData	dialRotationMarker
	Inspector, Code The tracking data for the rotating knob marker.
string	value
	Inspector, Code The dial rotation amount as a string.
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	dialReferenceIdText
	Inspector UI TMP_Text to label the ID of the reference marker.
Image	dialReferencePointImage
	Inspector UI Image to visualize the position of the reference marker.
TMP_Text	dialRotationIdText
	Inspector UI TMP_Text to label the ID of the rotating knob marker.
Image	dialRotationPointImage
	Inspector UI Image to visualize the position of the rotating marker.
TMP_Text	dialValueText
	Inspector UI TMP_Text to label the FAST.MarkerSlider.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 dial control.

This is a physical dial with a knob that rotates 360 degrees. One marker is placed on the dial housing as reference for the knob rotation. A second marker is placed on a gear connected to the knob and rotates as the knob rotates. The angle of rotation is measured in degrees as the difference between the orientation of the two markers. Both markers must always be visible.

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

See also

UnityEngine.UI.Image

TMPro.TMP_Text

Member Data Documentation

angle

float angle = 0

The dial rotation amount in the range of [0, 360] degrees.

dialReferenceIdText

TMP_Text dialReferenceIdText

private

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

dialReferenceMarker

MarkerData dialReferenceMarker

Inspector, Code
The tracking data for the reference marker.

dialReferencePointImage

Image dialReferencePointImage

private

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

dialRotationIdText

TMP_Text dialRotationIdText

private

Inspector
UI TMP_Text to label the ID of the rotating knob marker.

dialRotationMarker

MarkerData dialRotationMarker

Inspector, Code
The tracking data for the rotating knob marker.

dialRotationPointImage

Image dialRotationPointImage

private

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

dialValueText

TMP_Text dialValueText

private

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

value

string value

Inspector, Code
The dial rotation amount as a string.

---

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

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