InteractableEventRoute<S,T> Class

Definition

Namespace:

MixedReality.Toolkit.Experimental

Assembly:

MixedReality.Toolkit.Core.dll

A IXRInteractableEventRoute that relays IXRInteractable events from interactables to game objects that contain IXRInteractableEventRouteTarget components.

public abstract class InteractableEventRoute<S,T> : MixedReality.Toolkit.Experimental.IXRInteractableEventRoute where S : IXRInteractable where T : IXRInteractableEventRouteTarget

type InteractableEventRoute<'S, 'T (requires 'S :> IXRInteractable and 'T :> IXRInteractableEventRouteTarget)> = class
    interface IXRInteractableEventRoute

Public MustInherit Class InteractableEventRoute(Of S, T)
Implements IXRInteractableEventRoute

Type Parameters

S

The specialized type of IXRInteractable that will be registered. Only events originating from this type will be handled.

T

The specialized type of IXRInteractableEventRouteTarget that will receive events originating from an interactable component.

Inheritance

Object

InteractableEventRoute<S,T>

Derived

MixedReality.Toolkit.Experimental.InteractableChildrenEventRoute<S,T>

MixedReality.Toolkit.Experimental.InteractableParentEventRoute<S,T>

Implements

IXRInteractableEventRoute

Remarks

This is an experimental feature. This class is early in the cycle, it has been labeled as experimental to indicate that it is still evolving, and subject to change over time. Parts of the MRTK, such as this class, appear to have a lot of value even if the details haven't fully been fleshed out. For these types of features, we want the community to see them and get value out of them early enough so to provide feedback.

Constructors

Name	Description
InteractableEventRoute<S,T>()

Methods

Name	Description
GetTargets(GameObject, List<T>)	Search for and return all IXRInteractableEventRouteTarget objects that should receive events from the registered IXRInteractable objects.
OnEnabled(GameObject)	Enable this event route by searching for IXRInteractableEventRouteTarget.
Register(IXRInteractable)	Starts listening to events from an unregistered IXRInteractable.
Register(S, T)	Add event handlers that will handle events from the source and direct them to the target.
Unregister(IXRInteractable)	Stop listening to events from a registered IXRInteractable.
Unregister(S, T)	Remove event handlers that are handling events from the source and directing them to the target.