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

A predefined tool for a slider. More...

Inheritance diagram for MarkerSlider:
MarkerTool

Public Attributes

MarkerData endMarker
 Inspector, Code
The tracking data for the slider end reference marker.
 
MarkerData knobMarker
 Inspector, Code
The tracking data for the knob marker.
 
float sliderLength
 Inspector, Code
The X-coordinate distance from the reference marker to the knob marker when at the beginning of the slider.
 
MarkerData startMarker
 Inspector, Code
The tracking data for the slider start reference marker.
 
float value
 Inspector, Code
Identifies the slider position as normalized value in the range [0, 1].
 
- 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 endIdText
 Inspector
UI TMP_Text to label the ID of the slider end reference marker.
 
Image endPointImage
 Inspector
UI Image to visualize the position of the slider end reference marker.
 
TMP_Text knobIdText
 Inspector
UI TMP_Text to label the ID of the knob marker.
 
Image knobPointImage
 Inspector
UI Image to visualize the position of the knob marker.
 
Image slideAreaImage
 Inspector
UI Image to visualize the track the knob slides along.
 
TMP_Text startIdText
 Inspector
UI TMP_Text to label the ID of the slider start reference marker.
 
Image startPointImage
 Inspector
UI Image to visualize the position of the slider start reference marker.
 
TMP_Text valueText
 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 slider.

This is a physical slider with a knob that moves along a track. One marker is placed at the beginning of the slider track and another marker is placed at the end of the slider track. Both markers must be visible at some point to determine the slider track length, but after that only one of these reference markers needs to be visible while the slider is in use. A third marker is placed on the knob that slides on the track and must also always be visible.

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

See also
UnityEngine.UI.Image
TMPro.TMP_Text

Member Data Documentation

◆ endIdText

TMP_Text endIdText
private

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

◆ endMarker

MarkerData endMarker

Inspector, Code
The tracking data for the slider end reference marker.

◆ endPointImage

Image endPointImage
private

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

◆ knobIdText

TMP_Text knobIdText
private

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

◆ knobMarker

MarkerData knobMarker

Inspector, Code
The tracking data for the knob marker.

◆ knobPointImage

Image knobPointImage
private

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

◆ slideAreaImage

Image slideAreaImage
private

Inspector
UI Image to visualize the track the knob slides along.

◆ sliderLength

float sliderLength

Inspector, Code
The X-coordinate distance from the reference marker to the knob marker when at the beginning of the slider.

◆ startIdText

TMP_Text startIdText
private

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

◆ startMarker

MarkerData startMarker

Inspector, Code
The tracking data for the slider start reference marker.

◆ startPointImage

Image startPointImage
private

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

◆ value

float value

Inspector, Code
Identifies the slider position as normalized value in the range [0, 1].

◆ valueText

TMP_Text valueText
private

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


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