Interface IPointerPreferences

Provides interface for getting and setting behaviors and possible other settings for pointers in the input system. Behaviors are described based on pointer type and input type, not per pointer. This is to ensure that new pointers that appear maintain consistent behavior.

Namespace: Microsoft.MixedReality.Toolkit.Input

Assembly: cs.temp.dll.dll

Syntax

public interface IPointerPreferences

Properties

GazePointerBehavior

Pointer behavior for the gaze pointer. We make gaze pointer unique because the internal gaze pointer actually cannot be referenced from here since it's an internal class.

Declaration

PointerBehavior GazePointerBehavior { get; set; }

Property Value

Type	Description
PointerBehavior

GazePointerBehavior

Pointer behavior for the gaze pointer. We make gaze pointer unique because the internal gaze pointer actually cannot be referenced from here since it's an internal class.

Declaration

PointerBehavior GazePointerBehavior { get; set; }

Property Value

Type	Description
PointerBehavior

Methods

GetPointerBehavior(IMixedRealityPointer)

Gets the PointerBehavior for a given pointer

Declaration

PointerBehavior GetPointerBehavior(IMixedRealityPointer pointer)

Parameters

Type	Name	Description
IMixedRealityPointer	pointer

Returns

Type	Description
PointerBehavior

GetPointerBehavior(IMixedRealityPointer)

Gets the PointerBehavior for a given pointer

Declaration

PointerBehavior GetPointerBehavior(IMixedRealityPointer pointer)

Parameters

Type	Name	Description
IMixedRealityPointer	pointer

Returns

Type	Description
PointerBehavior

GetPointerBehavior<T>(Handedness, InputSourceType)

Gets the PointerBehavior for a given pointer type, handedness, and input type

Declaration

PointerBehavior GetPointerBehavior<T>(Handedness handedness, InputSourceType sourceType)

    where T : class, IMixedRealityPointer

Parameters

Type	Name	Description
Handedness	handedness	Specify Handedness.Any to apply to all handedness, or specify a specific handedness to just disable, right, left.
InputSourceType	sourceType	Allows specification of pointer behavior per input source, so that pointers can be disabled for hands but not controllers, and vice versa.

Returns

Type	Description
PointerBehavior

Type Parameters

Name	Description
T	All pointers that are of this type, or a subclass of this type, will have the given behavior

GetPointerBehavior<T>(Handedness, InputSourceType)

Gets the PointerBehavior for a given pointer type, handedness, and input type

Declaration

PointerBehavior GetPointerBehavior<T>(Handedness handedness, InputSourceType sourceType)

    where T : class, IMixedRealityPointer

Parameters

Type	Name	Description
Handedness	handedness	Specify Handedness.Any to apply to all handedness, or specify a specific handedness to just disable, right, left.
InputSourceType	sourceType	Allows specification of pointer behavior per input source, so that pointers can be disabled for hands but not controllers, and vice versa.

Returns

Type	Description
PointerBehavior

Type Parameters

Name	Description
T	All pointers that are of this type, or a subclass of this type, will have the given behavior

SetPointerBehavior<T>(Handedness, InputSourceType, PointerBehavior)

Sets the PointerBehavior for a given pointer type, handedness, and input type

Declaration

void SetPointerBehavior<T>(Handedness handedness, InputSourceType inputType, PointerBehavior pointerBehavior)

    where T : class, IMixedRealityPointer

Parameters

Type	Name	Description
Handedness	handedness	Specify Handedness.Any to apply to all handedness, or specify a specific handedness to just disable, right, left.
InputSourceType	inputType
PointerBehavior	pointerBehavior

Type Parameters

Name	Description
T	All pointers that are of this type, or a subclass of this type, will have the given behavior

SetPointerBehavior<T>(Handedness, InputSourceType, PointerBehavior)

Sets the PointerBehavior for a given pointer type, handedness, and input type

Declaration

void SetPointerBehavior<T>(Handedness handedness, InputSourceType inputType, PointerBehavior pointerBehavior)

    where T : class, IMixedRealityPointer

Parameters

Type	Name	Description
Handedness	handedness	Specify Handedness.Any to apply to all handedness, or specify a specific handedness to just disable, right, left.
InputSourceType	inputType
PointerBehavior	pointerBehavior

Type Parameters

Name	Description
T	All pointers that are of this type, or a subclass of this type, will have the given behavior