EN

IBackgroundPluginConfig

Core.IBackgroundPluginConfig exported from @manycore/aholo-viewer.

CoreInterface
interface IBackgroundPluginConfig {
enabled?: boolean;
up?: Vector3;
ground?: {
enabled?: boolean;
gridSize?: number;
gridGapSizeA?: number;
colorA?: Color;
lineWidthA?: number;
gridGapSizeB?: number;
colorB?: Color;
lineWidthB?: number;
isGroundColorEnabled?: boolean;
groundColor?: Color;
};
background?: {
active?: BackgroundMode;
basic?: IBasicBackgroundConfig;
envmap?: IEnvMapBackgroundConfig;
gradient?: IGradientBackgroundConfig;
sky?: ISkyBackgroundConfig;
};
}
enabled?: boolean
up?: Vector3

up for background rendering, will effect ground and background

  • enabled?: booleantrue

    enable ground grid

  • gridSize?: number1000000

    default ground grid size

  • gridGapSizeA?: number500

    grid A gap

  • colorA?: ColorColor(1.0, 1.0, 1.0)

    grid A color

  • lineWidthA?: number1

    grid A line width

  • gridGapSizeB?: number5000

    grid B gap

  • colorB?: ColorColor(1.0, 1.0, 1.0)

    grid B color

  • lineWidthB?: number1

    grid B line width

  • isGroundColorEnabled?: booleanfalse

    enable ground color shading, by default will only render noise for ground.

  • groundColor?: ColorColor(0.7, 0.7, 0.7)

    ground color