Luxar Viewer API Documentation - v2026.9.22
    Preparing search index...

    Function calculateStepSize

    • Calculate adaptive step size for dimension navigation.

      Computes the appropriate step size based on dimension metadata, keyboard modifiers, and navigation configuration. Step sizes adapt to:

      • Discrete dimensions (frames): Step by 1 or more whole units
      • Continuous dimensions (time): Step by 1% of range by default
      • Shift modifier: Fine control (10x smaller steps)
      • Ctrl modifier: Coarse control (10x larger steps)
      • Ctrl+Shift together: Extra-fine control (100x smaller steps)

      Parameters

      • dimIndex: number

        Zero-based index of dimension to navigate

      • dims: SimpleDims

        Complete dimension configuration including metadata

      • modifiers: { shift?: boolean; ctrl?: boolean; alt?: boolean } = {}

        Keyboard modifier state for fine/coarse control

      • config: NavigationConfig = DEFAULT_NAV_CONFIG

        Navigation configuration (step multipliers, etc.)

      • OptionaloverrideStep: number | null

        User-set per-dimension step (the animation menu's Step override). A finite positive value REPLACES the base derivation (authored step / 1% of range); modifiers and the discrete grid quantization still apply on top.

      Returns number

      Step size for navigation, guaranteed positive and at least one grid cell (meta.step, default 1) for discrete dims