mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class TeleportEventData

    Describes a Teleportation Event.

    Inheritance
    Object
    GenericBaseEventData
    TeleportEventData
    Implements
    BaseEventData
    Inherited Members
    GenericBaseEventData.EventSource
    GenericBaseEventData.EventTime
    GenericBaseEventData.BaseInitialize(IMixedRealityEventSource)
    GenericBaseEventData.selectedObject
    Namespace: Microsoft.MixedReality.Toolkit.Teleport
    Assembly: cs.temp.dll.dll
    Syntax
    public class TeleportEventData : GenericBaseEventData, BaseEventData

    Constructors

    TeleportEventData(EventSystem)

    Constructor.

    Declaration
    public TeleportEventData(EventSystem eventSystem)
    Parameters
    Type Name Description
    EventSystem eventSystem

    Typically will be EventSystem.current

    TeleportEventData(EventSystem)

    Constructor.

    Declaration
    public TeleportEventData(EventSystem eventSystem)
    Parameters
    Type Name Description
    EventSystem eventSystem

    Typically will be EventSystem.current

    Properties

    HotSpot

    The teleport hot spot.

    Declaration
    public IMixedRealityTeleportHotSpot HotSpot { get; }
    Property Value
    Type Description
    IMixedRealityTeleportHotSpot

    HotSpot

    The teleport hot spot.

    Declaration
    public IMixedRealityTeleportHotSpot HotSpot { get; }
    Property Value
    Type Description
    IMixedRealityTeleportHotSpot

    Pointer

    The pointer that raised the event.

    Declaration
    public IMixedRealityPointer Pointer { get; }
    Property Value
    Type Description
    IMixedRealityPointer

    Pointer

    The pointer that raised the event.

    Declaration
    public IMixedRealityPointer Pointer { get; }
    Property Value
    Type Description
    IMixedRealityPointer

    Methods

    Initialize(IMixedRealityPointer, IMixedRealityTeleportHotSpot)

    Used to initialize/reset the event and populate the data.

    Declaration
    public void Initialize(IMixedRealityPointer pointer, IMixedRealityTeleportHotSpot target)
    Parameters
    Type Name Description
    IMixedRealityPointer pointer
    IMixedRealityTeleportHotSpot target

    Initialize(IMixedRealityPointer, IMixedRealityTeleportHotSpot)

    Used to initialize/reset the event and populate the data.

    Declaration
    public void Initialize(IMixedRealityPointer pointer, IMixedRealityTeleportHotSpot target)
    Parameters
    Type Name Description
    IMixedRealityPointer pointer
    IMixedRealityTeleportHotSpot target

    Implements

    BaseEventData
    In This Article
    • Constructors
      • TeleportEventData(EventSystem)
      • TeleportEventData(EventSystem)
    • Properties
      • HotSpot
      • HotSpot
      • Pointer
      • Pointer
    • Methods
      • Initialize(IMixedRealityPointer, IMixedRealityTeleportHotSpot)
      • Initialize(IMixedRealityPointer, IMixedRealityTeleportHotSpot)
    • Implements
    Back to top Generated by DocFX