Class CursorViewModel

Private_cursorPosition

Private Optional_interactor

Privatecamera

PrivatecurrentInteractable

PrivatecurrentInteractableUnsubscribeCallback

PrivatecurrentManipulation

PrivatecursorDistance

PrivatedistanceCancelSet

PrivateenableCursorHolding

PrivateenableFilter

Privatefilter

PrivatehandProvider

PrivateinteractionConfigurationProvider

PrivateinteractionManager

PrivateisAnimating

PrivateisScrolling

Privatelog

PrivateonCursorUpdateEvent

PrivateonStateChangeEvent

PrivatescrollView

PrivatestateMachine

Privateinteractor

• get interactor(): Interactor

  Returns Interactor

PrivateanimateCursorDistance

• animateCursorDistance(
      distance: number,
      easing:
          | "linear"
          | "ease-in-sine"
          | "ease-out-sine"
          | "ease-in-out-sine"
          | "ease-in-quad"
          | "ease-out-quad"
          | "ease-in-out-quad"
          | "ease-in-cubic"
          | "ease-out-cubic"
          | "ease-in-out-cubic"
          | "ease-in-quart"
          | "ease-out-quart"
          | "ease-in-out-quart"
          | "ease-in-quint"
          | "ease-out-quint"
          | "ease-in-out-quint"
          | "ease-in-expo"
          | "ease-out-expo"
          | "ease-in-out-expo"
          | "ease-in-circ"
          | "ease-out-circ"
          | "ease-in-out-circ"
          | "ease-in-back"
          | "ease-out-back"
          | "ease-in-out-back"
          | "ease-in-elastic"
          | "ease-out-elastic"
          | "ease-in-out-elastic"
          | "ease-in-bounce"
          | "ease-out-bounce"
          | "ease-in-out-bounce"
          | "ease-out-back-cubic"
          | "ease-in-back-cubic"
          | "ease-in-out-back-cubic",
      duration: number,
  ): void

  Parameters

  • distance: number
  • easing:
        | "linear"
        | "ease-in-sine"
        | "ease-out-sine"
        | "ease-in-out-sine"
        | "ease-in-quad"
        | "ease-out-quad"
        | "ease-in-out-quad"
        | "ease-in-cubic"
        | "ease-out-cubic"
        | "ease-in-out-cubic"
        | "ease-in-quart"
        | "ease-out-quart"
        | "ease-in-out-quart"
        | "ease-in-quint"
        | "ease-out-quint"
        | "ease-in-out-quint"
        | "ease-in-expo"
        | "ease-out-expo"
        | "ease-in-out-expo"
        | "ease-in-circ"
        | "ease-out-circ"
        | "ease-in-out-circ"
        | "ease-in-back"
        | "ease-out-back"
        | "ease-in-out-back"
        | "ease-in-elastic"
        | "ease-out-elastic"
        | "ease-in-out-elastic"
        | "ease-in-bounce"
        | "ease-out-bounce"
        | "ease-in-out-bounce"
        | "ease-out-back-cubic"
        | "ease-in-back-cubic"
        | "ease-in-out-back-cubic"
  • duration: number

  Returns void

PrivatecalculateCursorScale

• calculateCursorScale(): number

  Returns number

PrivatecancelAnimation

• cancelAnimation(): void

  Cancel the existing animation and set the isAnimating boolean to false, allowing other functions (getFarFieldCursorPosition and getHeldCursorPosition) to modify cursorDistance to jump the cursor to the Interactable object

  Returns void

PrivatecheckPlanecastWithinScrollView

• checkPlanecastWithinScrollView(): boolean

  Returns boolean

PrivatecheckScrollable

• checkScrollable(sceneObject: SceneObject): boolean

  Parameters

  • sceneObject: SceneObject

  Returns boolean

PrivatecheckVisibleTargetingState

• checkVisibleTargetingState(): boolean

  Returns boolean

PrivategetFarFieldCursorPosition

• getFarFieldCursorPosition(): vec3

  Calculates the position of the cursor based on the center of the targeting ray.

  Returns vec3

  the position of the cursor, or null if not applicable

PrivategetHeldCursorPosition

• getHeldCursorPosition(): vec3

  Returns the held cursor position, where it's stuck to the center of target when currently selecting, or the hit position otherwise.

  Returns vec3

  the position of the held cursor, with the regular far field cursor position or null as a fallback if the target hit position cannot be found.

PrivategetPlanecastCursorPosition

• getPlanecastCursorPosition(): vec3

  Returns vec3

PrivatesetupStateMachine

• setupStateMachine(): void

  Returns void

PrivateshouldCursorHold

• shouldCursorHold(): boolean

  Returns boolean

  if the cursor should be held to the hit position. During manipulation, since the interactor is assumed to be triggered, we hold the cursor to maintain local offset.

PrivateshouldFilter

• shouldFilter(): boolean

  Returns boolean

PrivateupdateIndirectCursorPosition

• updateIndirectCursorPosition(interactionStrength: number, position: vec3): void

  When in indirect interaction mode while targeting an Interactable, positions to interaction hit point if snapping. If there is no origin, then hide the cursor instead.

  Parameters

  • interactionStrength: number
  • position: vec3

  Returns void