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

IMixedRealityTeleportHandler

IEventSystemHandler

LinePointer

Namespace: Microsoft.MixedReality.Toolkit.Teleport

Assembly: cs.temp.dll.dll

Syntax

public class TeleportPointer : CurvePointer, IMixedRealityTeleportPointer, IMixedRealityTeleportHandler, IEventSystemHandler, LinePointer

Fields

InvalidLayers

Declaration

protected LayerMask InvalidLayers

Field Value

Type	Description
LayerMask

InvalidLayers

Declaration

protected LayerMask InvalidLayers

Field Value

Type	Description
LayerMask

isTeleportRequestActive

Declaration

protected bool isTeleportRequestActive

Field Value

Type	Description
Boolean

isTeleportRequestActive

Declaration

protected bool isTeleportRequestActive

Field Value

Type	Description
Boolean

LineColorHotSpot

Declaration

protected Gradient LineColorHotSpot

Field Value

Type	Description
Gradient

LineColorHotSpot

Declaration

protected Gradient LineColorHotSpot

Field Value

Type	Description
Gradient

ValidLayers

Declaration

protected LayerMask ValidLayers

Field Value

Type	Description
LayerMask

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

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

IsInteractionEnabled

Declaration

public override bool IsInteractionEnabled { get; }

Property Value

Type	Description
Boolean

PointerOrientation

Declaration

public float PointerOrientation { get; set; }

Property Value

Type	Description
Single

PointerOrientation

Declaration

public float PointerOrientation { get; set; }

Property Value

Type	Description
Single

TeleportHotSpot

Declaration

public IMixedRealityTeleportHotSpot TeleportHotSpot { get; set; }

Property Value

Type	Description
IMixedRealityTeleportHotSpot

TeleportHotSpot

Declaration

public IMixedRealityTeleportHotSpot TeleportHotSpot { get; set; }

Property Value

Type	Description
IMixedRealityTeleportHotSpot

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

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

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

GetLineGradient(TeleportSurfaceResult)

Declaration

protected Gradient GetLineGradient(TeleportSurfaceResult targetResult)

Parameters

Type	Name	Description
TeleportSurfaceResult	targetResult

Returns

Type	Description
Gradient

OnDisable()

Declaration

protected override void OnDisable()

OnDisable()

Declaration

protected override void OnDisable()

OnEnable()

Declaration

protected override void OnEnable()

OnEnable()

Declaration

protected override void OnEnable()

OnInputChanged(InputEventData<Vector2>)

Declaration

public override void OnInputChanged(InputEventData<Vector2> eventData)

Parameters

Type	Name	Description
InputEventData<Vector2>	eventData

OnInputChanged(InputEventData<Vector2>)

Declaration

public override void OnInputChanged(InputEventData<Vector2> eventData)

Parameters

Type	Name	Description
InputEventData<Vector2>	eventData

OnPostSceneQuery()

Declaration

public override void OnPostSceneQuery()

OnPostSceneQuery()

Declaration

public override void OnPostSceneQuery()

OnPreSceneQuery()

Declaration

public override void OnPreSceneQuery()

OnPreSceneQuery()

Declaration

public override void OnPreSceneQuery()

OnTeleportCanceled(TeleportEventData)

Declaration

public virtual void OnTeleportCanceled(TeleportEventData eventData)

Parameters

Type	Name	Description
TeleportEventData	eventData

OnTeleportCanceled(TeleportEventData)

Declaration

public virtual void OnTeleportCanceled(TeleportEventData eventData)

Parameters

Type	Name	Description
TeleportEventData	eventData

OnTeleportCompleted(TeleportEventData)

Declaration

public virtual void OnTeleportCompleted(TeleportEventData eventData)

Parameters

Type	Name	Description
TeleportEventData	eventData

OnTeleportCompleted(TeleportEventData)

Declaration

public virtual void OnTeleportCompleted(TeleportEventData eventData)

Parameters

Type	Name	Description
TeleportEventData	eventData

OnTeleportRequest(TeleportEventData)

Declaration

public virtual void OnTeleportRequest(TeleportEventData eventData)

Parameters

Type	Name	Description
TeleportEventData	eventData

OnTeleportRequest(TeleportEventData)

Declaration

public virtual void OnTeleportRequest(TeleportEventData eventData)

Parameters

Type	Name	Description
TeleportEventData	eventData

OnTeleportStarted(TeleportEventData)

Declaration

public virtual void OnTeleportStarted(TeleportEventData eventData)

Parameters

Type	Name	Description
TeleportEventData	eventData

OnTeleportStarted(TeleportEventData)

Declaration

public virtual void OnTeleportStarted(TeleportEventData eventData)

Parameters

Type	Name	Description
TeleportEventData	eventData

Start()

Declaration

protected override void Start()

Start()

Declaration

protected override void Start()

Implements

IMixedRealityTeleportPointer

IMixedRealityTeleportHandler

IEventSystemHandler

LinePointer