ThreePresenter API Documentation - v0.1.2
    Preparing search index...

    Interface EnvironmentSettings

    Describes environment settings for the scene

    interface EnvironmentSettings {
        showGround?: boolean;
        background?: string;
        scaleIndicator?: {
            enabled?: boolean;
            unit?: string;
            rulerSize?: number;
            segments?: number;
            barHeight?: number;
            posX?: number;
            posZ?: number;
            lightColor?: number;
            darkColor?: number;
        };
    }
    Index

    Properties

    showGround? background? scaleIndicator?

    Properties

    showGround?: boolean

    Whether to show the ground grid

    background?: string

    Background color as hex string (e.g., "#404040")

    scaleIndicator?: {
        enabled?: boolean;
        unit?: string;
        rulerSize?: number;
        segments?: number;
        barHeight?: number;
        posX?: number;
        posZ?: number;
        lightColor?: number;
        darkColor?: number;
    }

    Scale indicator configuration for measuring objects

    Type Declaration

    • Optionalenabled?: boolean

      Whether to show the scale indicator ruler

    • Optionalunit?: string

      Unit label (e.g., 'meters', 'cm', 'inches')

    • OptionalrulerSize?: number

      Size of the ruler in world units

    • Optionalsegments?: number

      Number of checkerboard segments (default: 10)

    • OptionalbarHeight?: number

      Height of the bar (default: rulerSize/10)

    • OptionalposX?: number

      X position of the ruler on the ground

    • OptionalposZ?: number

      Z position of the ruler on the ground

    • OptionallightColor?: number

      Light square color (default: 0xffffff - white)

    • OptionaldarkColor?: number

      Dark square color (default: 0x000000 - black)

    Settings

    Member Visibility

    On This Page

    Properties