SpatialMouseInteractorCursorVisual Class

Definition

Namespace:

MixedReality.Toolkit.Input.Experimental

Assembly:

MixedReality.Toolkit.Input.dll

The cursor visual for a spatial mouse interactor. This behavior takes care of positioning the cursor and hiding it when the mouse is not in use.

public class SpatialMouseInteractorCursorVisual : MixedReality.Toolkit.Input.BaseReticleVisual

type SpatialMouseInteractorCursorVisual = class
    inherit BaseReticleVisual

Public Class SpatialMouseInteractorCursorVisual
Inherits BaseReticleVisual

Inheritance

UnityEngine.MonoBehaviour

BaseReticleVisual

SpatialMouseInteractorCursorVisual

Remarks

This is an experimental feature. This class is early in the cycle, it has been labeled as experimental to indicate that it is still evolving, and subject to change over time. Parts of the MRTK, such as this class, appear to have a lot of value even if the details haven't fully been fleshed out. For these types of features, we want the community to see them and get value out of them early enough so to provide feedback.

Constructors

Name	Description
SpatialMouseInteractorCursorVisual()

Fields

Name	Description
mouseInteractor	The ray interactor which this visual represents.

Properties

Name	Description
BaseReticle	The reticle model to use when the interactable doesn't specify a custom one. (Inherited from BaseReticleVisual)
CustomReticle	Staging area for custom reticles that interactors can attach to show unique visuals. (Inherited from BaseReticleVisual)
CustomReticleAttached	Is there a custom reticle currently attached to this interactor? (Inherited from BaseReticleVisual)
Reticle	The current reticle that the interactor is using. (Inherited from BaseReticleVisual)
ReticleRoot	The root of the reticle visuals. (Inherited from BaseReticleVisual)
Visual	Cached reference to the IReticleVisual component on Reticle. (Inherited from BaseReticleVisual)

Methods

Name	Description
AttachCustomReticle(GameObject)	(Inherited from BaseReticleVisual)
OnDisable()	A Unity event function that is called when the script component has been disabled.
OnEnable()	A Unity event function that is called when the script component has been enabled.
RemoveCustomReticle()	(Inherited from BaseReticleVisual)