Interactor groups are collections of IInteractors which control the interactors within them, managing their execution and selecting which interactors are permitted to adopt which states. Information on the role and usage of interactor groups can be found in the documentation.

Protected Fields

List< UnityEngine.Object > _interactors[Get]

UnityEngine.Object _candidateComparer[Get]

ICandidateComparer CandidateComparer[Get]

bool _started[Get]

Fields

IReadOnlyList< IInteractor > Interactors[Get]

The list of IInteractors contained in and controlled by this interactor group.

Each interactor can only be in a single group to avoid conflicts from having multiple groups attempting to control the same interactor. This field is initialized during the MonoBehaviour start-up process from values set in the Unity Editor or through InjectInteractors(List<IInteractor>). Modifying the set of interactors in a group at runtime is not supported.

object Data[Get]

Implementation of IInteractorView.Data; for details, please refer to the related documentation provided for that interface.

int Identifier[Get]

Implementation of IInteractorView.Identifier; for details, please refer to the related documentation provided for that interface.

Properties

int MaxIterationsPerFrame[Get]

This is an internal API which sets or retrieves the maximum number of times the interactor group will execute its processing loop (assessing and enacting changes in the groups InteractorState, among other effects) within a single frame.

The implications of this are complex, and depending on or modifying this value is not recommended.

bool IsRootDriver[Get]

Implementation of IUpdateDriver.IsRootDriver; for details, please refer to the related documentation provided for that interface.

abstract bool ShouldHover[Get]

Implementation of IInteractor.ShouldHover; for details, please refer to the related documentation provided for that interface.

abstract bool ShouldUnhover[Get]

Implementation of IInteractor.ShouldUnhover; for details, please refer to the related documentation provided for that interface.

abstract bool ShouldSelect[Get]

Implementation of IInteractor.ShouldSelect; for details, please refer to the related documentation provided for that interface.

abstract bool ShouldUnselect[Get]

Implementation of IInteractor.ShouldUnselect; for details, please refer to the related documentation provided for that interface.

abstract bool HasCandidate[Get]

Implementation of IInteractorView.HasCandidate; for details, please refer to the related documentation provided for that interface.

abstract bool HasInteractable[Get]

Implementation of IInteractorView.HasInteractable; for details, please refer to the related documentation provided for that interface.

abstract bool HasSelectedInteractable[Get]

Implementation of IInteractorView.HasSelectedInteractable; for details, please refer to the related documentation provided for that interface.

abstract object CandidateProperties[Get]

InteractorState State[Get]

Implementation of IInteractorView.State; for details, please refer to the related documentation provided for that interface.

Events

Action< InteractorStateChangeArgs > WhenStateChanged

Implementation of IInteractorView.WhenStateChanged; for details, please refer to the related documentation provided for that interface.

Action WhenPreprocessed

Implementation of IInteractorView.WhenPreprocessed; for details, please refer to the related documentation provided for that interface.

Action WhenProcessed

Implementation of IInteractorView.WhenProcessed; for details, please refer to the related documentation provided for that interface.

Action WhenPostprocessed

Implementation of IInteractorView.WhenPostprocessed; for details, please refer to the related documentation provided for that interface.

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 ( )

Implementation of IInteractor.Hover; for details, please refer to the related documentation provided for that interface.

abstract void Unhover ( )

Implementation of IInteractor.Unhover; for details, please refer to the related documentation provided for that interface.

abstract void Select ( )

Implementation of IInteractor.Select; for details, please refer to the related documentation provided for that interface.

abstract void Unselect ( )

Implementation of IInteractor.ShouldUnselect; for details, please refer to the related documentation provided for that interface.

virtual void Preprocess ( )

Implementation of IInteractor.Preprocess; for details, please refer to the related documentation provided for that interface.

virtual void Process ( )

Implementation of IInteractor.Process; for details, please refer to the related documentation provided for that interface.

virtual void Postprocess ( )

Implementation of IInteractor.Postprocess; for details, please refer to the related documentation provided for that interface.

virtual void ProcessCandidate ( )

Implementation of IInteractor.ProcessCandidate; for details, please refer to the related documentation provided for that interface.

virtual void Enable ( )

Implementation of IInteractor.Enable; for details, please refer to the related documentation provided for that interface.

virtual void Disable ( )

Implementation of IInteractor.Disable; for details, please refer to the related documentation provided for that interface.

virtual void Drive ( )

Implementation of IUpdateDriver.Drive; for details, please refer to the related documentation provided for that interface.

void InjectAllInteractorGroupBase

( List< IInteractor > interactors )

Convenience method that injects all required dependencies for a dynamically instantiated InteractorGroup; because only one dependency is required, this method simlpy wraps InjectInteractors(List<IInteractor>).

This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.

void InjectInteractors

( List< IInteractor > interactors )

Adds a list of IInteractors to a dynamically instantiated InteractorGroup.

This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.

void InjectOptionalActiveState

( IActiveState activeState )

Adds an IActiveState to a dynamically instantiated InteractorGroup.

This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.

void InjectOptionalCandidateComparer

( ICandidateComparer candidateComparer )

Adds an ICandidateComparer to a dynamically instantiated InteractorGroup.