Class GazeDivergenceModule

Allows an implementer to test for a given transforms' position residing within an angular threshold of the HMD

Inheritance
Object
GazeDivergenceModule
Namespace: UnityEditor.Experimental.EditorVR.Modules
Syntax
public sealed class GazeDivergenceModule : IModuleBehaviorCallbacks, IDelayedInitializationModule, IModule, IProvidesDetectGazeDivergence, IFunctionalityProvider

Properties

initializationOrder

Declaration
public int initializationOrder { get; }
Property Value
Type Description
Int32
Implements

shutdownOrder

Declaration
public int shutdownOrder { get; }
Property Value
Type Description
Int32
Implements

Methods

ConnectSubscriber(Object)

Declaration
public void ConnectSubscriber(object obj)
Parameters
Type Name Description
Object obj
Implements

Initialize()

Declaration
public void Initialize()
Implements

IsAboveDivergenceThreshold(Transform, Single, Boolean)

Test for a transform residing with a defined angular divergence threshold

Declaration
public bool IsAboveDivergenceThreshold(Transform objectToTest, float divergenceThreshold, bool disregardTemporalStability = true)
Parameters
Type Name Description
Transform objectToTest

Vector to test for a threshold cross with relation to the gazeSource forward vector
Single divergenceThreshold

Threshold, in degrees, via doc product conversion of this angular value
Boolean disregardTemporalStability

If true, mandate that divergence detection occur, regardless of the gaze being stable
Returns
Type Description
Boolean

True if the object is beyond the divergence threshold, False if it is within the defined range
Implements

LoadModule()

Declaration
public void LoadModule()
Implements

LoadProvider()

Declaration
public void LoadProvider()
Implements

OnBehaviorAwake()

Declaration
public void OnBehaviorAwake()
Implements

OnBehaviorDestroy()

Declaration
public void OnBehaviorDestroy()
Implements

OnBehaviorDisable()

Declaration
public void OnBehaviorDisable()
Implements

OnBehaviorEnable()

Declaration
public void OnBehaviorEnable()
Implements

OnBehaviorStart()

Declaration
public void OnBehaviorStart()
Implements

OnBehaviorUpdate()

Declaration
public void OnBehaviorUpdate()
Implements

SetDivergenceRecoverySpeed(Single)

Set the value that scales the rate at which the gaze velocity will return to the stable threshold (below the gaze divergence threshold) A value of 1 will allow the gaze velocity to return to the stable threshold value at its' normal rate A value less than 1 will increase the rate at which the gaze velocity returns to the stable gaze threshold value (slower) A value greater than 1 will increase the rate at which the gaze velocity returns to the stable gaze threshold value (faster)

Declaration
public void SetDivergenceRecoverySpeed(float rateAtWhichGazeVelocityReturnsToStableThreshold)
Parameters
Type Name Description
Single rateAtWhichGazeVelocityReturnsToStableThreshold

The rate at which gaze velocity returns to stable threshold
Implements

Shutdown()

Declaration
public void Shutdown()
Implements

UnloadModule()

Declaration
public void UnloadModule()
Implements

UnloadProvider()

Declaration
public void UnloadProvider()
Implements