EDIA Core 0.6.0
A Unity XR toolbox for research
Loading...
Searching...
No Matches
Edia.XRManager Class Reference

Manages XR-related functionality within the framework, providing tools and settings for interaction, tracking, and visualization in an XR environment. More...

Public Member Functions

async void SetInitialInteractionStateAsync ()
 XR Input Modality Manager seems to enable all interaction by default when hand or controller detected.
void MoveXRRigToOverlayLayer (string layerName)
 Moves the XR Rig's controllers and hands to the specified overlay layer by changing their layer assignments.
void MovePlayarea (Transform newTransform)
 The pivot of the player will be set on the location of this Injector.
void EnableTeleportation (bool onOff)
 [Not yet implemented] Enables or disables teleportation functionality in the XR environment.
void EnableClimbing (bool onOff)
 [Not yet implemented] Enables or disables climbing functionality within the XR environment.
void EnableMoving (bool onOff)
 [Not yet implemented] Enables or disables the movement functionality for the XR rig.
void EnableTurning (bool onOff)
 [Not yet implemented] Toggles the ability to rotate or turn within the XR environment.
void TurnOnRayInteractor ()
 Activates the ray interactor to enable interaction with distant objects in the XR environment by utilizing ray interaction functionality.
void TurnOnPokeInteractor ()
 Activates the Poke Interactor feature in the XR environment, enabling interactions through poke-based gestures or tools.
void ShowHands ()
 Activates the visibility of the hand meshes in the XR environment.
void HideHands ()
 Hides the hand meshes in the XR environment, disabling their visibility.
void ShowControllers ()
 Activates the controller models for the left and right controllers in the XR system.
void EnableAllInteraction (bool onOff)
 Control all possible interactions.
void EnableRayInteraction (bool onOff)
 Control RAY interaction.
void EnablePokeInteraction (bool onOff)
 Control POKE interaction.
void HideVR ()
 Fades VR user view to black.
void ShowVR ()
 Fades VR user view from black.
void ShowVRInstantly ()
 Instantly shows VR user view.
void ShowHands (bool onOff)
 Controls the visibility of hand meshes in the XR environment.
void ShowControllers (bool onOff)
 Toggles the visibility of the controller models associated with the XR system.

Detailed Description

Manages XR-related functionality within the framework, providing tools and settings for interaction, tracking, and visualization in an XR environment.

Includes features such as enabling/disabling interaction types, managing XR rig movement, and controlling the visibility of hands or controllers.

Member Function Documentation

◆ EnableAllInteraction()

void Edia.XRManager.EnableAllInteraction ( bool onOff)
inline

Control all possible interactions.

Use this if you have all possible interactive options in your project.

Parameters
onOffOn or Off

◆ EnableClimbing()

void Edia.XRManager.EnableClimbing ( bool onOff)
inline

[Not yet implemented] Enables or disables climbing functionality within the XR environment.

Parameters
onOffTrue/False

◆ EnableMoving()

void Edia.XRManager.EnableMoving ( bool onOff)
inline

[Not yet implemented] Enables or disables the movement functionality for the XR rig.

Parameters
onOffTrue/False

◆ EnablePokeInteraction()

void Edia.XRManager.EnablePokeInteraction ( bool onOff)
inline

Control POKE interaction.

Parameters
onOffOn or Off

◆ EnableRayInteraction()

void Edia.XRManager.EnableRayInteraction ( bool onOff)
inline

Control RAY interaction.

Parameters
onOffOn or Off

◆ EnableTeleportation()

void Edia.XRManager.EnableTeleportation ( bool onOff)
inline

[Not yet implemented] Enables or disables teleportation functionality in the XR environment.

Parameters
onOffTrue/False

◆ EnableTurning()

void Edia.XRManager.EnableTurning ( bool onOff)
inline

[Not yet implemented] Toggles the ability to rotate or turn within the XR environment.

Parameters
onOffTrue/False

◆ MoveXRRigToOverlayLayer()

void Edia.XRManager.MoveXRRigToOverlayLayer ( string layerName)
inline

Moves the XR Rig's controllers and hands to the specified overlay layer by changing their layer assignments.

Parameters
layerNameThe name of the layer to which the XR Rig components should be moved.

◆ SetInitialInteractionStateAsync()

async void Edia.XRManager.SetInitialInteractionStateAsync ( )
inline

XR Input Modality Manager seems to enable all interaction by default when hand or controller detected.

This method fires on 'TrackedHandModeStarted' and 'MotionControllerModeStarted' (set in inspector)

◆ ShowControllers()

void Edia.XRManager.ShowControllers ( bool onOff)
inline

Toggles the visibility of the controller models associated with the XR system.

Parameters
onOffA boolean value indicating whether to show the controllers (true) or hide them (false).

◆ ShowHands()

void Edia.XRManager.ShowHands ( bool onOff)
inline

Controls the visibility of hand meshes in the XR environment.

Parameters
onOffTrue to display hand meshes, false to hide them.

The documentation for this class was generated from the following file:
  • D:/Felix/Projects/EDIA/edia_core/Assets/com.edia.core/Runtime/Base/Scripts/Experiment/XRManager.cs