MAIDR Documentation - v3.73.0
    Preparing search index...

    Type Alias PointerGuidanceState

    PointerGuidanceState:
        | { onCurve: true }
        | {
            onCurve: false;
            distancePx: number;
            curveVertical: "above" | "below";
            curveHorizontal: "left" | "right" | "center";
        }

    Directional guidance state for pointer/touch exploration near a curve.

    Position fields describe where the curve point sits relative to the cursor, so they line up directly with the audio output: curveVertical: 'above' plays a high pitch (point is up there), curveHorizontal: 'left' pans audio to the left (point is to the left). 'center' signals exact horizontal alignment so the resolver can drop pan to zero instead of choosing an arbitrary direction.

    Type Declaration

    • { onCurve: true }
    • {
          onCurve: false;
          distancePx: number;
          curveVertical: "above" | "below";
          curveHorizontal: "left" | "right" | "center";
      }
      • onCurve: false
      • distancePx: number

        Distance in screen pixels from pointer/finger to the nearest curve point center.

      • curveVertical: "above" | "below"

        Where the curve point sits vertically relative to the cursor.

      • curveHorizontal: "left" | "right" | "center"

        Where the curve point sits horizontally relative to the cursor.