Events - WEKIT-ECS/MIRAGE-XR GitHub Wiki

These are the key events used in MirageXR for the editor, ordered by when they appear.

Recorder Events	Description	Comment
`NewActivityCreationButtonPressed()`	User pressed the '+' button for adding a new activity
`OnEditorLoaded()`	Loading of the editor has finished
`TaskStationEditorEnabled()`		USED??
`OnActionCreated(Action action)`	Finished creating the new action step
`OnActionModified(Action action)`	The action step was modified
`OnActionDeleted()`	Finished deleting the action step
`MobileStepContentExpanded()`	The button 'edit' step was pressed, now showing the list of augmentations	PLEASE CONFIRM!!
`MobileAddStepContentPressed()`	The '+' button for adding a new augmentation has been pressed
`AddAugmentationButtonClicked()`	User selected an augmentation to add
`AugmentationPoiChanged()`	User finished moving the location of an augmentation
`OnAugmentationLocked()`	The augmentation is now locked, preventing it to be moved
`OnAugmentationDeleted()`	The augmentation was deleted
`ActivityRenamed()`	Activity was renamed
`ActionStepTitleChanged()`	Step title was changed
`ActionStepDescriptionInputChanged()`	Step description was changed
`ActivitySaveButtonClicked()`	User published the activity to local (explicitly pressing the 'publish' button)
`OnActivitySaved()`	Activity saving concluded sucessfully
`ActivityUploadButtonClicked()`	User pressed publish to cloud button
`OnEditModeChanged(bool editModeActive)`	User switched between edit mode and view mode
`OnEditorUnloaded()`	Editor successfully unloaded	Is this ever called? Just before player loads?

These are the key events used in MirageXR for the viewer, ordered by when they appear.

Player Events	Description	Comment
`ViewSelectorClicked()`		Is this 'open activity to /view/'?
`OnWorkplaceLoaded()`	Loading of the workplace data model successfully concluded
`OnActivityLoadedStamp()`	Loading of activity data model successfully concluded
`OnStartActivity()`	about to start the activity
`OnActivityStarted()`	Activity was started
`OnWorkplaceCalibrated()`	Calibration succcessfully concluded
`OnActivateAction()`	Starting the action step
`OnStepActivatedStamp(string deviceId, Action activatedAction, string timestamp)`	Action step was successfully started
`OnToggleObject(string action, bool isActivating=true)`	Displaying the augmentation
`OnCompletedMeasurement(string measureValue, string measuringTool)`	Functionality of the measure action glyph: User completed a measurement
`OnTap()`	Trigger?
`OnClick()`	Trigger?
`OnNext(string trigger)`	User pressed 'next'
`StepsSelectorClicked`	User selected a specific step
`OnStepDeactivatedStamp(string deviceId, Action deactivatedAction, string timestamp)`	Step concluded
`OnMarkCompleted(string id)`	Step marked as completed
`OnDeactivateAction(string action, bool doNotActivateNextStep = false)`	Deactivating step
`OnToggleObject(string action, bool isActivating=false)`	Step successfully deactivated
`OnDestroyDetectables()`	Releasing anchors and image targets from memory	When is this called?
`OnActivityCompletedStamp()`	Activity successfully completed