We've moved!

Starting from MRTK 2.6, we are publishing both conceptual docs and API references on docs.microsoft.com. For conceptual docs, please visit our new landing page. For API references, please visit the MRTK-Unity section of the dot net API explorer. Existing content will remain here but will not be updated further.

    Show / Hide Table of Contents

    Class TeleportCursor

    Inheritance
    Object
    TeleportCursor
    Implements
    IMixedRealityTeleportHandler
    IEventSystemHandler
    Namespace: Microsoft.MixedReality.Toolkit.Teleport
    Assembly: cs.temp.dll.dll
    Syntax
    public class TeleportCursor : AnimatedCursor, IMixedRealityTeleportHandler, IEventSystemHandler

    Properties

    LocalScale

    Declaration
    public override Vector3 LocalScale { get; }
    Property Value
    Type Description
    Vector3

    Pointer

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

    Position

    Declaration
    public override Vector3 Position { get; }
    Property Value
    Type Description
    Vector3

    Rotation

    Declaration
    public override Quaternion Rotation { get; }
    Property Value
    Type Description
    Quaternion

    Methods

    CheckCursorState()

    Declaration
    public override CursorStateEnum CheckCursorState()
    Returns
    Type Description
    CursorStateEnum

    OnTeleportCanceled(TeleportEventData)

    Raised when a teleport request has been canceled.

    Declaration
    public void OnTeleportCanceled(TeleportEventData eventData)
    Parameters
    Type Name Description
    TeleportEventData eventData

    OnTeleportCompleted(TeleportEventData)

    Raised when a teleport has successfully completed.

    Declaration
    public void OnTeleportCompleted(TeleportEventData eventData)
    Parameters
    Type Name Description
    TeleportEventData eventData

    OnTeleportRequest(TeleportEventData)

    Raised when a pointer requests a teleport target, but no teleport has begun.

    Declaration
    public void OnTeleportRequest(TeleportEventData eventData)
    Parameters
    Type Name Description
    TeleportEventData eventData

    OnTeleportStarted(TeleportEventData)

    Raised when a teleport has started.

    Declaration
    public void OnTeleportStarted(TeleportEventData eventData)
    Parameters
    Type Name Description
    TeleportEventData eventData

    UpdateCursorTransform()

    Declaration
    protected override void UpdateCursorTransform()

    Implements

    IMixedRealityTeleportHandler
    IEventSystemHandler
    Back to top Generated by DocFX