IMixedRealityCursor Interface

Definition

Namespace:

Microsoft.MixedReality.Toolkit.Input

Assembly:

Microsoft.MixedReality.Toolkit.dll

Cursor Interface for handling input events and setting visibility.

public interface class IMixedRealityCursor : Microsoft::MixedReality::Toolkit::Input::IMixedRealityFocusChangedHandler, Microsoft::MixedReality::Toolkit::Input::IMixedRealityPointerHandler, Microsoft::MixedReality::Toolkit::Input::IMixedRealitySourceStateHandler, UnityEngine::EventSystems::IEventSystemHandler

public interface IMixedRealityCursor : Microsoft.MixedReality.Toolkit.Input.IMixedRealityFocusChangedHandler, Microsoft.MixedReality.Toolkit.Input.IMixedRealityPointerHandler, Microsoft.MixedReality.Toolkit.Input.IMixedRealitySourceStateHandler, UnityEngine.EventSystems.IEventSystemHandler

type IMixedRealityCursor = interface
    interface IMixedRealityFocusChangedHandler
    interface IEventSystemHandler
    interface IMixedRealitySourceStateHandler
    interface IMixedRealityPointerHandler

Public Interface IMixedRealityCursor
Implements IEventSystemHandler, IMixedRealityFocusChangedHandler, IMixedRealityPointerHandler, IMixedRealitySourceStateHandler

Derived

Microsoft.MixedReality.Toolkit.Input.BaseCursor

Implements

IMixedRealityFocusChangedHandler IMixedRealityPointerHandler IMixedRealitySourceStateHandler UnityEngine.EventSystems.IEventSystemHandler

Properties

DefaultCursorDistance	The maximum distance the cursor can be with nothing hit
GameObjectReference	Returns the IMixedRealityCursor's GameObject reference.
IsVisible	Is the cursor currently visible?
LocalScale	Local scale of the IMixedRealityCursor.
Pointer	The IMixedRealityPointer this IMixedRealityCursor is associated with.
Position	Position of the IMixedRealityCursor.
Rotation	Rotation of the IMixedRealityCursor.
SetVisibilityOnSourceDetected	Sets the visibility of the IMixedRealityCursor when the source is detected.
SurfaceCursorDistance	Surface distance to place the cursor off of the surface at

Methods

Destroy()	Utility method to destroy cursor dependencies (e.g. event subscriptions) in the system explicitly in the middle update loop. This is a "replacement" of Unity OnDestroy. Relying on Unity OnDestroy may cause event handler subscription to become invalid at the point of destroying.
OnBeforeFocusChange(FocusEventData)	Focus event that is raised before the focus is actually changed. (Inherited from IMixedRealityFocusChangedHandler)
OnFocusChanged(FocusEventData)	Focus event that is raised when the focused object is changed. (Inherited from IMixedRealityFocusChangedHandler)
OnPointerClicked(MixedRealityPointerEventData)	When a pointer clicked event is raised, this method is used to pass along the event data to the input handler. (Inherited from IMixedRealityPointerHandler)
OnPointerDown(MixedRealityPointerEventData)	When a pointer down event is raised, this method is used to pass along the event data to the input handler. (Inherited from IMixedRealityPointerHandler)
OnPointerDragged(MixedRealityPointerEventData)	Called every frame a pointer is down. Can be used to implement drag-like behaviors. (Inherited from IMixedRealityPointerHandler)
OnPointerUp(MixedRealityPointerEventData)	When a pointer up event is raised, this method is used to pass along the event data to the input handler. (Inherited from IMixedRealityPointerHandler)
OnSourceDetected(SourceStateEventData)	Raised when a source is detected. (Inherited from IMixedRealitySourceStateHandler)
OnSourceLost(SourceStateEventData)	Raised when a source is lost. (Inherited from IMixedRealitySourceStateHandler)
SetVisibility(Boolean)	Sets the visibility of the IMixedRealityCursor.