Cursor

lumin.ui. Cursor

Main entry point for interacting with the UiKit cursor.

Methods

(static) GetCursorSnapMinDistance(prism) → {number}

Gets the cursor minimum travel distance for a snap transition.

Parameters:
Name Type Description
prism lumin.Prism

the volume owning the cursor.

Returns:
Type
number

(static) GetCursorSnapMinTime(prism) → {number}

Gets the cursor minimum visit time for a snap transition.

Parameters:
Name Type Description
prism lumin.Prism

the volume owning the cursor.

Returns:
Type
number

(static) GetCursorSnapMode(prism) → {boolean}

Gets the cursor snap mode.

Parameters:
Name Type Description
prism lumin.Prism

the volume owning the cursor.

Returns:
Type
boolean

(static) GetGravityWellBlendTime(prism) → {number}

Gets the gravity well blend time in seconds.

Parameters:
Name Type Description
prism lumin.Prism

the volume owning the cursor.

Returns:
Type
number

(static) GetGravityWellMaxDistance(prism) → {number}

Gets the gravity well max distance.

Parameters:
Name Type Description
prism lumin.Prism

the volume owning the cursor.

Returns:
Type
number

(static) GetMoveRate(prism) → {number}

Returns the current movement rate of the Eclipse Cursor.

Parameters:
Name Type Description
prism lumin.Prism

the volume owning the cursor.

Returns:

The move rate.

Type
number

(static) GetPlaneDepth(prism) → {number}

Gets the depth of the cursor plane along the Prism's Z axis.

Parameters:
Name Type Description
prism lumin.Prism

the volume owning the cursor.

Returns:

The plane depth.

Type
number

(static) GetPosition(prism) → {vec3}

Gets the Prism Position of the Eclipse Cursor.

Parameters:
Name Type Description
prism lumin.Prism

the volume owning the cursor.

Returns:

Position

Type
vec3

(static) GetScale(prism) → {number}

Returns the scale of the Eclipse Cursor in scene units.

Parameters:
Name Type Description
prism lumin.Prism

the volume owning the cursor.

Returns:

The scale.

Type
number

(static) GetState(prism) → {lumin.CursorHoverState}

Gets the manual cursor state.

Parameters:
Name Type Description
prism lumin.Prism

the volume owning the cursor.

Returns:
Type
lumin.CursorHoverState

(static) IsEnabled(prism) → {boolean}

Returns the enabled state of the Eclipse Cursor.

Parameters:
Name Type Description
prism lumin.Prism

the volume owning the cursor.

Returns:

Flag if the cursor is enabled or not.

Type
boolean

(static) ResetDefaults(prism)

Resets cursor defaults for scale and move rate
based on Prism extents.

Parameters:
Name Type Description
prism lumin.Prism

the volume owning the cursor to alter.

(static) ResetState(prism)

Resets the cursor state back to automatic based on hovered elements.

Parameters:
Name Type Description
prism lumin.Prism

the volume owning the cursor to alter.

(static) SetCursorSnapMinDistance(prism, distance)

Sets the cursor minimum travel distance for a snap transition.

Parameters:
Name Type Description
prism lumin.Prism

the volume owning the cursor to alter.

distance number

the minimum travel distance for a snap transition.

(static) SetCursorSnapMinTime(prism, seconds)

Sets the cursor minimum visit time for a snap transition.

Parameters:
Name Type Description
prism lumin.Prism

the volume owning the cursor to alter.

seconds number

the minimum visit time for a snap transition.

(static) SetCursorSnapMode(prism, snap)

Sets the cursor snap mode.

Parameters:
Name Type Description
prism lumin.Prism

the volume owning the cursor to alter.

snap boolean

true to enable, false to disable cursor snap

(static) SetEnabled(prism, a_enabled)

Sets the enabled state of the Eclipse Cursor.

Parameters:
Name Type Description
prism lumin.Prism

the volume owning the cursor to alter.

a_enabled boolean

Enabled flag.

(static) SetGravityWellBlendTime(prism, seconds)

Sets the gravity well blend time in seconds.

Parameters:
Name Type Description
prism lumin.Prism

the volume owning the cursor to alter.

seconds number

time in seconds

(static) SetGravityWellMaxDistance(prism, distance)

Sets the gravity well max distance.

Parameters:
Name Type Description
prism lumin.Prism

the volume owning the cursor to alter.

distance number

gravity well max distance to set

(static) SetMoveRate(prism, a_rate)

Sets the movement rate of the Eclipse Cursor.

Parameters:
Name Type Description
prism lumin.Prism

the volume owning the cursor to alter.

a_rate number

The movement rate of the cursor.

(static) SetPlaneDepth(prism, a_depth)

Sets the depth of the cursor plane along the Prism's Z axis.

Parameters:
Name Type Description
prism lumin.Prism

prism for which to set the depth of cursor

a_depth number

The depth of the cursor plane.

(static) SetScale(prism, a_scale)

Sets the scale of the Eclipse Cursor in scene units.

Parameters:
Name Type Description
prism lumin.Prism

the volume owning the cursor to alter.

a_scale number

The scale of the cursor in scene units.

(static) SetStartupPosition(prism, position)

Sets the cursor start position for this Prism during
initial Prism startup (one time only).

Parameters:
Name Type Description
prism lumin.Prism

the volume owning the cursor to alter.

position vec2

the startup cursor position.

(static) SetState(prism, cursorState)

Sets the cursor state manually.

Parameters:
Name Type Description
prism lumin.Prism

the volume owning the cursor to alter.

cursorState lumin.CursorHoverState

cursor state to set

(static) TransitionToPanel(prism, panel)

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.

Parameters:
Name Type Description
prism lumin.Prism

the volume owning the cursor to alter.

panel lumin.ui.UiPanel

panel to transition to