IBackgroundPluginConfig
Core.IBackgroundPluginConfig exported from @manycore/aholo-viewer.
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;
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;
};
}
Properties
enabledtrue
enabled?: boolean
upVector3(0.0, 0.0, 1.0)
ground
enabled?: boolean
trueenable ground grid
gridSize?: number
1000000default ground grid size
gridGapSizeA?: number
500grid A gap
colorA?: Color
Color(1.0, 1.0, 1.0)grid A color
lineWidthA?: number
1grid A line width
gridGapSizeB?: number
5000grid B gap
colorB?: Color
Color(1.0, 1.0, 1.0)grid B color
lineWidthB?: number
1grid B line width
isGroundColorEnabled?: boolean
falseenable ground color shading, by default will only render noise for ground.
groundColor?: Color
Color(0.7, 0.7, 0.7)ground color
background
active?: BackgroundMode
BackgroundMode.BasicBackgroundbasic?: IBasicBackgroundConfig
basic color and texture active by
BackgroundMode.BasicBackgroundenvmap?: IEnvMapBackgroundConfig
sphere envmap active by
BackgroundMode.EnvMapBackgroundgradient?: IGradientBackgroundConfig
sphere gradient active by
BackgroundMode.GradientBackgroundsky?: ISkyBackgroundConfig
sky box active by
BackgroundMode.SkyBackground
up for background rendering, will effect ground and background