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

A predefined tool for a 6-sided dice. More...

Inheritance diagram for MarkerDice:
MarkerTool

Public Attributes

MarkerData[] diceMarkers = new MarkerData[6]
 Inspector, Code
The tracking data for the markers used by this dice.
 
string value
 Inspector, Code
Identifies the side of the dice 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

TMP_Text[] diceIdTexts = new TMP_Text[6]
 Inspector
UI TMP_Text to label the IDs of the markers used by this dice.
 
Image[] dicePointImages = new Image[6]
 Inspector
UI Images to visualize the position of markers used by this dice.
 
string[] diceValues = new string[6]
 Inspector
The identifier to use for each side of the dice when that side is being tracked.
 
TMP_Text diceValueText
 Inspector
UI TMP_Text to label the FAST.MarkerDice.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 6-sided dice.

The dice is a physical cube with a marker on each side. You could make a dice with a different number of sides, but it must be designed so that only one marker is visible to the camera and tracked at a time.

Use the Marker Dice Prefab to instantiate this tool with default attributes and assignments for 6 markers.

See also
UnityEngine.UI.Image
TMPro.TMP_Text

Member Data Documentation

◆ diceIdTexts

TMP_Text [] diceIdTexts = new TMP_Text[6]
private

Inspector
UI TMP_Text to label the IDs of the markers used by this dice.

◆ diceMarkers

MarkerData [] diceMarkers = new MarkerData[6]

Inspector, Code
The tracking data for the markers used by this dice.

◆ dicePointImages

Image [] dicePointImages = new Image[6]
private

Inspector
UI Images to visualize the position of markers used by this dice.

◆ diceValues

string [] diceValues = new string[6]
private

Inspector
The identifier to use for each side of the dice when that side is being tracked.

◆ diceValueText

TMP_Text diceValueText
private

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

◆ value

string value

Inspector, Code
Identifies the side of the dice that is currently being tracked.


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