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

InteractorGroup Class

Extends MonoBehaviour, IInteractor

Protected Fields

List< UnityEngine.Object > _interactors[Get]
UnityEngine.Object _candidateComparer[Get]
ICandidateComparer CandidateComparer[Get]
bool _started[Get]

Fields

IReadOnlyList< IInteractor > Interactors[Get]
object Data[Get]
int Identifier[Get]

Properties

int MaxIterationsPerFrame[Get]
bool IsRootDriver[Get]
abstract bool ShouldHover[Get]
abstract bool ShouldUnhover[Get]
abstract bool ShouldSelect[Get]
abstract bool ShouldUnselect[Get]
abstract bool HasCandidate[Get]
abstract bool HasInteractable[Get]
abstract bool HasSelectedInteractable[Get]
abstract object CandidateProperties[Get]
InteractorState State[Get]

Events

Action< InteractorStateChangeArgs > WhenStateChanged
Action WhenPreprocessed
Action WhenProcessed
Action WhenPostprocessed

Object Data for protected-static-attrib

static readonly InteractorPredicate TruePredicate[Get]
static readonly InteractorPredicate HasCandidatePredicate[Get]
static readonly InteractorPredicate HasInteractablePredicate[Get]

Member Functions

abstract void Hover ( )
abstract void Unhover ( )
abstract void Select ( )
abstract void Unselect ( )
virtual void Preprocess ( )
virtual void Process ( )
virtual void Postprocess ( )
virtual void ProcessCandidate ( )
virtual void Enable ( )
virtual void Disable ( )
virtual void Drive ( )
void InjectAllInteractorGroupBase
( List< IInteractor > interactors )
void InjectInteractors
( List< IInteractor > interactors )
void InjectOptionalActiveState
( IActiveState activeState )
void InjectOptionalCandidateComparer
( ICandidateComparer candidateComparer )

Protected Functions

delegate bool InteractorPredicate
( IInteractor interactor,
int index )
virtual void Awake ( )
virtual void Start ( )
virtual void OnEnable ( )
virtual void OnDisable ( )
virtual void OnDestroy ( )
bool TryGetBestCandidateIndex
( InteractorPredicate predicate,
out int bestCandidateIndex,
int betterThan,
int skipIndex )
bool AnyInteractor
( InteractorPredicate predicate )
int CompareCandidates
( int indexA,
int indexB )
void DisableAllExcept
( IInteractor mainInteractor )
void EnableAllExcept
( IInteractor mainInteractor )
bool UpdateActiveState ( )
virtual void Update ( )

Object Data for protected-static-func

Compares two InteractorStates indicating which one is higher in the Active State chain
Parameters
a
First state to compare
b
Seconds state to compare
Returns
1 if b is higher than a, -1 if a is higher than b. 0 of they are equal
Did you find this page helpful?
Thumbs up icon
Thumbs down icon