Small World Engine API Reference - v0.78.00
    Preparing search index...

    Interface AxesHelperOptions

    Configuration options for the AxesHelper coordinate cross.

    interface AxesHelperOptions {
        headLength?: number;
        headRadius?: number;
        labelScale?: number;
        shaftRadius?: number;
        showLabels?: boolean;
        size?: number;
        xColor?: Color;
        yColor?: Color;
        zColor?: Color;
    }
    Index
    headLength? headRadius? labelScale? shaftRadius? showLabels? size? xColor? yColor? zColor?
    headLength?: number

    Length of the cone arrow tip. Defaults to size * 0.2.

    headRadius?: number

    Base radius of the cone arrow tip. Defaults to size * 0.05.

    labelScale?: number

    Billboard scale for the text labels. Defaults to size * 0.25.

    shaftRadius?: number

    Radius of the axis cylinder shaft. Defaults to size * 0.02.

    showLabels?: boolean

    Whether to show text labels ("X", "Y", "Z") at the axis tips. Defaults to true.

    size?: number

    Total length of each axis. Defaults to 1.0.

    xColor?: Color

    Neon color for the X-axis (+X, right). Defaults to #ff1744.

    yColor?: Color

    Neon color for the Y-axis (+Y, up). Defaults to #00e676.

    zColor?: Color

    Neon color for the Z-axis (+Z, forward/backward). Defaults to #00e5ff.

    Settings
    Member Visibility

    On This Page
    Properties