Class GenericPointer
Base Class for pointers that don't inherit from MonoBehaviour.
Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.Input
Assembly: cs.temp.dll.dll
Syntax
public abstract class GenericPointer : IMixedRealityPointer, IEqualityComparer
Constructors
GenericPointer(String, IMixedRealityInputSource)
Constructor.
Declaration
protected GenericPointer(string pointerName, IMixedRealityInputSource inputSourceParent)
Parameters
Type | Name | Description |
---|---|---|
String | pointerName | |
IMixedRealityInputSource | inputSourceParent |
Properties
BaseCursor
The pointer's cursor.
Declaration
public IMixedRealityCursor BaseCursor { get; set; }
Property Value
Type | Description |
---|---|
IMixedRealityCursor |
Controller
The pointer's current controller reference.
Declaration
public virtual IMixedRealityController Controller { get; set; }
Property Value
Type | Description |
---|---|
IMixedRealityController |
CursorModifier
The currently active cursor modifier.
Declaration
public ICursorModifier CursorModifier { get; set; }
Property Value
Type | Description |
---|---|
ICursorModifier |
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 virtual IMixedRealityInputSource InputSourceParent { get; protected set; }
Property Value
Type | Description |
---|---|
IMixedRealityInputSource |
IsActive
Declaration
public 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 bool IsInteractionEnabled { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
IsTargetPositionLockedOnFocusLock
Specifies whether the pointer's target position (cursor) is locked to the target object when focus is locked.
Declaration
public bool IsTargetPositionLockedOnFocusLock { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
PointerExtent
The pointer's maximum extent when raycasting.
Declaration
public virtual 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 abstract 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 abstract Quaternion Rotation { get; }
Property Value
Type | Description |
---|---|
Quaternion |
SceneQueryType
The type of physics scene query to use.
Declaration
public 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 |
TeleportHotSpot
Declaration
public IMixedRealityTeleportHotSpot TeleportHotSpot { get; set; }
Property Value
Type | Description |
---|---|
IMixedRealityTeleportHotSpot |
Methods
Equals(IMixedRealityPointer, IMixedRealityPointer)
Declaration
public static bool Equals(IMixedRealityPointer left, IMixedRealityPointer right)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityPointer | left | |
IMixedRealityPointer | right |
Returns
Type | Description |
---|---|
Boolean |
Equals(Object)
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
Object | obj |
Returns
Type | Description |
---|---|
Boolean |
Overrides
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
Int32 |
Overrides
OnPostSceneQuery()
Called after performing the scene query.
Declaration
public abstract void OnPostSceneQuery()
OnPreCurrentPointerTargetChange()
Called during the scene query just before the current pointer target changes.
Declaration
public abstract void OnPreCurrentPointerTargetChange()
OnPreSceneQuery()
Called before performing the scene query.
Declaration
public abstract void OnPreSceneQuery()
Reset()
Resets pointer to initial state. After invoked pointer should be functional and ready for re-use.
Declaration
public abstract void Reset()
Remarks
Useful for caching and recycling of pointers