FMAR.UI.Widgets.VitalsMonitor.MultiPulseVitalsMonitor Class Reference

Vitals monitor widget, manages the UI for the vitals monitor, displaying vitals listings for the targeted pulse instance. More...

Inheritance diagram for FMAR.UI.Widgets.VitalsMonitor.MultiPulseVitalsMonitor:

Public Member Functions
void	SetPulseInstance (FMARPulseEngineDriver pulse)
	Sets the pulse instance to monitor.
void	ClearPulseInstance ()
	Clears the current pulse instance, stopping it from being monitored.
bool	TryGetVital (DataType vital, out List<(double time, double value)> list)
	Tries to get the vital data for the given vital type.
Public Member Functions inherited from FMAR.UI.Widgets.Widget
virtual void	SetWidgetContainer (WidgetContainer widgetContainer)
	Called when the widget is moved into a new container. Handles widget resizing and repositioning. Can be overridden to provide additional functionality.
void	SetBorderPositions (Vector2 size)
	Sets the border positions.
void	UpdateBorderTransparency ()
	Updates the border transparency based on the widget container's border transparency.
void	DetachFromContainer ()
	Detaches the widget from the widget container.
void	PlaySound (AudioClip clip)
	Plays a sound localized to the widget.
bool	TryMove ()
	Tries to move the widget out of the widget container.
void	SetBackgroundEnabled (bool enabled)
	Sets the background's enabled state.
Public Member Functions inherited from FMAR.Comms.Vitals.IVitalsProvider

Protected Member Functions
override void	Awake ()
	Called when the widget is awakened, initializes the vitals and listings.
override void	Update ()
Protected Member Functions inherited from FMAR.UI.Widgets.Widget
virtual void	Start ()
void	CreateBorder (Vector2 size)
	Creates a border for the widget, around the edges.

Properties
IReadOnlyCollection< DataType >	VitalsProvided [get]
	The vitals provided by the vitals monitor.
IReadOnlyDictionary< VitalsThreshold, float >	VitalsThresholdAlertTimers [get]
	The timers used to alert when a vital is above or below a threshold.
Properties inherited from FMAR.UI.Widgets.Widget
WidgetContainer	WidgetContainer [get]
Vector2	PreferredFloatingDisplaySize [get]
Color	BackgroundBaseColor [get]
RectTransform	Rt [get]
bool	Locked [get]
Properties inherited from FMAR.Comms.Vitals.IVitalsProvider

Additional Inherited Members
Public Attributes inherited from FMAR.UI.Widgets.Widget
Sprite	widgetIcon
Protected Attributes inherited from FMAR.UI.Widgets.Widget
Image	bg
RectTransform	rt
AudioSource	aud

Detailed Description

Vitals monitor widget, manages the UI for the vitals monitor, displaying vitals listings for the targeted pulse instance.

Member Function Documentation

Awake()

override void FMAR.UI.Widgets.VitalsMonitor.MultiPulseVitalsMonitor.Awake ( )

inlineprotectedvirtual

Called when the widget is awakened, initializes the vitals and listings.

Reimplemented from FMAR.UI.Widgets.Widget.

ClearPulseInstance()

void FMAR.UI.Widgets.VitalsMonitor.MultiPulseVitalsMonitor.ClearPulseInstance ( )

inline

Clears the current pulse instance, stopping it from being monitored.

SetPulseInstance()

void FMAR.UI.Widgets.VitalsMonitor.MultiPulseVitalsMonitor.SetPulseInstance ( FMARPulseEngineDriver pulse )

inline

Sets the pulse instance to monitor.

Parameters

pulse

The pulse instance to monitor.

TryGetVital()

bool FMAR.UI.Widgets.VitalsMonitor.MultiPulseVitalsMonitor.TryGetVital ( DataType vital, out List<(double time, double value)> list )

inline

Tries to get the vital data for the given vital type.

Parameters

vital	The vital type to get the data for.
list	The list of vital data for the given vital type.

Returns

Whether the vital data was found.

Implements FMAR.Comms.Vitals.IVitalsProvider.

Update()

override void FMAR.UI.Widgets.VitalsMonitor.MultiPulseVitalsMonitor.Update ( )

inlineprotectedvirtual

Reimplemented from FMAR.UI.Widgets.Widget.

Property Documentation

VitalsProvided

IReadOnlyCollection<DataType> FMAR.UI.Widgets.VitalsMonitor.MultiPulseVitalsMonitor.VitalsProvided

get

The vitals provided by the vitals monitor.

Implements FMAR.Comms.Vitals.IVitalsProvider.

VitalsThresholdAlertTimers

IReadOnlyDictionary<VitalsThreshold, float> FMAR.UI.Widgets.VitalsMonitor.MultiPulseVitalsMonitor.VitalsThresholdAlertTimers

get

The timers used to alert when a vital is above or below a threshold.

Implements FMAR.Comms.Vitals.IVitalsProvider.

---

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

• /github/workspace/Packages/FMAR/UI/WidgetVitalsMonitor/Runtime/Scripts/MultiPulseVitalsMonitor.cs