API reference
API reference
Select your platform
No SDKs available
No versions available

GazeInteractor Class

Extends Oculus.Interaction.PointerInteractor< GazeInteractor, GazeInteractable >
Implements Oculus.Interaction.ITimeConsumer, Oculus.Interaction.IGazeInteractor
This interactor is driven by eye tracking and allows selecting and moving selected objects

Fields

CandidateProperties : override object
The ICandidatePosition implementation used to compare interaction candidates.
Signature 
override object Oculus.Interaction.GazeInteractor.CandidateProperties
HitTester : IGazeHitTester
Signature 
IGazeHitTester Oculus.Interaction.GazeInteractor.HitTester
MaxRayLength : float
Signature 
float Oculus.Interaction.GazeInteractor.MaxRayLength
PointerTransform : Transform
Signature 
Transform Oculus.Interaction.GazeInteractor.PointerTransform
Ray : Ray
The current gaze ray
Signature 
Ray Oculus.Interaction.GazeInteractor.Ray

Properties

CandidateHitNormal : Vector3
[Get]
The current normal vector (world space) of the CandidateHitPoint
Signature 
Vector3 Oculus.Interaction.GazeInteractor.CandidateHitNormal
CandidateHitPoint : Vector3
[Get]
The current intersection point (world space) of this interactor and its candidate interactable
Effectively the "cursor" position of this interactor.
Signature 
Vector3 Oculus.Interaction.GazeInteractor.CandidateHitPoint
DwellTimespanSeconds : float
[Get][Set]
The timespan over which the interactor will analyze gaze when selecting a candidate.
Increasing this value increases "dwell time."
Signature 
float Oculus.Interaction.GazeInteractor.DwellTimespanSeconds
WorldPose : Pose
[Get]
The world pose of the gaze origin
Signature 
Pose Oculus.Interaction.GazeInteractor.WorldPose

Protected Methods

Awake ()
Signature 
override void Oculus.Interaction.GazeInteractor.Awake()
Returns
override void
ComputeCandidate ()
Signature 
override GazeInteractable Oculus.Interaction.GazeInteractor.ComputeCandidate()
Returns
override GazeInteractable
ComputeCandidateTiebreaker ( a , b )
Signature 
override int Oculus.Interaction.GazeInteractor.ComputeCandidateTiebreaker(GazeInteractable a, GazeInteractable b)
Parameters
a: GazeInteractable
b: GazeInteractable
Returns
override int
ComputePointerPose ()
Signature 
override Pose Oculus.Interaction.GazeInteractor.ComputePointerPose()
Returns
override Pose
DoHoverUpdate ()
Signature 
override void Oculus.Interaction.GazeInteractor.DoHoverUpdate()
Returns
override void
DoNormalUpdate ()
Signature 
override void Oculus.Interaction.GazeInteractor.DoNormalUpdate()
Returns
override void
DoPreprocess ()
Signature 
override void Oculus.Interaction.GazeInteractor.DoPreprocess()
Returns
override void
DoSelectUpdate ()
Signature 
override void Oculus.Interaction.GazeInteractor.DoSelectUpdate()
Returns
override void
InteractableSelected ( interactable )
Signature 
override void Oculus.Interaction.GazeInteractor.InteractableSelected(GazeInteractable interactable)
Parameters
interactable: GazeInteractable
Returns
override void
InteractableUnselected ( interactable )
Signature 
override void Oculus.Interaction.GazeInteractor.InteractableUnselected(GazeInteractable interactable)
Parameters
interactable: GazeInteractable
Returns
override void
Start ()
Signature 
override void Oculus.Interaction.GazeInteractor.Start()
Returns
override void

Methods

InjectAllGazeInteractor ( selector , gaze , relativeOrigin , hitTester )
Signature 
void Oculus.Interaction.GazeInteractor.InjectAllGazeInteractor(ISelector selector, IGaze gaze, Transform relativeOrigin, IGazeHitTester hitTester)
Parameters
selector: ISelector
gaze: IGaze
relativeOrigin: Transform
hitTester: IGazeHitTester
Returns
void
InjectGaze ( gaze )
Signature 
void Oculus.Interaction.GazeInteractor.InjectGaze(IGaze gaze)
Parameters
gaze: IGaze
Returns
void
InjectHitTester ( hitTester )
Signature 
void Oculus.Interaction.GazeInteractor.InjectHitTester(IGazeHitTester hitTester)
Parameters
hitTester: IGazeHitTester
Returns
void
InjectPointerTransform ( pointerTransform )
Signature 
void Oculus.Interaction.GazeInteractor.InjectPointerTransform(Transform pointerTransform)
Parameters
pointerTransform: Transform
Returns
void
InjectSelector ( selector )
Signature 
void Oculus.Interaction.GazeInteractor.InjectSelector(ISelector selector)
Parameters
selector: ISelector
Returns
void
SetTimeProvider ( timeProvider )
Sets a custom time provider function that returns the current time in seconds.
Signature 
void Oculus.Interaction.GazeInteractor.SetTimeProvider(Func< float > timeProvider)
Parameters
timeProvider: Func< float >  A function delegate that returns the current time in seconds.
Returns
void

Inner Class

GazeCandidateProperties Class

Implements Oculus.Interaction.ICandidatePosition

Constructors

GazeCandidateProperties ( candidatePosition )
Signature 
Oculus.Interaction.GazeInteractor.GazeCandidateProperties.GazeCandidateProperties(Vector3 candidatePosition)
Parameters
candidatePosition: Vector3

Properties

CandidatePosition : Vector3
[Get]
Signature 
Vector3 Oculus.Interaction.GazeInteractor.GazeCandidateProperties.CandidatePosition
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta