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

InteractableRegistry Class

A registry that houses a set of concrete Interactables.

Constructors

InteractableRegistry ()
Signature
Oculus.Interaction.InteractableRegistry< TInteractor, TInteractable >.InteractableRegistry()

Protected Methods

List ( interactor , onlyInclude )
Returns a filtered collection of interactables.
Signature
InteractableSet Oculus.Interaction.InteractableRegistry< TInteractor, TInteractable >.List(TInteractor interactor, HashSet< TInteractable > onlyInclude)
Parameters
interactor: TInteractor  Only interactables that can be selected by this interactor will be returned
onlyInclude: HashSet< TInteractable >  Only interactables included in this subset will be included in the returned collection
Returns
InteractableSet

Methods

List ( interactor )
Returns a filtered collection of interactables.
Signature
virtual InteractableSet Oculus.Interaction.InteractableRegistry< TInteractor, TInteractable >.List(TInteractor interactor)
Parameters
interactor: TInteractor  Only interactables that can be selected by this interactor will be returned
Returns
InteractableSet
List ()
Returns all interactables in this registry.
Signature
virtual InteractableSet Oculus.Interaction.InteractableRegistry< TInteractor, TInteractable >.List()
Returns
InteractableSet
Register ( interactable )
Signature
virtual void Oculus.Interaction.InteractableRegistry< TInteractor, TInteractable >.Register(TInteractable interactable)
Parameters
interactable: TInteractable
Returns
void
Unregister ( interactable )
Signature
virtual void Oculus.Interaction.InteractableRegistry< TInteractor, TInteractable >.Unregister(TInteractable interactable)
Parameters
interactable: TInteractable
Returns
void

Inner Struct

InteractableSet Struct

Extends IEnumerable< TInteractable >
Allocation-free collection that can be iterated over to provide a pruned list of Interactables.

Constructors

InteractableSet ( onlyInclude , testAgainst )
A pruned set of interactables from the InteractableRegistry<TInteractor, TInteractable>
Signature
Oculus.Interaction.InteractableRegistry< TInteractor, TInteractable >.InteractableSet.InteractableSet(ISet< TInteractable > onlyInclude, TInteractor testAgainst)
Parameters
onlyInclude: ISet< TInteractable >  Include only these interactables from the base _interactables collection. Provide a null value to skip this filtering.
testAgainst: TInteractor  Filter against an interactor. Provide a null value to skip this filtering.

Methods

GetEnumerator ()
Signature
Enumerator Oculus.Interaction.InteractableRegistry< TInteractor, TInteractable >.InteractableSet.GetEnumerator()
Returns
Enumerator
GetEnumerator ()
Signature
IEnumerator< TInteractable > IEnumerable< TInteractable >. Oculus.Interaction.InteractableRegistry< TInteractor, TInteractable >.InteractableSet.GetEnumerator()
Returns
IEnumerator< TInteractable > IEnumerable< TInteractable >.
GetEnumerator ()
Signature
IEnumerator IEnumerable. Oculus.Interaction.InteractableRegistry< TInteractor, TInteractable >.InteractableSet.GetEnumerator()
Returns
IEnumerator IEnumerable.

Inner Struct

Enumerator Struct
Extends IEnumerator< TInteractable >
Constructors
Enumerator ( set )
Signature
Oculus.Interaction.InteractableRegistry< TInteractor, TInteractable >.InteractableSet.Enumerator.Enumerator(in InteractableSet set)
Parameters
set: in InteractableSet
Properties
Current : TInteractable
[Get]
Signature
TInteractable Oculus.Interaction.InteractableRegistry< TInteractor, TInteractable >.InteractableSet.Enumerator.Current
Current : object IEnumerator.
[Get]
Signature
object IEnumerator. Oculus.Interaction.InteractableRegistry< TInteractor, TInteractable >.InteractableSet.Enumerator.Current
Methods
Dispose ()
Signature
void Oculus.Interaction.InteractableRegistry< TInteractor, TInteractable >.InteractableSet.Enumerator.Dispose()
Returns
void
MoveNext ()
Signature
bool Oculus.Interaction.InteractableRegistry< TInteractor, TInteractable >.InteractableSet.Enumerator.MoveNext()
Returns
bool
Reset ()
Signature
void Oculus.Interaction.InteractableRegistry< TInteractor, TInteractable >.InteractableSet.Enumerator.Reset()
Returns
void