Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 123456]

►Naudioserver
Cdata_types
►NFMAR
►NAudio
CAudioVisualizer	A class to visualize audio data by modifying the size of UI bars based on audio samples
►CMicrophoneCapturer	Captures audio data from the microphone, processes it, and stores it in a circular buffer. Also provides methods to retrieve the captured audio data
CCircularBuffer	Circular buffer data structure for storing audio samples
►NComms
►NAir
CAirManager	Handles the replication of air tank values
CClientAirBroadcaster	A component that broadcasts the client's air tank values over the network
►NVitals
CClientVitalsBroadcaster	The ClientVitalsBroadcaster class is responsible for broadcasting vital signs data from the client to the server and other clients. It manages the collection, caching, and transmission of vital signs such as heart rate and EKG data. It also handles airway obstruction actions and notifies when certain thresholds are exceeded
CIVitalsProvider	Interface for providing vital signs data
CVitalsManager	Manages the vital signs broadcasters for clients in the network
CVitalsObserver	Observes and processes vital signs data from the Pulse engine
CVitalsThreshold	Represents a threshold for vital signs. Used for triggering alerts when vitals are outside of the threshold
►NVoice
CClientVoiceBroadcaster	Manages client-side voice broadcasting functionality
CTranscription	Represents a transcription of voice data
CVoiceChannel	Represents a voice channel for communication. Channels are used to selectively communicate with a subset of other clients on the network
CVoiceChannelArray	Represents an array of voice channels for network transmission
CVoiceManager	Manages voice communication channels and client voice broadcasting
►NCore
►CCommonHand	A "common" hand structure which is capable of representing hands in a universal way, for use in any FMAR modules which use hands. XR Providers can inherit from this class to create a conversion scheme which translates other types of hand structures into a common hand
CBone	Contains position/rotation data about an individual bone within the hand
CCommonHandController	FMAR Common Hand Controller representation, inherits from Controller class, adding hand data
CController	FMAR Controller representation Handles position, rotation, pointers, and button presses
CCoreRig	An XR rig which consults the Core device manager to set the position of its own "headset" and "controller" objects
CDebugObject	Object that will only exist in debug builds. For any other build, the object will destroy itself upon awake
CEnableDisableEvents	Invokes UnityEvents when the GameObject is enabled or disabled
CFingerPinchData
CFmarDeviceManager	Core device manager which manages all headsets, trackers, and controllers from all XR Providers
CHand	FMAR basic hand representation, containing position and rotation data
CHeadset	FMAR Headset representation, containing position, rotation, velocity, and angular velocity data
CTargetFramerateSetter	Forces the target framerate to a specific value
CTracker
CXrProvider	Generic class representing an "XR Provider" which is a FMAR concept based on the Unity XR Management system. XRProviders are activated based on the current platform and are a crucial piece to the cross-platform support of FMAR
►NDemos
►NDemoCore
CDemoBase	Inherit from this class to create a demo canvas
►NDraggableAnchors
CDraggableAnchor	Anchor that can be dragged around using controllers/hands when in edit mode
CDraggableAnchorManager	Manages the creation and persistence of draggable anchors
►NEMS
CEMSDemo	Core script used to handle demo logic for the EMS scenario
►NFire
CFireDemo	Core script used to handle demo logic for the fire scenario
►NGestures
CDirectionalPinchGesture	Directional pinch gesture that provides events for pinching and stopping pinching
CGestureBase	Base class for gesture handling, providing common functionality for gesture detection
COpenPalmThrustGesture	Gesture used for detecting a "thrust" in a specific direction, with the palm open
CPinchAndMoveGesture	Complex pinch gesture that provides information about distance moved when pinching and dragging, relative to the head
CThumbsUpGesture	Class for detecting and handling the thumbs up gesture
CToggleFollowGesture
►NImageProcessing
►NImageToText
CClientCameraToText	Utilizes Tesseract to process images sent from the client's camera on the server, and logs the text results to the console
►NObjectDetection
►CPythonYolo	Python Yolo instance, launches python process running yolo, and sends images to it for object detection
CYoloBox
CYoloItem
CTestObjectDetectionImageProcessing	Test script for sending images to a Python server for object detection
►NQRCodeRecognition
CQrCodeReaderTester	Test script for QR code recognition using ZXing (Zebra Crossing)
►NInternal
►NCommonDataTypes
CDate	Custom serializable date struct, easy to set in the unity inspector
►CPersonInfo	Custom serializable person info struct
CHeight	Struct used to represent a person's height in feet and inches
CRecord	A record of an event that occurred at a certain date and time, with an urgency level
►NInspectables
CIInspectable	Interface for objects that can be inspected in the inspector widget
CInspectorRow	A row displayed in the FMAR Inspector, containing some bit of information about the inspected object as well as an optional link to be triggered when the row is clicked
►NNotifications
CClientNotifications
CNotification
CNotificationsManager
►NPatientInfo
CMockPatient	A fake patient object meant to demo the patient info functionality
CPatientInfo	The patient info object. Contains the patient's personal information, medical records, and allergies
►NPointsOfInterest
CBarrierComponent	Barrier object, creates a barrier to be used by the map system
CBreadcrumb	Breadcrumb object, acts as a specialized point of interest that is automatically placed at the user's location over time, to help them find their way back
CPointOfInterest	Point of interest object, is visible within the world and also on the map. This is the object that lives in the world and defines the location of the POI, and provides a physical representation of the POI in world space
CPointOfInterestManager	Manages the creation and destruction of points of interest, as well as the drawing of breadcrumb paths
CPointOfInterestPlacement	Used to place points of interest in the world
►NProcedures
CBranchingPathStep	A branching path step. Can have multiple paths
CLinkStep	A link step. Can link to another procedure
CPath	A path in a branching path step
CProcedure	Procedures are comprised of a series of steps. Each step can be a text step, a link step, or a branching path step. Procedures can be linear, can have branching paths, and can link to other procedures
CProcedureManager	The procedure manager. Handles procedure flow, as well as stopping and starting procedures
CStep	A basic step. Can contain images, videos, and text. Most just contain text
CStepBase	Base class for all steps. Each step is a single item in a procedure
►NTooltips
CIHasTooltip	Interface describing an object that has a tooltip, and it's required properties for rendering
CTooltip	A tooltip object. Used in UI and behaves like your standard tooltip
►NVehicleDriverInfo
CDriverInfo	A driver info object for a driver's license. Contains the person info, license class, and expiration date
CVehicleInfo	A vehicle info object for storing details about a vehicle. Inherits from ScriptableObject
►NWaypoints
CAbstractWaypoint	Non-monobehaviour version of waypoints
►NNavigation
►NPathfinder
CPathfinder	Using Unity's NavMesh system, finds a path to the Waypoint system's current "destination" waypoint and draws a dotted line representing the path the user should take to get to that point
►NNetworking
►NCamera
CClientCameraBroadcaster	Manages the broadcasting of camera data from the client to the server
CClientCameraProcessor	Abstract base class for processing camera data received from clients
CClientCameraRenderer	Renders camera data received from the client onto a canvas
CClientNetworkTransform	A network transform that is only writable by the client
CFmarClient	A client in the FMAR network. Core network object for a user. Required for network functionality
CFmarClientComponent	Abstract class for a component that is attached to a client in the FMAR network
CFmarClientManager	Manages the FmarClient objects in the network, including adding, removing, and accessing them
CFmarNetworkDiscovery	Used to broadcast the server name and port to the network so that other clients can connect to the server. Runs on a different port than other network functionality
CNetworkCommandLine	Handles command line arguments for network settings at launch
CServer	Serializable representation of a named server in the network
CServerList	Serializable representation of a list of servers in the network
CServerManager	Manages the server list and saves it to a file for persistence across sessions
►NUI
►NAirHud
CAirHud	The AirHud is a UI element that displays the air remaining for the user
►NAirLED
CAirLed
►NBuddyHUD
CSubtitle	Subtitle UI element, displays the subtitle text
CSubtitleDisplay	Subtitle display, manages the UI for the subtitle display
►NCanvasInteractions
CCanvasInteractionsCursor	Handles the cursor for the Buddy HUD. The cursor is used to interact with widgets, simulating a mouse cursor
CCanvasInteractionsTooltip	Tooltip object used by the BuddyHud for rendering tooltip text where the virtual mouse pointer is pointing
CEnableCanvasByCameraAngle	Script that enables and disables, as well as adjusts fade on a curve based on the camera angle and other factors
CXrCanvasInteractions
CXrInputModule	Handles simulation of pointer input for the Buddy HUD and its various Canvas-based interfaces
►NCustomComponents
CButton	A custom button used in FMAR interfaces. Normal Unity buttons don't have the notion of depth, so this button allows visual feedback of how much the button has been pressed
►NIndicator
CIndicatorHud	A heads-up display that resides in the user's peripheral vision and points in the direction of waypoints. Currently broken as we have removed the old waypoint system it depended on. The replacement point-of-interest system could be set up to work similarly if desired
CPeripheralIndicator	A single indicator which is associated with a single waypoint somewhere in 3D space
►NIndicators
CIndicator	A single indicator which is associated with a single point of interest somewhere in 3D space
CIndicators	Indicator system which creates spatialized indicator for each Point of Interest
►NMountpoints
CMountPoints	Container class for "mount points", key points at certain places along the Core Rig e.g. the user's wrists, forearms, etc. These points can then be used to "mount" interfaces, for example the FollowHUD or TabbedDisplay, which will then follow that point on the user's body
CSmoothTransform	Convenience class for handling a transform that should smooth damp/lerp towards a specified position and rotation over a specified time period
►NPeripheryFader
CPeripheryFader	Handles fading effects on the periphery based on notification urgency levels
►NProcedureHUD
CProcedureHud	Manages the display of the procedure HUD, including current steps and choices
CProgressHierarchyBar	Represents a single bar in the progress hierarchy, indicating the depth, active state, and completion status
CVideoPlaybackHud	Manages the video playback HUD, showing or hiding it based on the current procedure step
►NRadialMenu
CRadialMenu	Manages the radial menu UI, including its options and interactions
CRadialMenuOption	Represents an option/choice that can be selected via the radial menu
CRadialMenuOptionsSet	Represents a set of options/choices for the radial menu
►NWidgets
►NCarDriverSearch
CCarDriverSearch	Manages the car and driver search functionality, including UI updates and data handling
CDriverInfoWindow	Displays driver information in the UI
CRecordInfoWindow	Displays driver records in the UI
CVehicleInfoWindow	Displays vehicle information in the UI
►NConsole
CConsole	The Console widget, displays logs within the headset. Useful for debugging, as it isn't otherwise possible to see Unity's console output within a headset
►NCPRTrainer
CCprTrainer	The CPR Trainer widget, allows the user to simulate CPR compression and provides feedback on the quality of the compression
►NEMS
►NPatientInfo
CAllergiesWindow	A window that displays a list of allergies for a patient
CBasicInfoWindow	A window that displays basic information about a patient
CMedicalRecordsWindow	A window that displays a list of medical records for a patient
CPatientInfo	A widget that displays information about a patient
CRecordTemplate	A template for a medical record in the medical records window
►NTraumaTreatment
CHospital	Displays information about a hospital
CTraumaTreatment	Trauma Treatment widget, displays information about injuries, treatment options, and hospitals
►NInspector
CInspector	The Inspector widget, used to display information about generic IInspectable objects
►NKeyboard
CKey	Represents a key on the virtual keyboard
CKeyboard	Virtual keyboard widget, displays a floating keyboard widget that can be used to type into input fields
CSpecialKey	Represents a special key on the virtual keyboard, such as Backspace, Tab, CapsLock, Enter, Shift, or Space
CUpDownButton	A custom button that triggers actions on pointer down and pointer up events
►NMap
CBreadcrumbIcon	Represents a breadcrumb icon on the map
CMap	Map widget, which displays points of interest, barriers, breadcrumbs, etc and allows interactions such as zooming and panning
CPoiIcon	Represents a point of interest icon on the map
►NNotifications
CNotification	UI Element representing a notification, displayed in the notifications widget
CNotifications	Notifications widget, displays notifications from various sources and allows the user to interact with them
►NPointsOfInterest
CPoiInspector	Root inspector for points of interest. Handles switching between view and edit modes
CPoiInspectorEdit	Edit view for points of interest
CPoiInspectorView	View mode for points of interest
CPoiList	Manages the list of points of interest in the points of interest widget
CPointsOfInterest	Points of interest widget, manages the UI for the points of interest, including viewing and editing points of interest
►NProcedures
CHierarchy
CHierarchyItem
CHierarchySublist
CProcedures
►NServerBrowser
CServerBrowser	The server browser widget. Allows the user to connect to and disconnect from servers
CServerButton	A button that can be pressed to connect to a server
►NVitalsMonitor
CMultiPulseVitals	Renders and updates a group of MultiPulseVitalsListing objects using a provided IVitalsProvider
CMultiPulseVitalsMonitor	Vitals monitor widget, manages the UI for the vitals monitor, displaying vitals listings for the targeted pulse instance
CVitalsListing	Base class for a vitals listing, manages the UI for a single vital
CVitalsListingLine	Vitals listing for a single vital, displays a line renderer to represent the vital
CVitalsListingText	Vitals listing for a single vital, displays a text component to represent the vital
CVitalsMonitor	Vitals monitor widget, manages the UI for the vitals monitor, displaying vitals listings for the targeted pulse instance
CDockElement
CFloatingDisplay	A widget container that stays where it was last positioned
CGridSlot	A container that widgets can be placed into, in a grid format
CHotbarButton	A button in the hotbar that performs a specific action when clicked, has fixed functions for saving and recalling widgets, and toggling the HUD buddy
CTab	An individual tab in a tabbed display
CTabbedDisplay	A widget container that has a tab control to switch between widgets
CTabbedDisplaySlot	A slot in a tabbed display
CWidget	Base widget class for FMAR UI widgets. Meant to be inherited from to add any additional desired functionality
CWidgetBackgroundElement	A background element for a widget. Used to allow custom colors and transparency for the widget
CWidgetContainer	An object that can hold a widget. Allows the ability to move widgets around between various containers, and to lock the widget to prevent moving
►CWidgetManager	The WidgetManager is responsible for spawning and managing the "grid" of widgets, which is not currently in use in favor of the tabbed display system
CBuddyHudWidgetPrefab	A prefab for a widget. Allows widgets to be assigned to a default slot
CBuddyHudWidgetUserConfigFile	Represents a user's configuration for the widget system, saves the widget layout so the user doesn't have to set it every time
CBuddyHudWidgetUserConfigItem	Describes the slot a widget is in, in a serializable format
CWidgetInContainer	Represents a spawned widget in a container
►NXRProviders
►NMagicLeap
CMagicLeapXrProvider	Implementation of XRProvider for Magic Leap
►NMock
CMockHeadset	A mock headset which can be controlled using the mouse and WASD keys on the keyboard. Useful for debugging and rapid iteration
CMockXrProvider	The mock provider only works on Windows and is meant for debugging
►NOculus
CEdgeDetectionManager	Manages the edge detection for the Oculus XR provider. Allows toggling of edge detection on the passthrough layer
COculusCommonHand	Common hand implementation for the Oculus XR provider. Maps the OVRHand to the CommonHand class
COculusXrProvider
COVRHandManager	This component should be placed in the OVR Rig in such a way that it parents any OVR Hands in the rig. Manages OVR hands and adds them as common hands in the FMAR Core device manager
►NUnityXR
CUnityXrCommonHand	Class which converts a UnityXR hand into an FMAR Core common hand
►CUnityXrDeviceManager	Keeps track of UnityXR's device list and adds compatible devices to FMAR Core's device manager if appropriate
CDevice	A device in the Unity XR provider. Can represent a headset, controller, hand, or some other device
CUnityXrXrProvider	The UnityXR provider is generally safe to use in most circumstances. Many devices are passed through this layer by default, and in certain cases additional providers may not be necessary
►Nsimpleserver
Cdata_types
►NWhisper
►NNative
►CWhisperNativeParams	This is direct copy of C++ struct. Do not change or add any fields without changing it in whisper.cpp. Do not change it in runtime directly, use WhisperParams
Cbeam_search_struct
Cgreedy_struct
CWhisperNativeTokenData	This is direct copy of C++ struct. Do not change or add any fields without changing it in whisper.cpp. Check WhisperTokenData for more information
►NTests
CAudioUtilsTests
CWhisperInitTests
CWhisperLanguageTests
CWhisperParamsTests
CWhisperPromptTests
CWhisperRunTests
►NUtils
CAudioChunk	Small portion of recorded audio
CMainThreadDispatcher	Helper class to dispatch events from main thread. Useful to pass events from other threads to Unity main thread
CMicrophoneRecord	Controls microphone input settings and recording
CRotatingCube	Simple rotation script to check if Unity didn't hanged
CWhisperManager	Manages Whisper model lifecycle in Unity scene
CWhisperParams	Wrapper of native C++ whisper parameters. Use it to safely change inference parameters
CWhisperResult
CWhisperSegment	Single segment of whisper audio transcription. Can be a few words, a sentence, or even a paragraph
CWhisperStream	Handling all streaming logic (sliding-window, VAD, etc)
CWhisperStreamParams	Parameters of whisper streaming processing
CWhisperTokenData	Usually represent a word, part of the word, punctuation marks or some special tokens like [EOT], [BEG], etc
CWhisperTokenTimestamp	Optional token timestamp information
CWhisperWrapper	Wrapper for loaded whisper model
CAnchorDebugObjectCreator	Creates and manages debug objects for anchors
CAnchorDebugPlacement	Handles the placement and removal of debug anchors using controller input
CAnchorFollower	Follows the position and rotation of a specified anchor
CAnchorProvider	Abstract base class for any system which allows the creation and management of anchors in the environment. This is required as different platforms have different ways of handling anchors. It allows us to abstract away the differences and provide a unified interface for the rest of the system
CArrowAnimation
CAudioSourceClientVoiceProcessor	Processes client voice data and manages audio playback using an AudioSource
CBarrier	Represents a barrier in the world. Barriers are three-dimensional rectangular prisms. A common example of a barrier is a wall
CBillboardToHeadset	Makes an object smoothly face the VR headset with configurable lerping
CBob	Simple script used to bob an object up and down at a fixed interval
CBuildConfig	A scriptable object representing a single configuration for a build, can be used to create multiple sub-projects within a project
CButtonSlider	A custom slider that is controlled by buttons instead of dragging the handle
CCameraCapturer	Abstract base class for any system which allows the capturing of camera data. This is required as different platforms have different ways of handling camera data. It allows us to abstract away the differences and provide a unified interface for the rest of the system
CCameraRendererWidget	A widget that captures and displays the RGB camera feed asynchronously. Used for debugging the camera feed
CClientVoiceProcessor	Abstract base class for processing client voice data from a broadcaster
CCompound
CCustomUiComponentManager	Manages the interaction mode and touch screen distance for the custom UI components
CDoubleList
CEdgeDetectionToggle
CExternalHemorrhageCmpt
CFireControlsWidget	Fire Controls widget, allows the user to toggle fire effects, adjust the darkness of the scene, and adjust the fire and smoke amounts
CFMARAnchor	Abstract base class representing an anchor in the environment. Provides properties for the anchor's ID, position, and rotation
CFMARPulseEngineDriver	Custom PulseEngineDriver utilizing an Enum for various data, instead of integers. Pulse's default is unwieldy
CFollowHud
CHighlightableObject	Highlightable object, allows the object to be highlighted and have a pulse effect
CHudBuddy	A "follower" behavior for a widget. Designed to act as a Hud while generally staying out of the way, except when needed, and naturally moving around the environment
CHudCanvas	Manages the HUD canvas and its position relative to the user
CInternalHemorrhageCmpt
CLinkListener	Listens for a link to be triggered and invokes an event when it is
CMagicLeapCameraClippingPlaneFixer	Magic Leap camera clipping plane fixer, fixes the clipping planes of the camera to a fixed value. Required since the Magic Leap usually clamps the clipping plane values, and doesn't allow adjustments outside of those ranges
CMagicLeapHandManager	Enables hand tracking on the Leap platform
CMagicLeapMeshVisualizer	Allows display of the mesh of the world provided by the Magic Leap Meshing Subsystem
CMarkerTrackingTest	Test script to utilize Magic Leap's built-in marker tracking to detect and track markers. Note that other camera access is unavailable while this is in use, and this only works for magic leap, so we are not using this
CMeshFireStarter	Manages the fire effect on a mesh, including turning on the mesh when the mesh has been set
CMLAnchorProvider	Anchor Provider for Magic Leap 2, allows for the creation and management of anchors
CMLCVCameraCapturer	Captures camera data from the Magic Leap CV (Computer Vision) camera, and feeds it through the CameraCapturer pipeline
CMLFMARAnchor	Magic Leap anchor, managed by MLAnchorProvider
CMockAnchorProvider	Mock Anchor Provider, for use in the editor
CMockCameraCapturer	Mock implementation of a camera capturer for testing purposes. Uses a predefined image to simulate the camera capturer
CMockDriverLicense	Represents a mock driver license component. Meant for testing purposes
CMockLicensePlate	Represents a mock license plate component. Meant for testing purposes
CMultiPulseVitalsListing	Renders one or more vitals using a line renderer and text displays
CNetVitalsProvider	Provides vitals over the network, server authoritative
COcclusionShaderObject	Custom shader object for meta that allows you to hide objects occluded by the real world
COpenPulseDataConsumer
COpusEncodingDecodingTests	Unit tests for verifying that opus audio streams are correctly encoding and decoding
COVRAnchorProvider	Anchor provider for Oculus XR, allows for the creation and management of anchors. Uses player preferences for storage of anchor references, this is how Meta officially recommends storing anchors via their documentation
COVRFMARAnchor	Anchor Provider for Oculus/Meta headsets
CPassthroughAnimator	Animates the passthrough layer to fade in and out over time
CPingClient	Ping/Pong methods to test if a server is reachable
CPingServer	Listens for pings from clients and sends pongs
CPingServerInfo	Data sent to the client when a ping is sent
CPlaceMarker	Places markers on the ground based on voice input. Not in use due to unpredictable text output from Whisper, but could be expanded to allow voice commands
CProcedureEditor
CPulseActionOnClick
CPulseActionOnClickEditor
CPulseCSVReader
CPulseData
CPulseDataConsumer
CPulseDataConsumerEditor
CPulseDataLineRenderer
CPulseDataNumberRenderer
CPulseDataSource
CPulseEngineController
CPulseEngineControllerEditor
CPulseEngineDriver
CPulseEngineDriverEditor
CPulseEngineScenarioDriver
CPulseEngineScenarioDriverEditor
CPulseRandomValueGenerator
CPythonAudioTranscriber	Python audio transcriber, manages the audio transcription process, sending audio data to the Python server, and displaying the transcribed text
CPythonTransport	Transport for sending and receiving messages to and from a Python server
CSerializableQuaternion	Unity's Quaternion doesn't allow serialization, this struct fixes that for anchors
CSerializableVector3	Unity's Vector3 doesn't allow serialization, this struct fixes that for anchors
CSmokeFader	Creates depth planes to simulate smoke on quest
CSpatialMappingPermissionRequester	Requests the Spatial_Mapping permission and enables/disables the MeshingSubsystemComponent depending on the user's preference
CSpin	Simple script used to spin an object around an axis
CStatsWidget	FMAR widget that displays debug-stats, such as FPS
CStringFunnel	Manages string mappings and provides functionality to convert invalid strings to valid ones
CStringList
CStringMapping	Represents a mapping between valid and invalid strings
CSubstance
CTimerEnabler	Enables a MonoBehaviour after a delay. Can be used to work around timing issues
CTrackableHeadsetOffset
CTranscriptLog	Manages a log of transcript lines for display
CVirtualDriversLicense	Displays a "fake" drivers license in world-space. Meant to mock drivers licenses for demo purposes
CVirtualLicensePlate	Displays a "fake" license plate in world-space. Meant to mock license plates for demo purposes
CVoiceComms	Voice Communications widget, Displays data for voice channel management, and voice transcriptions, and allows the user to join and leave voice channels
CWhisperServerSide