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

InteractableGroupView Class

Extends MonoBehaviour, IInteractableView
This class implements higher level logic to forward the highest IInteractableView state of any of the interactables in its list.

Properties

A generic metadata property used for a variety of purposes in Interaction SDK logic.
Though this property is public, it has no formal contract, and consequently it is generally not safe to assume that any specific piece of information is available through this property on any instance at any time.
int InteractorsCount[Get]
int SelectingInteractorsCount[Get]
Enumerates all of the IInteractorViews currently associated with this instance.
This includes all varieties of interaction association (both InteractableState.Hover and InteractableState.Select), but does not include candidacy (see IInteractorView.HasCandidate).
Enumerates all of the IInteractorViews currently selecting this instance, excluding all states of association other than InteractableState.Select.
The largest number of conceptual "interactor" instances (technically IInteractorViews) which can simultaneously interact with this instance.
By convention, -1 indicates an unbounded maximum.
The largest number of conceptual "interactor" instances (technically IInteractorViews) which can simultaneously select this instance.
By convention, -1 indicates an unbounded maximum.
The current InteractableState of the conceptual "interactable" represented by this IInteractableView.
This property is used in core Interaction SDK logic, and querying it directly is not recommended as the state can change repeatedly and at unpredictable times within a frame depending on occurrances within the interaction system. Rather than querying the state at an arbitrary point during the frame, it is recommended to observe the WhenStateChanged event (either directly our through an InteractableUnityEventWrapper) in order to reliably handle all state changes as they come.

Events

Action< IInteractorView > WhenInteractorViewAdded
Action< IInteractorView > WhenInteractorViewRemoved
Action< IInteractorView > WhenSelectingInteractorViewAdded
Action< IInteractorView > WhenSelectingInteractorViewRemoved
Action< InteractableStateChangeArgs > WhenStateChanged

Protected Fields

bool _started[Get]

Protected Functions

virtual void Awake ( )
virtual void Start ( )
virtual void OnEnable ( )
virtual void OnDisable ( )

Member Functions

void InjectAllInteractableGroupView
( List< IInteractableView > interactables )
void InjectInteractables
( List< IInteractableView > interactables )
void InjectOptionalData
( object data )
Did you find this page helpful?
Thumbs up icon
Thumbs down icon