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

InteractorGroup Class

Extends MonoBehaviour

Protected Fields

_candidateComparer : UnityEngine.Object
Signature
UnityEngine.Object Oculus.Interaction.InteractorGroup._candidateComparer
_interactors : List< UnityEngine.Object >
Signature
List<UnityEngine.Object> Oculus.Interaction.InteractorGroup._interactors
_started : bool
Signature
bool Oculus.Interaction.InteractorGroup._started
CandidateComparer : ICandidateComparer
Signature
ICandidateComparer Oculus.Interaction.InteractorGroup.CandidateComparer

Fields

Interactors : IReadOnlyList< IInteractor >
Signature
IReadOnlyList<IInteractor> Oculus.Interaction.InteractorGroup.Interactors

Protected Static Fields

HasCandidatePredicate : readonly InteractorPredicate
Signature
readonly InteractorPredicate Oculus.Interaction.InteractorGroup.HasCandidatePredicate
HasInteractablePredicate : readonly InteractorPredicate
Signature
readonly InteractorPredicate Oculus.Interaction.InteractorGroup.HasInteractablePredicate
TruePredicate : readonly InteractorPredicate
Signature
readonly InteractorPredicate Oculus.Interaction.InteractorGroup.TruePredicate

Properties

CandidateProperties : abstract object
[Get]
Signature
abstract object Oculus.Interaction.InteractorGroup.CandidateProperties
Data : object
[Get]
Signature
object Oculus.Interaction.InteractorGroup.Data
HasCandidate : abstract bool
[Get]
Signature
abstract bool Oculus.Interaction.InteractorGroup.HasCandidate
HasInteractable : abstract bool
[Get]
Signature
abstract bool Oculus.Interaction.InteractorGroup.HasInteractable
HasSelectedInteractable : abstract bool
[Get]
Signature
abstract bool Oculus.Interaction.InteractorGroup.HasSelectedInteractable
Identifier : int
[Get]
Signature
int Oculus.Interaction.InteractorGroup.Identifier
IsRootDriver : bool
[Get][Set]
Signature
bool Oculus.Interaction.InteractorGroup.IsRootDriver
MaxIterationsPerFrame : int
[Get][Set]
Signature
int Oculus.Interaction.InteractorGroup.MaxIterationsPerFrame
ShouldHover : abstract bool
[Get]
Signature
abstract bool Oculus.Interaction.InteractorGroup.ShouldHover
ShouldSelect : abstract bool
[Get]
Signature
abstract bool Oculus.Interaction.InteractorGroup.ShouldSelect
ShouldUnhover : abstract bool
[Get]
Signature
abstract bool Oculus.Interaction.InteractorGroup.ShouldUnhover
ShouldUnselect : abstract bool
[Get]
Signature
abstract bool Oculus.Interaction.InteractorGroup.ShouldUnselect
State : InteractorState
[Get]
Signature
InteractorState Oculus.Interaction.InteractorGroup.State

Events

WhenPostprocessed : Action
Signature
Action Oculus.Interaction.InteractorGroup.WhenPostprocessed
WhenPreprocessed : Action
Signature
Action Oculus.Interaction.InteractorGroup.WhenPreprocessed
WhenProcessed : Action
Signature
Action Oculus.Interaction.InteractorGroup.WhenProcessed
WhenStateChanged : Action< InteractorStateChangeArgs >
Signature
Action<InteractorStateChangeArgs> Oculus.Interaction.InteractorGroup.WhenStateChanged

Protected Methods

