API reference
Interactable Class
Interactable provides a base template for any kind of interactable object.
Oculus::Interaction::Interactable extends MonoBehaviour.
Oculus::Interaction::Interactable extends Oculus.Interaction.IInteractable.
Overview
Properties
object | Data[Get] |
int | MaxInteractors[Get] |
int | |
IEnumerable< IInteractorView > | InteractorViews[Get] |
IEnumerable< IInteractorView > | |
MAction< TInteractor > | WhenInteractorAdded[Get] |
MAction< TInteractor > | |
MAction< TInteractor > | |
MAction< TInteractor > | |
InteractableState | State[Get] |
static InteractableRegistry< TInteractor, TInteractable > | Registry[Get] |
IEnumerableHashSet< TInteractor > | Interactors[Get] |
IEnumerableHashSet< TInteractor > | SelectingInteractors[Get] |
Object Data
bool | _started[Get] |
Events
Action< InteractableStateChangeArgs > | WhenStateChanged ( ) |
Action< IInteractorView > | |
Action< IInteractorView > | |
Action< IInteractorView > | |
Action< IInteractorView > |
Object Data
void | InteractorAdded ( TInteractor interactor ) |
void | InteractorRemoved ( TInteractor interactor ) |
void | SelectingInteractorAdded ( TInteractor interactor ) |
void | SelectingInteractorRemoved ( TInteractor interactor ) |
void | Awake ( ) |
void | Start ( ) |
void | OnEnable ( ) |
void | OnDisable ( ) |
void | SetRegistry ( InteractableRegistry< TInteractor, TInteractable > registry ) |
Public Member Functions
void | AddInteractor ( TInteractor interactor ) Adds an interactor to the interactable. |
void | RemoveInteractor ( TInteractor interactor ) Removes an interactor from the interactable. |
void | AddSelectingInteractor ( TInteractor interactor ) Adds a selecting interactor to the interactable. |
void | RemoveSelectingInteractor ( TInteractor interactor ) Removes a selecting interactor from the interactable. |
bool | CanBeSelectedBy ( TInteractor interactor ) Determines if the interactable can be interacted on by the given interactor. |
bool | HasInteractor ( TInteractor interactor ) Determines if the interactable is being hovered by the given interactor. |
bool | HasSelectingInteractor ( TInteractor interactor ) Determines if the interactable is being selected by the given interactor. |
void | Enable ( ) |
void | Disable ( ) |
void | RemoveInteractorByIdentifier ( int id ) Uses an interactor's unique ID to remove it from this interactable. |
void | InjectOptionalInteractorFilters ( List< IGameObjectFilter > interactorFilters ) Sets interactor filters for this interactable on a dynamically instantiated GameObject. |
void | InjectOptionalData ( object data ) Sets data for this interactable on a dynamically instantiated GameObject. |
Details
Detailed Description
An Interactable can have Hover and HandleSelected Interactor(s) acting on it. Concrete Interactables can define whether they have a One-to-One or One-to-Many relationship with their associated concrete Interactors.
Properties
| object Oculus.Interaction.Interactable< TInteractor, TInteractable >.Data |
|---|
No description available.
|
| int Oculus.Interaction.Interactable< TInteractor, TInteractable >.MaxInteractors |
|---|
No description available.
|
| int Oculus.Interaction.Interactable< TInteractor, TInteractable >.MaxSelectingInteractors |
|---|
No description available.
|
| IEnumerable<IInteractorView> Oculus.Interaction.Interactable< TInteractor, TInteractable >.InteractorViews |
|---|
No description available.
|
| IEnumerable<IInteractorView> Oculus.Interaction.Interactable< TInteractor, TInteractable >.SelectingInteractorViews |
|---|
No description available.
|
| MAction<TInteractor> Oculus.Interaction.Interactable< TInteractor, TInteractable >.WhenInteractorAdded |
|---|
No description available.
|
| MAction<TInteractor> Oculus.Interaction.Interactable< TInteractor, TInteractable >.WhenInteractorRemoved |
|---|
No description available.
|
| MAction<TInteractor> Oculus.Interaction.Interactable< TInteractor, TInteractable >.WhenSelectingInteractorAdded |
|---|
No description available.
|
| MAction<TInteractor> Oculus.Interaction.Interactable< TInteractor, TInteractable >.WhenSelectingInteractorRemoved |
|---|
No description available.
|
| InteractableState Oculus.Interaction.Interactable< TInteractor, TInteractable >.State |
|---|
No description available.
|
| InteractableRegistry<TInteractor, TInteractable> Oculus.Interaction.Interactable< TInteractor, TInteractable >.Registry |
|---|
No description available.
|
| IEnumerableHashSet<TInteractor> Oculus.Interaction.Interactable< TInteractor, TInteractable >.Interactors |
|---|
No description available.
|
| IEnumerableHashSet<TInteractor> Oculus.Interaction.Interactable< TInteractor, TInteractable >.SelectingInteractors |
|---|
No description available.
|
Object Data
| bool Oculus.Interaction.Interactable< TInteractor, TInteractable >._started |
|---|
No description available.
|
Events
| Action<InteractableStateChangeArgs> Oculus.Interaction.Interactable< TInteractor, TInteractable >.WhenStateChanged ( ) |
|---|
No description available.
|
| Action<IInteractorView> Oculus.Interaction.Interactable< TInteractor, TInteractable >.WhenInteractorViewAdded ( ) |
|---|
No description available.
|
| Action<IInteractorView> Oculus.Interaction.Interactable< TInteractor, TInteractable >.WhenInteractorViewRemoved ( ) |
|---|
No description available.
|
| Action<IInteractorView> Oculus.Interaction.Interactable< TInteractor, TInteractable >.WhenSelectingInteractorViewAdded ( ) |
|---|
No description available.
|
| Action<IInteractorView> Oculus.Interaction.Interactable< TInteractor, TInteractable >.WhenSelectingInteractorViewRemoved ( ) |
|---|
No description available.
|
Object Data
| virtual void Oculus.Interaction.Interactable< TInteractor, TInteractable >.InteractorAdded ( TInteractor interactor ) |
|---|
No description available.
|
| virtual void Oculus.Interaction.Interactable< TInteractor, TInteractable >.InteractorRemoved ( TInteractor interactor ) |
|---|
No description available.
|
| virtual void Oculus.Interaction.Interactable< TInteractor, TInteractable >.SelectingInteractorAdded ( TInteractor interactor ) |
|---|
No description available.
|
| virtual void Oculus.Interaction.Interactable< TInteractor, TInteractable >.SelectingInteractorRemoved ( TInteractor interactor ) |
|---|
No description available.
|
| virtual void Oculus.Interaction.Interactable< TInteractor, TInteractable >.Awake ( ) |
|---|
No description available.
|
| virtual void Oculus.Interaction.Interactable< TInteractor, TInteractable >.Start ( ) |
|---|
No description available.
|
| virtual void Oculus.Interaction.Interactable< TInteractor, TInteractable >.OnEnable ( ) |
|---|
No description available.
|
| virtual void Oculus.Interaction.Interactable< TInteractor, TInteractable >.OnDisable ( ) |
|---|
No description available.
|
| virtual void Oculus.Interaction.Interactable< TInteractor, TInteractable >.SetRegistry ( InteractableRegistry< TInteractor, TInteractable > registry ) |
|---|
No description available.
|
Member Functions
| void Oculus.Interaction.Interactable< TInteractor, TInteractable >.AddInteractor ( TInteractor interactor ) |
|---|
Adds an interactor to the interactable. |
| void Oculus.Interaction.Interactable< TInteractor, TInteractable >.RemoveInteractor ( TInteractor interactor ) |
|---|
Removes an interactor from the interactable. |
| void Oculus.Interaction.Interactable< TInteractor, TInteractable >.AddSelectingInteractor ( TInteractor interactor ) |
|---|
Adds a selecting interactor to the interactable. |
| void Oculus.Interaction.Interactable< TInteractor, TInteractable >.RemoveSelectingInteractor ( TInteractor interactor ) |
|---|
Removes a selecting interactor from the interactable. |
| bool Oculus.Interaction.Interactable< TInteractor, TInteractable >.CanBeSelectedBy ( TInteractor interactor ) |
|---|
Determines if the interactable can be interacted on by the given interactor. Parameters interactor The interactor that intends to interact with the interactable. Returns True if the interactor can interact with the interactable, false otherwise. |
| bool Oculus.Interaction.Interactable< TInteractor, TInteractable >.HasInteractor ( TInteractor interactor ) |
|---|
Determines if the interactable is being hovered by the given interactor. Parameters interactor The interactor to check for hovering. Returns True if the interactor is hovering the interactable, false otherwise. |
| bool Oculus.Interaction.Interactable< TInteractor, TInteractable >.HasSelectingInteractor ( TInteractor interactor ) |
|---|
Determines if the interactable is being selected by the given interactor. Parameters interactor The interactor to check for selecting. Returns True if the interactor is selecting the interactable, false otherwise. |
| void Oculus.Interaction.Interactable< TInteractor, TInteractable >.Enable ( ) |
|---|
No description available.
|
| void Oculus.Interaction.Interactable< TInteractor, TInteractable >.Disable ( ) |
|---|
No description available.
|
| void Oculus.Interaction.Interactable< TInteractor, TInteractable >.RemoveInteractorByIdentifier ( int id ) |
|---|
Uses an interactor's unique ID to remove it from this interactable. Parameters id The ID of the interactor to remove. |
| void Oculus.Interaction.Interactable< TInteractor, TInteractable >.InjectOptionalInteractorFilters ( List< IGameObjectFilter > interactorFilters ) |
|---|
Sets interactor filters for this interactable on a dynamically instantiated GameObject. |
| void Oculus.Interaction.Interactable< TInteractor, TInteractable >.InjectOptionalData ( object data ) |
|---|
Sets data for this interactable on a dynamically instantiated GameObject. |
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta