Class BaseControllerPointer

Base Pointer class for pointers that exist in the scene as GameObjects.

Inheritance
Object
InputSystemGlobalHandlerListener
ControllerPoseSynchronizer
BaseControllerPointer
BaseMousePointer
LinePointer
PokePointer
SpherePointer
TouchPointer
Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.Input
Assembly: cs.temp.dll.dll
Syntax
public abstract class BaseControllerPointer : ControllerPoseSynchronizer, IMixedRealityControllerPoseSynchronizer, IMixedRealitySourcePoseHandler, IMixedRealitySourceStateHandler, IMixedRealityInputHandler, IMixedRealityBaseInputHandler, IMixedRealityInputHandler<float>, IMixedRealityInputHandler<Vector2>, IMixedRealityInputHandler<Vector3>, IMixedRealityInputHandler<Quaternion>, IMixedRealityInputHandler<MixedRealityPose>, IEventSystemHandler, IMixedRealityPointer, IEqualityComparer

Fields

HasSelectPressedOnce

True if select has been pressed once since this component was enabled

Declaration
protected bool HasSelectPressedOnce
Field Value
Type Description
Boolean

IsHoldPressed

Declaration
protected bool IsHoldPressed
Field Value
Type Description
Boolean

IsSelectPressed

True if select is pressed right now

Declaration
protected bool IsSelectPressed
Field Value
Type Description
Boolean

pointerAction

Declaration
protected MixedRealityInputAction pointerAction
Field Value
Type Description
MixedRealityInputAction

raycastOrigin

Declaration
protected Transform raycastOrigin
Field Value
Type Description
Transform

Properties

BaseCursor

The pointer's cursor.

Declaration
public IMixedRealityCursor BaseCursor { get; set; }
Property Value
Type Description
IMixedRealityCursor

Controller

The current controller reference.

Declaration
public override IMixedRealityController Controller { get; set; }
Property Value
Type Description
IMixedRealityController
Overrides

CursorModifier

The currently active cursor modifier.

Declaration
public ICursorModifier CursorModifier { get; set; }
Property Value
Type Description
ICursorModifier

DefaultPointerExtent

The length of the pointer when nothing is hit.

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

DisableCursorOnStart

Declaration
protected bool DisableCursorOnStart { get; }
Property Value
Type Description
Boolean

FocusTarget

The currently focused target.

Declaration
public IMixedRealityFocusHandler FocusTarget { get; set; }
Property Value
Type Description
IMixedRealityFocusHandler

InputSourceParent

This pointer's input source parent.

Declaration
public IMixedRealityInputSource InputSourceParent { get; protected set; }
Property Value
Type Description
IMixedRealityInputSource

IsActive

Controls whether the pointer dispatches input..

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

IsFocusLocked

Is the focus for this pointer currently locked?

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

IsInteractionEnabled

Is the pointer active and have the conditions for the interaction been satisfied to enable the interaction?

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

IsTargetPositionLockedOnFocusLock

Specifies whether the pointer's target position (cursor) is locked to the target object when focus is locked. Most pointers want the cursor to "stick" to the object when manipulating, so set this to true by default.

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

PointerExtent

Maximum distance at which all pointers can collide with a GameObject, unless it has an override extent.

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

PointerId

This pointer's id.

Declaration
public uint PointerId { get; }
Property Value
Type Description
UInt32

PointerName

This pointer's name.

Declaration
public string PointerName { get; set; }
Property Value
Type Description
String

Position

Pointer position.

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

PrioritizedLayerMasksOverride

The physics layers to use when performing scene queries.

Declaration
public LayerMask[] PrioritizedLayerMasksOverride { get; set; }
Property Value
Type Description
LayerMask[]
Remarks

If set, will override the IMixedRealityInputSystem's default scene query layer mask array.

Rays

The scene query rays.

Declaration
public RayStep[] Rays { get; protected set; }
Property Value
Type Description
RayStep[]

RayStabilizer

Ray stabilizer used when calculating position of pointer end point.

Declaration
public IBaseRayStabilizer RayStabilizer { get; set; }
Property Value
Type Description
IBaseRayStabilizer

Result

The scene query pointer result.

Declaration
public IPointerResult Result { get; set; }
Property Value
Type Description
IPointerResult

Rotation

Pointer rotation.

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

SceneQueryType

The type of physics scene query to use.

Declaration
public virtual SceneQueryType SceneQueryType { get; set; }
Property Value
Type Description
SceneQueryType

SphereCastRadius

The radius to use when SceneQueryType is set to Sphere or SphereColliders.

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

Methods

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
Boolean

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32

OnDisable()

Declaration
protected override void OnDisable()
Overrides

OnEnable()

Declaration
protected override void OnEnable()
Overrides

OnInputDown(InputEventData)

Input Down updates from Interactions, Keys, or any other simple input.

Declaration
public override void OnInputDown(InputEventData eventData)
Parameters
Type Name Description
InputEventData eventData
Overrides

OnInputUp(InputEventData)

Input Up updates from Interactions, Keys, or any other simple input.

Declaration
public override void OnInputUp(InputEventData eventData)
Parameters
Type Name Description
InputEventData eventData
Overrides

OnPostSceneQuery()

Called after performing the scene query.

Declaration
public virtual void OnPostSceneQuery()

OnPreCurrentPointerTargetChange()

Called during the scene query just before the current pointer target changes.

Declaration
public virtual void OnPreCurrentPointerTargetChange()

OnPreSceneQuery()

Called before performing the scene query.

Declaration
public virtual void OnPreSceneQuery()

OnSourceLost(SourceStateEventData)

Raised when a source is lost.

Declaration
public override void OnSourceLost(SourceStateEventData eventData)
Parameters
Type Name Description
SourceStateEventData eventData
Overrides

Reset()

Resets pointer to initial state. After invoked pointer should be functional and ready for re-use.

Declaration
public virtual void Reset()
Remarks

Useful for caching and recycling of pointers

SetCursor(GameObject)

Set a new cursor for this IMixedRealityPointer

Declaration
public virtual void SetCursor(GameObject newCursor = null)
Parameters
Type Name Description
GameObject newCursor

The new cursor
Remarks

This GameObject must have a IMixedRealityCursor attached to it.

Start()

Declaration
protected override void Start()
Overrides

Implements

IEventSystemHandler
IEqualityComparer