deeptwins-engine-3d 0.1.65 → 0.1.66

package/dist/esm/material/GlobalVolumetricCloud.d.ts

@@ -0,0 +1,117 @@
+/// <reference path="../typings.d.ts" />
+import * as Cesium from 'deeptwins-cesium';
+import { MapContext } from '../map/Map';
+interface GlobalVolumetricCloudRgbColor {
+    r: number;
+    g: number;
+    b: number;
+}
+interface GlobalVolumetricCloudParams {
+    densityMultiplier: number;
+    detailStrength: number;
+    cloudSharpness: number;
+    rainClouds: number;
+    currentWindVectorWC: Cesium.Cartesian3;
+    cloudCover: number;
+    cloudHeight: number;
+    cloudThickness: number;
+    absoluteMaxDistance: number;
+    absorption: number;
+    windSpeedRatio: number;
+    scatteringCoefficient: number;
+    illuminationCoefficient: number;
+    cloudSeed: number;
+    cloudType: number;
+    cloudTurbulence: number;
+    cloudClumping: number;
+    cloudAnvil: number;
+    skyAmbientColor: string;
+    groundAmbientColor: string;
+    maxVisibleHeight: number;
+}
+type GlobalVolumetricCloudOptions = Partial<GlobalVolumetricCloudParams>;
+declare class GlobalVolumetricCloud {
+    _mapContext: MapContext | undefined;
+    uniforms: GlobalVolumetricCloudParams;
+    originalOptions: GlobalVolumetricCloudParams;
+    postProcessStage: Cesium.PostProcessStage | null;
+    skyAmbientColor3: GlobalVolumetricCloudRgbColor;
+    groundAmbientColor3: GlobalVolumetricCloudRgbColor;
+    constructor(map: any, options?: GlobalVolumetricCloudOptions);
+    getMap(): Cesium.Viewer | undefined;
+    private _cloneUniforms;
+    private _buildUniforms;
+    private _syncAmbientColors;
+    /**
+     * 初始化体积云系统
+     *
+     * 创建并配置体积云后处理阶段，设置所有着色器和uniforms参数。
+     * 这是内部方法，通常由构造函数自动调用。
+     *
+     * @private
+     */
+    private initialize;
+    /**
+     * 创建体积云的着色器代码
+     *
+     * 生成包含体积云渲染算法的完整GLSL着色器代码。
+     * 包括云密度计算、光照模型、阴影计算、相位函数等关键算法。
+     *
+     * @private
+     * @returns {string} 包含完整体积云渲染算法的GLSL着色器代码
+     */
+    private _createShader;
+    /**
+     * 获取真实星球半径 - 与原函数逻辑一致
+     * @private
+     * @returns {number} 星球半径
+     */
+    private _getRealPlanetRadius;
+    /**
+     * 更新体积云参数 - 确保所有原函数中的参数都能正确更新
+     * @param {Object} params - 要更新的参数对象
+     */
+    updateParameters(params: GlobalVolumetricCloudOptions): this;
+    /**
+     * 将十六进制颜色转换为RGB对象
+     * @private
+     * @param {string} hex - 十六进制颜色字符串
+     * @returns {Object} RGB对象
+     */
+    private _hexToRgb;
+    /**
+     * 重置体积云参数到初始状态
+     */
+    resetParameters(): this;
+    /**
+     * 显示体积云
+     *
+     * 启用后处理阶段，使体积云在场景中可见。
+     * 这是一个轻量级操作，只是启用现有的后处理效果。
+     */
+    show(): this;
+    /**
+     * 隐藏体积云
+     *
+     * 禁用后处理阶段，从场景中移除体积云效果。
+     * 这是一个轻量级操作，不会销毁资源，可以随时通过show()重新启用。
+     */
+    hide(): this;
+    /**
+     * 移除体积云并清理资源
+     *
+     * 从场景中完全移除体积云后处理阶段并释放相关资源。
+     * 调用此方法后，必须重新创建新的实例才能再次使用体积云功能。
+     */
+    destroy(): void;
+    /**
+     * 获取当前云参数
+     *
+     * 返回当前体积云系统的所有配置参数的副本。
+     * 可以用于检查当前设置或保存配置以便稍后恢复。
+     *
+     * @returns {Object} 当前云参数对象的副本，包含所有19个可配置参数
+     */
+    getParameters(): GlobalVolumetricCloudParams;
+}
+export default GlobalVolumetricCloud;