Antura  1.1.0
Antura.Tutorial.TutorialUI Class Reference

Tutorial framework More...

Inheritance diagram for Antura.Tutorial.TutorialUI:

Public Types

enum  DrawLineMode { DrawLineMode.LineOnly, DrawLineMode.Finger, DrawLineMode.Arrow, DrawLineMode.FingerAndArrow }
 
enum  MarkSize { MarkSize.Normal, MarkSize.Big, MarkSize.Huge }
 

Static Public Member Functions

static void Clear (bool _destroy)
 Removes and tutorial element on screen More...
 
static void SetCamera (Camera _camera)
 
static void Click (Vector3 _position)
 Shows a finger click at the given world position More...
 
static void ClickRepeat (Vector3 _position, float _duration=2, float _clicksPerSecond=5)
 Shows a repeated finger click at the given world position More...
 
static TutorialUIAnimation DrawLine (Vector3 _from, Vector3 _to, DrawLineMode _mode, bool _persistent=false, bool _overlayed=true)
 Draws a straight line with the given options. More...
 
static TutorialUIAnimation DrawLine (Vector3[] _path, DrawLineMode _mode, bool _persistent=false, bool _overlayed=true)
 Draws a curved line with the given options. More...
 
static void MarkYes (Vector3 _position, MarkSize _size=MarkSize.Normal)
 Shows a YES/RIGHT mark at the given world position More...
 
static void MarkNo (Vector3 _position, MarkSize _size=MarkSize.Normal)
 Shows a NO/WRONG mark at the given world position More...
 
static float GetCameraBasedScaleMultiplier (Vector3 _position)
 

Public Attributes

float DrawSpeed = 2
 
TutorialUIFinger Finger
 
TutorialUIPools Pools
 

Detailed Description

Tutorial framework

Member Enumeration Documentation

◆ DrawLineMode

Enumerator
LineOnly 
Finger 
Arrow 
FingerAndArrow 

◆ MarkSize

Enumerator
Normal 
Big 
Huge 

Member Function Documentation

◆ Clear()

static void Antura.Tutorial.TutorialUI.Clear ( bool  _destroy)
static

Removes and tutorial element on screen

Parameters
_destroyIf TRUE, also destroys the TutorialUI gameObject

◆ Click()

static void Antura.Tutorial.TutorialUI.Click ( Vector3  _position)
static

Shows a finger click at the given world position

Parameters
_positionWorld position

◆ ClickRepeat()

static void Antura.Tutorial.TutorialUI.ClickRepeat ( Vector3  _position,
float  _duration = 2,
float  _clicksPerSecond = 5 
)
static

Shows a repeated finger click at the given world position

Parameters
_positionWorld position
_durationDuration of the repeat
_clicksPerSecondClick per second

◆ DrawLine() [1/2]

static TutorialUIAnimation Antura.Tutorial.TutorialUI.DrawLine ( Vector3  _from,
Vector3  _to,
DrawLineMode  _mode,
bool  _persistent = false,
bool  _overlayed = true 
)
static

Draws a straight line with the given options.

NOTE: you can chain an OnComplete method call to get a callback when the line has finished drawing

Parameters
_fromStarting world position
_toEnding world position
_modeDraw mode (line only, finger, arrow, arrow + finger)
_persistentIf TRUE, the line will stay on screen until you Clear the TutorialUI, otherwise it will disappear automatically
_overlayedIf TRUE the line will always appear above other world elements, otherwise it will behave as a regular world object

◆ DrawLine() [2/2]

static TutorialUIAnimation Antura.Tutorial.TutorialUI.DrawLine ( Vector3 []  _path,
DrawLineMode  _mode,
bool  _persistent = false,
bool  _overlayed = true 
)
static

Draws a curved line with the given options.

NOTE: you can chain an OnComplete method call to get a callback when the line has finished drawing

Parameters
_pathA series of waypoints (world positions) between which the line will pass. IMPORTANT: the line drawn between the waypoints will use a CatmullRom curve, so you don't need too many waypoint to actually draw a curve
_modeDraw mode (line only, finger, arrow, arrow + finger)
_persistentIf TRUE, the line will stay on screen until you Clear the TutorialUI, otherwise it will disappear automatically
_overlayedIf TRUE the line will always appear above other world elements, otherwise it will behave as a regular world object

◆ GetCameraBasedScaleMultiplier()

static float Antura.Tutorial.TutorialUI.GetCameraBasedScaleMultiplier ( Vector3  _position)
static

◆ MarkNo()

static void Antura.Tutorial.TutorialUI.MarkNo ( Vector3  _position,
MarkSize  _size = MarkSize.Normal 
)
static

Shows a NO/WRONG mark at the given world position

Parameters
_positionWorld position
_sizeSize of the mark

◆ MarkYes()

static void Antura.Tutorial.TutorialUI.MarkYes ( Vector3  _position,
MarkSize  _size = MarkSize.Normal 
)
static

Shows a YES/RIGHT mark at the given world position

Parameters
_positionWorld position
_sizeSize of the mark

◆ SetCamera()

static void Antura.Tutorial.TutorialUI.SetCamera ( Camera  _camera)
static

Member Data Documentation

◆ DrawSpeed

float Antura.Tutorial.TutorialUI.DrawSpeed = 2

◆ Finger

TutorialUIFinger Antura.Tutorial.TutorialUI.Finger

◆ Pools

TutorialUIPools Antura.Tutorial.TutorialUI.Pools

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