Options
All
  • Public
  • Public/Protected
  • All
V1.7
  • V1.6
  • V1.7
Menu

Class Cursor

Main entry point for interacting with the UiKit cursor.

Hierarchy

  • Cursor

Index

Constructors

Methods

Constructors

constructor

Methods

Static GetCursorSnapMinDistance

  • GetCursorSnapMinDistance(prism: Prism | null): number

  • Gets the cursor minimum travel distance for a snap transition.

    priv

    none

    Parameters

    • prism: Prism | null

      the volume owning the cursor.

    Returns number

Static GetCursorSnapMinTime

  • GetCursorSnapMinTime(prism: Prism | null): number

  • Gets the cursor minimum visit time for a snap transition.

    priv

    none

    Parameters

    • prism: Prism | null

      the volume owning the cursor.

    Returns number

Static GetCursorSnapMode

  • GetCursorSnapMode(prism: Prism | null): boolean

  • Gets the cursor snap mode.

    priv

    none

    Parameters

    • prism: Prism | null

      the volume owning the cursor.

    Returns boolean

Static GetGravityWellBlendTime

  • GetGravityWellBlendTime(prism: Prism | null): number

  • Gets the gravity well blend time in seconds.

    priv

    none

    Parameters

    • prism: Prism | null

      the volume owning the cursor.

    Returns number

Static GetGravityWellMaxDistance

  • GetGravityWellMaxDistance(prism: Prism | null): number

  • Gets the gravity well max distance.

    priv

    none

    Parameters

    • prism: Prism | null

      the volume owning the cursor.

    Returns number

Static GetMoveRate

  • GetMoveRate(prism: Prism | null): number

  • Returns the current movement rate of the Eclipse Cursor.

    priv

    none

    Parameters

    • prism: Prism | null

      the volume owning the cursor.

    Returns number

    The move rate.

Static GetPlaneDepth

  • GetPlaneDepth(prism: Prism | null): number

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

    priv

    none

    Parameters

    • prism: Prism | null

      the volume owning the cursor.

    Returns number

    The plane depth.

Static GetPosition

  • GetPosition(prism: Prism | null): [number, number, number]

  • Gets the Prism Position of the Eclipse Cursor.

    priv

    none

    Parameters

    • prism: Prism | null

      the volume owning the cursor.

    Returns [number, number, number]

    Position

Static GetScale

  • GetScale(prism: Prism | null): number

  • Returns the scale of the Eclipse Cursor in scene units.

    priv

    none

    Parameters

    • prism: Prism | null

      the volume owning the cursor.

    Returns number

    The scale.

Static GetState

Static IsEnabled

  • IsEnabled(prism: Prism | null): boolean

  • Returns the enabled state of the Eclipse Cursor.

    priv

    none

    Parameters

    • prism: Prism | null

      the volume owning the cursor.

    Returns boolean

    Flag if the cursor is enabled or not.

Static ResetDefaults

  • ResetDefaults(prism: Prism | null): void

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

    priv

    none

    Parameters

    • prism: Prism | null

      the volume owning the cursor to alter.

    Returns void

Static ResetState

  • ResetState(prism: Prism | null): void

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

    priv

    none

    Parameters

    • prism: Prism | null

      the volume owning the cursor to alter.

    Returns void

Static SetCursorSnapMinDistance

  • SetCursorSnapMinDistance(prism: Prism | null, distance: number): void

  • Sets the cursor minimum travel distance for a snap transition.

    priv

    none

    Parameters

    • prism: Prism | null

      the volume owning the cursor to alter.

    • distance: number

      the minimum travel distance for a snap transition.

    Returns void

Static SetCursorSnapMinTime

  • SetCursorSnapMinTime(prism: Prism | null, seconds: number): void

  • Sets the cursor minimum visit time for a snap transition.

    priv

    none

    Parameters

    • prism: Prism | null

      the volume owning the cursor to alter.

    • seconds: number

      the minimum visit time for a snap transition.

    Returns void

Static SetCursorSnapMode

  • SetCursorSnapMode(prism: Prism | null, snap: boolean): void

  • Sets the cursor snap mode.

    priv

    none

    Parameters

    • prism: Prism | null

      the volume owning the cursor to alter.

    • snap: boolean

      true to enable, false to disable cursor snap

    Returns void

Static SetEnabled

  • SetEnabled(prism: Prism | null, a_enabled: boolean): void

  • Sets the enabled state of the Eclipse Cursor.

    priv

    none

    Parameters

    • prism: Prism | null

      the volume owning the cursor to alter.

    • a_enabled: boolean

      Enabled flag.

    Returns void

Static SetGravityWellBlendTime

  • SetGravityWellBlendTime(prism: Prism | null, seconds: number): void

  • Sets the gravity well blend time in seconds.

    priv

    none

    Parameters

    • prism: Prism | null

      the volume owning the cursor to alter.

    • seconds: number

      time in seconds

    Returns void

Static SetGravityWellMaxDistance

  • SetGravityWellMaxDistance(prism: Prism | null, distance: number): void

  • Sets the gravity well max distance.

    priv

    none

    Parameters

    • prism: Prism | null

      the volume owning the cursor to alter.

    • distance: number

      gravity well max distance to set

    Returns void

Static SetMoveRate

  • SetMoveRate(prism: Prism | null, a_rate: number): void

  • Sets the movement rate of the Eclipse Cursor.

    priv

    none

    Parameters

    • prism: Prism | null

      the volume owning the cursor to alter.

    • a_rate: number

      The movement rate of the cursor.

    Returns void

Static SetPlaneDepth

  • SetPlaneDepth(prism: Prism | null, a_depth: number): void

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

    priv

    none

    Parameters

    • prism: Prism | null

      prism for which to set the depth of cursor

    • a_depth: number

      The depth of the cursor plane.

    Returns void

Static SetScale

  • SetScale(prism: Prism | null, a_scale: number): void

  • Sets the scale of the Eclipse Cursor in scene units.

    priv

    none

    Parameters

    • prism: Prism | null

      the volume owning the cursor to alter.

    • a_scale: number

      The scale of the cursor in scene units.

    Returns void

Static SetStartupPosition

  • SetStartupPosition(prism: Prism | null, position: [number, number] | Float32Array): void

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

    priv

    none

    Parameters

    • prism: Prism | null

      the volume owning the cursor to alter.

    • position: [number, number] | Float32Array

      the startup cursor position.

    Returns void

Static SetState

Static TransitionToPanel

  • TransitionToPanel(prism: Prism | null, panel: UiPanel | null): void

  • 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.

    priv

    none

    Parameters

    • prism: Prism | null

      the volume owning the cursor to alter.

    • panel: UiPanel | null

      panel to transition to

    Returns void

Generated using TypeDoc