Gets the cursor minimum travel distance for a snap transition.
the volume owning the cursor.
Gets the cursor minimum visit time for a snap transition.
the volume owning the cursor.
Gets the cursor snap mode.
the volume owning the cursor.
Gets the gravity well blend time in seconds.
the volume owning the cursor.
Gets the gravity well max distance.
the volume owning the cursor.
Returns the current movement rate of the Eclipse Cursor.
the volume owning the cursor.
The move rate.
Gets the depth of the cursor plane along the Prism's Z axis.
the volume owning the cursor.
The plane depth.
Gets the Prism Position of the Eclipse Cursor.
the volume owning the cursor.
Position
Returns the scale of the Eclipse Cursor in scene units.
the volume owning the cursor.
The scale.
Gets the manual cursor state.
the volume owning the cursor.
Returns the enabled state of the Eclipse Cursor.
the volume owning the cursor.
Flag if the cursor is enabled or not.
Resets cursor defaults for scale and move rate based on Prism extents.
the volume owning the cursor to alter.
Resets the cursor state back to automatic based on hovered elements.
the volume owning the cursor to alter.
Sets the cursor minimum travel distance for a snap transition.
the volume owning the cursor to alter.
the minimum travel distance for a snap transition.
Sets the cursor minimum visit time for a snap transition.
the volume owning the cursor to alter.
the minimum visit time for a snap transition.
Sets the cursor snap mode.
the volume owning the cursor to alter.
true to enable, false to disable cursor snap
Sets the enabled state of the Eclipse Cursor.
the volume owning the cursor to alter.
Enabled flag.
Sets the gravity well blend time in seconds.
the volume owning the cursor to alter.
time in seconds
Sets the gravity well max distance.
the volume owning the cursor to alter.
gravity well max distance to set
Sets the movement rate of the Eclipse Cursor.
the volume owning the cursor to alter.
The movement rate of the cursor.
Sets the depth of the cursor plane along the Prism's Z axis.
prism for which to set the depth of cursor
The depth of the cursor plane.
Sets the scale of the Eclipse Cursor in scene units.
the volume owning the cursor to alter.
The scale of the cursor in scene units.
Sets the cursor start position for this Prism during initial Prism startup (one time only).
the volume owning the cursor to alter.
the startup cursor position.
Sets the cursor state manually.
the volume owning the cursor to alter.
cursor state to set
Manually transitions the cursor to a Panel.
Allows for a Panel to be transitioned to manually. The cursor will end up at the position specified by the Panel's cursor transition properties.
This call is intended to make occasional, logic based transitions to a Panel and cannot be used every frame to explicitly control cursor position.
the volume owning the cursor to alter.
panel to transition to
Generated using TypeDoc
Main entry point for interacting with the UiKit cursor.