Method setCursor

packages/plugin-worker/lib/events/EventSystem.ts:289–337

* Sets the current cursor mode, handling any callbacks or CSS style changes. * @param mode - cursor mode, a key from the cursorStyles dictionary

(mode: string)

   * @param mode - cursor mode, a key from the cursorStyles dictionary
   */
  public setCursor(mode: string): void {
    if (!mode) {
      mode = 'default';
    }
    let applyStyles = true;

    // offscreen canvas does not support setting styles, but cursor modes can be functions,
    // in order to handle pixi rendered cursors, so we can't bail
    if (globalThis.OffscreenCanvas && this.domElement instanceof OffscreenCanvas) {
      applyStyles = false;
    }
    // if the mode didn't actually change, bail early
    if (this._currentCursor === mode) {
      return;
    }
    this._currentCursor = mode;
    const style = this.cursorStyles[mode];

    // only do things if there is a cursor style for it
    if (style) {
      switch (typeof style) {
        case 'string':
          // string styles are handled as cursor CSS
          if (applyStyles) {
            this.domElement.style.cursor = style;
          }
          break;
        case 'function':
          // functions are just called, and passed the cursor mode
          style(mode);
          break;
        case 'object':
          // if it is an object, assume that it is a dictionary of CSS styles,
          // apply it to the interactionDOMElement
          if (applyStyles) {
            Object.assign(this.domElement.style, style);
          }
          break;
      }
    } else if (
      applyStyles &&
      typeof mode === 'string' &&
      !Object.prototype.hasOwnProperty.call(this.cursorStyles, mode)
    ) {
      // if it mode is a string (not a Symbol) and cursorStyles doesn't have any entry
      // for the mode, then assume that the dev wants it to be CSS for the cursor.
      this.domElement.style.cursor = mode;
    }
  }

  /**
   * The global pointer event.