Interface IMixedRealityCursor
Cursor Interface for handling input events and setting visibility.
Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.Input
Assembly: cs.temp.dll.dll
Syntax
public interface IMixedRealityCursor : IMixedRealityFocusChangedHandler, IMixedRealitySourceStateHandler, IMixedRealityPointerHandler, IEventSystemHandlerProperties
DefaultCursorDistance
The maximum distance the cursor can be with nothing hit
Declaration
float DefaultCursorDistance { get; set; }Property Value
| Type | Description |
|---|---|
| Single |
GameObjectReference
Returns the IMixedRealityCursor's GameObject reference.
Declaration
GameObject GameObjectReference { get; }Property Value
| Type | Description |
|---|---|
| GameObject | The GameObject this IMixedRealityCursor component is attached to. |
IsVisible
Is the cursor currently visible?
Declaration
bool IsVisible { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
LocalScale
Local scale of the IMixedRealityCursor.
Declaration
Vector3 LocalScale { get; }Property Value
| Type | Description |
|---|---|
| Vector3 |
Pointer
The IMixedRealityPointer this IMixedRealityCursor is associated with.
Declaration
IMixedRealityPointer Pointer { get; set; }Property Value
| Type | Description |
|---|---|
| IMixedRealityPointer |
Position
Position of the IMixedRealityCursor.
Declaration
Vector3 Position { get; }Property Value
| Type | Description |
|---|---|
| Vector3 |
Rotation
Rotation of the IMixedRealityCursor.
Declaration
Quaternion Rotation { get; }Property Value
| Type | Description |
|---|---|
| Quaternion |
SetVisibilityOnSourceDetected
Sets the visibility of the IMixedRealityCursor when the source is detected.
Declaration
bool SetVisibilityOnSourceDetected { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
SurfaceCursorDistance
Surface distance to place the cursor off of the surface at
Declaration
float SurfaceCursorDistance { get; }Property Value
| Type | Description |
|---|---|
| Single |
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.
Declaration
void Destroy()SetVisibility(Boolean)
Sets the visibility of the IMixedRealityCursor.
Declaration
void SetVisibility(bool visible)Parameters
| Type | Name | Description |
|---|---|---|
| Boolean | visible | True if cursor should be visible, false if not. |