FirstModulAR 0.1.0
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
FMAR.UI.Indicator.PeripheralIndicator Class Reference

A single indicator which is associated with a single waypoint somewhere in 3D space. More...

Inheritance diagram for FMAR.UI.Indicator.PeripheralIndicator:

Public Member Functions

PeripheralIndicator Init (AbstractWaypoint waypoint, float pingInterval)
 Initializes the indicator.
 
void Disable ()
 Disables the indicator, hiding its images and text.
 
void SetPeriphery (float direction, float magnitude, float magnitudeThreshold)
 Sets the position and size of the indicator based on the direction and magnitude of the waypoint.
 
void SetDirectView (Vector3 worldPosition, float magnitude)
 Sets the position and size of the indicator based on the world position and magnitude.
 

Public Attributes

AbstractWaypoint waypoint
 
float flashAnimOpacity
 

Detailed Description

A single indicator which is associated with a single waypoint somewhere in 3D space.

Member Function Documentation

◆ Disable()

void FMAR.UI.Indicator.PeripheralIndicator.Disable ( )
inline

Disables the indicator, hiding its images and text.

◆ Init()

PeripheralIndicator FMAR.UI.Indicator.PeripheralIndicator.Init ( AbstractWaypoint waypoint,
float pingInterval )
inline

Initializes the indicator.

Parameters
waypointThe waypoint associated with the indicator.
pingIntervalThe interval at which to ping the indicator.
Returns
The initialized indicator.

◆ SetDirectView()

void FMAR.UI.Indicator.PeripheralIndicator.SetDirectView ( Vector3 worldPosition,
float magnitude )
inline

Sets the position and size of the indicator based on the world position and magnitude.

Parameters
worldPositionThe world position of the indicator.
magnitudeThe magnitude of the waypoint.

◆ SetPeriphery()

void FMAR.UI.Indicator.PeripheralIndicator.SetPeriphery ( float direction,
float magnitude,
float magnitudeThreshold )
inline

Sets the position and size of the indicator based on the direction and magnitude of the waypoint.

Parameters
directionThe direction to point the indicator in.
magnitudeThe magnitude of the waypoint.
magnitudeThresholdThe threshold at which to start fading the indicator.

Member Data Documentation

◆ flashAnimOpacity

float FMAR.UI.Indicator.PeripheralIndicator.flashAnimOpacity

◆ waypoint

AbstractWaypoint FMAR.UI.Indicator.PeripheralIndicator.waypoint
The documentation for this class was generated from the following file: