Class TeleportPointer

Implementation for teleportation pointer to support movement based on teleport raycasts and requests with the MRTK Teleport system

Inheritance
Object
TeleportPointer
ParabolicTeleportPointer
Implements
IMixedRealityTeleportPointer
IEventSystemHandler
Namespace: Microsoft.MixedReality.Toolkit.Teleport
Assembly: cs.temp.dll.dll
Syntax
public class TeleportPointer : CurvePointer, IMixedRealityTeleportPointer, IMixedRealityTeleportHandler, IEventSystemHandler

Fields

InvalidLayers

Declaration
protected LayerMask InvalidLayers
Field Value
Type Description
LayerMask

isTeleportRequestActive

Declaration
protected bool isTeleportRequestActive
Field Value
Type Description
Boolean

LineColorHotSpot

Declaration
protected Gradient LineColorHotSpot
Field Value
Type Description
Gradient

ValidLayers

Declaration
protected LayerMask ValidLayers
Field Value
Type Description
LayerMask

Properties

GravityDistorter

The Gravity Distorter that is affecting the BaseMixedRealityLineDataProvider attached to this pointer.

Declaration
public DistorterGravity GravityDistorter { get; }
Property Value
Type Description
DistorterGravity

IsInteractionEnabled

Declaration
public override bool IsInteractionEnabled { get; }
Property Value
Type Description
Boolean

PointerOrientation

Declaration
public float PointerOrientation { get; set; }
Property Value
Type Description
Single

TeleportHotSpot

Declaration
public IMixedRealityTeleportHotSpot TeleportHotSpot { get; set; }
Property Value
Type Description
IMixedRealityTeleportHotSpot

TeleportHotSpotCursorVisibility

Teleport pointer cursor visibility if pointer is focused on hotspot

Declaration
public bool TeleportHotSpotCursorVisibility { get; set; }
Property Value
Type Description
Boolean

TeleportInputAction

Teleport Pointer will only respond to input events for teleportation that match this MixedRealityInputAction

Declaration
public MixedRealityInputAction TeleportInputAction { get; }
Property Value
Type Description
MixedRealityInputAction

TeleportRequestRaised

True if a teleport request is being raised, false otherwise.

Declaration
public bool TeleportRequestRaised { get; }
Property Value
Type Description
Boolean

TeleportSurfaceResult

The result from the last raycast.

Declaration
public TeleportSurfaceResult TeleportSurfaceResult { get; }
Property Value
Type Description
TeleportSurfaceResult

Methods

GetLineGradient(TeleportSurfaceResult)

Declaration
protected Gradient GetLineGradient(TeleportSurfaceResult targetResult)
Parameters
Type Name Description
TeleportSurfaceResult targetResult
Returns
Type Description
Gradient

OnDisable()

Declaration
protected override void OnDisable()

OnEnable()

Declaration
protected override void OnEnable()

OnInputChanged(InputEventData<Vector2>)

Declaration
public override void OnInputChanged(InputEventData<Vector2> eventData)
Parameters
Type Name Description
InputEventData<Vector2> eventData

OnPostSceneQuery()

Declaration
public override void OnPostSceneQuery()

OnPreSceneQuery()

Declaration
public override void OnPreSceneQuery()

OnTeleportCanceled(TeleportEventData)

Raised when a teleport request has been canceled.

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

OnTeleportCompleted(TeleportEventData)

Raised when a teleport has successfully completed.

Declaration
public virtual 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 virtual void OnTeleportRequest(TeleportEventData eventData)
Parameters
Type Name Description
TeleportEventData eventData

OnTeleportStarted(TeleportEventData)

Raised when a teleport has started.

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

Reset()

Declaration
public override void Reset()

Start()

Declaration
protected override void Start()

Implements

IMixedRealityTeleportPointer
IEventSystemHandler