Interface SkyOptions

Sky options

Export

SkyOptions

Date

2024.3.1

Author

yisky

interface SkyOptions {
    atmosphereThickness?: number;
    cloudOptions?: CloudOptions;
    exposure?: number;
    groundTint?: ColorRepresentation;
    lookAt?: Vector3;
    moonOptions?: MoonOptions;
    nightEndHeight?: number;
    nightStartHeight?: number;
    onAfterRender?: ((renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry<NormalBufferAttributes>, material: Material, group: Group<Object3DEventMap>) => void);
    onBeforeRender?: ((renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry<NormalBufferAttributes>, material: Material, group: Group<Object3DEventMap>) => void);
    position?: Vector3;
    quaternion?: Quaternion;
    queryMask?: QueryMask;
    renderOrder?: RenderOrder;
    rotation?: Euler;
    scale?: Vector3;
    skyFadeEnd?: number;
    skyFadeStart?: number;
    skyTint?: ColorRepresentation;
    starOptions?: StarOptions;
    sunlightColor?: ColorRepresentation;
    sunlightDirection?: Vector3;
    sunMode?: SunMode;
    sunSize?: number;
    sunSizeConvergence?: number;
    userData?: {
        [key: string]: any;
    };
}

Hierarchy (view full)

Properties

atmosphereThickness? cloudOptions? exposure? groundTint? lookAt? moonOptions? nightEndHeight? nightStartHeight? onAfterRender? onBeforeRender? position? quaternion? queryMask? renderOrder? rotation? scale? skyFadeEnd? skyFadeStart? skyTint? starOptions? sunlightColor? sunlightDirection? sunMode? sunSize? sunSizeConvergence? userData?

Properties

OptionalatmosphereThickness

atmosphereThickness?: number

Atomsphere thickness

Memberof

SkyOptions

OptionalcloudOptions

cloudOptions?: CloudOptions

Cloud options

Memberof

SkyOptions

Optionalexposure

exposure?: number

Expsure

Memberof

SkyOptions

OptionalgroundTint

groundTint?: ColorRepresentation

Ground tint

Memberof

SkyOptions

OptionallookAt

lookAt?: Vector3

Rotates the object to face a point in world space.

Memberof

LightformerOptions

OptionalmoonOptions

moonOptions?: MoonOptions

Moon options

Memberof

SkyOptions

OptionalnightEndHeight

nightEndHeight?: number

Night end height, -0.2, range( -1.0, 1.0 )

Memberof

SkyOptions

OptionalnightStartHeight

nightStartHeight?: number

Night start height, -0.1, range( -1.0, 1.0 )

Memberof

SkyOptions

OptionalonAfterRender

onAfterRender?: ((renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry<NormalBufferAttributes>, material: Material, group: Group<Object3DEventMap>) => void)

After render callback

Memberof

RendererOptions

OptionalonBeforeRender

onBeforeRender?: ((renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry<NormalBufferAttributes>, material: Material, group: Group<Object3DEventMap>) => void)

Before render callback

Memberof

RendererOptions

Optionalposition

position?: Vector3

Local Position

Memberof

LightformerOptions

Optionalquaternion

quaternion?: Quaternion

Local quaternion

Memberof

RendererOptions

OptionalqueryMask

queryMask?: QueryMask

Query mask

Memberof

RendererOptions

OptionalrenderOrder

renderOrder?: RenderOrder

Render order

Memberof

RendererOptions

Optionalrotation

rotation?: Euler

Local rotation

Memberof

LightformerOptions

Optionalscale

scale?: Vector3

Local Scale

Memberof

LightformerOptions

OptionalskyFadeEnd

skyFadeEnd?: number

Sky fade end, -0.05, range( -1.0, 1.0 )

Memberof

SkyOptions

OptionalskyFadeStart

skyFadeStart?: number

Sky fade start, 0.05, range( -1.0, 1.0 )

Memberof

SkyOptions

OptionalskyTint

skyTint?: ColorRepresentation

Sky tint

Memberof

SkyOptions

OptionalstarOptions

starOptions?: StarOptions

Star options

Memberof

SkyOptions

OptionalsunlightColor

sunlightColor?: ColorRepresentation

Sunlight color

Memberof

SkyOptions

OptionalsunlightDirection

sunlightDirection?: Vector3

Sunlight direction, from the sun to sky

Memberof

SkyOptions

OptionalsunMode

sunMode?: SunMode

Sun mode

Memberof

SkyOptions

OptionalsunSize

sunSize?: number

Sun size

Memberof

SkyOptions

OptionalsunSizeConvergence

sunSizeConvergence?: number

Sun size convergence

Memberof

SkyOptions

OptionaluserData

userData?: {
    [key: string]: any;
}

The component user data, default is {}

Memberof

ComponentOptions

Settings

Member Visibility

On This Page

Properties