AnyInteractor ( predicate )
Signature
bool Oculus.Interaction.InteractorGroup.AnyInteractor(InteractorPredicate predicate)
Parameters
predicate: InteractorPredicate
Returns
bool
Awake ()
Signature
virtual void Oculus.Interaction.InteractorGroup.Awake()
Returns
void
CompareCandidates ( indexA , indexB )
Signature
int Oculus.Interaction.InteractorGroup.CompareCandidates(int indexA, int indexB)
Parameters
indexA: int
indexB: int
Returns
int
DisableAllExcept ( mainInteractor )
Signature
void Oculus.Interaction.InteractorGroup.DisableAllExcept(IInteractor mainInteractor)
Parameters
mainInteractor: IInteractor
Returns
void
EnableAllExcept ( mainInteractor )
Signature
void Oculus.Interaction.InteractorGroup.EnableAllExcept(IInteractor mainInteractor)
Parameters
mainInteractor: IInteractor
Returns
void
InteractorPredicate ( interactor , index )
Signature
delegate bool Oculus.Interaction.InteractorGroup.InteractorPredicate(IInteractor interactor, int index)
Parameters
interactor: IInteractor
index: int
Returns
delegate bool
OnDestroy ()
Signature
virtual void Oculus.Interaction.InteractorGroup.OnDestroy()
Returns
void
OnDisable ()
Signature
virtual void Oculus.Interaction.InteractorGroup.OnDisable()
Returns
void
OnEnable ()
Signature
virtual void Oculus.Interaction.InteractorGroup.OnEnable()
Returns
void
Start ()
Signature
virtual void Oculus.Interaction.InteractorGroup.Start()
Returns
void
TryGetBestCandidateIndex ( predicate , bestCandidateIndex , betterThan , skipIndex )
Signature
bool Oculus.Interaction.InteractorGroup.TryGetBestCandidateIndex(InteractorPredicate predicate, out int bestCandidateIndex, int betterThan=-1, int skipIndex=-1)
Parameters
predicate: InteractorPredicate
bestCandidateIndex: out int
betterThan: int
skipIndex: int
Returns
bool
Update ()
Signature
virtual void Oculus.Interaction.InteractorGroup.Update()
Returns
void
UpdateActiveState ()
Signature
bool Oculus.Interaction.InteractorGroup.UpdateActiveState()
Returns
bool

Methods

Disable ()
Signature
virtual void Oculus.Interaction.InteractorGroup.Disable()
Returns
void
Drive ()
Signature
virtual void Oculus.Interaction.InteractorGroup.Drive()
Returns
void
Enable ()
Signature
virtual void Oculus.Interaction.InteractorGroup.Enable()
Returns
void
Hover ()
Signature
abstract void Oculus.Interaction.InteractorGroup.Hover()
Returns
abstract void
InjectAllInteractorGroupBase ( interactors )
Signature
void Oculus.Interaction.InteractorGroup.InjectAllInteractorGroupBase(List< IInteractor > interactors)
Parameters
interactors: List< IInteractor >
Returns
void
InjectInteractors ( interactors )
Signature
void Oculus.Interaction.InteractorGroup.InjectInteractors(List< IInteractor > interactors)
Parameters
interactors: List< IInteractor >
Returns
void
InjectOptionalActiveState ( activeState )
Signature
void Oculus.Interaction.InteractorGroup.InjectOptionalActiveState(IActiveState activeState)
Parameters
activeState: IActiveState
Returns
void
InjectOptionalCandidateComparer ( candidateComparer )
Signature
void Oculus.Interaction.InteractorGroup.InjectOptionalCandidateComparer(ICandidateComparer candidateComparer)
Parameters
candidateComparer: ICandidateComparer
Returns
void
Postprocess ()
Signature
virtual void Oculus.Interaction.InteractorGroup.Postprocess()
Returns
void
Preprocess ()
Signature
virtual void Oculus.Interaction.InteractorGroup.Preprocess()
Returns
void
Process ()
Signature
virtual void Oculus.Interaction.InteractorGroup.Process()
Returns
void
ProcessCandidate ()
Signature
virtual void Oculus.Interaction.InteractorGroup.ProcessCandidate()
Returns
void
Select ()
Signature
abstract void Oculus.Interaction.InteractorGroup.Select()
Returns
abstract void
Unhover ()
Signature
abstract void Oculus.Interaction.InteractorGroup.Unhover()
Returns
abstract void
Unselect ()
Signature
abstract void Oculus.Interaction.InteractorGroup.Unselect()
Returns
abstract void

Protected Static Methods

CompareStates ( a , b )
Compares two InteractorStates indicating which one is higher in the Active State chain.
Signature
static int Oculus.Interaction.InteractorGroup.CompareStates(InteractorState a, InteractorState b)
Parameters
a: InteractorState  First state to compare
b: InteractorState  Seconds state to compare
Returns
int  1 if b is higher than a, -1 if a is higher than b. 0 of they are equal