@metagl/sdk-render 0.0.1

package/README.md

@@ -0,0 +1,172 @@
+# 地图SDK - 三维地球渲染引擎
+
+![渲染引擎预览](./RenderPreview.png)
+
+## 项目简介
+
+地图SDK是一个基于Cesium的三维地球渲染引擎，提供了丰富的地图操作和数据分析功能。它采用模块化架构，包含多个功能系统，支持地图加载、图层管理、建筑模型展示、测量工具、3D Tiles搜索等功能。
+
+## 核心特性
+
+### 地图渲染
+- 支持多种地图数据源
+- 提供丰富的地图渲染配置选项
+- 支持地图切换和底图控制
+
+### 图层管理
+- 支持影像图层、地形图层、3D Tiles图层等多种类型
+- 提供图层可见性、透明度控制
+- 支持图层添加、移除和查找
+
+### 建筑模型展示
+- 支持加载城市建筑模型
+- 提供城市数据搜索功能
+- 显示生产区域和建筑边界
+
+### 测量工具
+- 直线距离测量
+- 贴地距离测量
+- 面积测量
+- 高度测量
+- 方位测量
+
+### 3D Tiles搜索
+- 属性查询功能
+- 对象高亮显示
+- 3D Tiles模型加载和操作
+
+### 场景控制
+- 地图定位和飞行
+- 场景状态管理
+- 环境特效控制
+
+## 快速开始
+
+### 安装
+
+```bash
+npm install @metagl/sdk-render
+```
+
+### 初始化
+
+```typescript
+import { Render, RenderConfig } from '@metagl/sdk-render';
+import { Viewer } from 'cesium';
+
+// 初始化 Cesium Viewer
+const container = document.getElementById('cesiumContainer');
+const viewer = new Viewer(container);
+
+// 配置渲染引擎
+const config: RenderConfig = {
+    viewer: viewer,
+    token: 'your-access-token'  // 访问 LACDT 资源的 token（必填）
+};
+
+// 初始化渲染引擎
+const render = new Render(config);
+```
+
+**Token 说明**：
+- `token` 是访问 LACDT 资源的必填参数
+
+### 基本使用
+
+```typescript
+// 更新系统配置
+render.updateSystemConfig('lighting', {
+    intensity: 1.2,
+    color: Cesium.Color.YELLOW
+});
+
+// 启用系统
+render.enableSystem('lighting');
+
+// 禁用系统
+render.disableSystem('lighting');
+
+// 切换系统状态
+render.toggleSystem('volumetricClouds');
+
+// 获取系统配置
+const lightingConfig = render.getSystemConfig('lighting');
+console.log('Lighting config:', lightingConfig);
+
+// 获取系统状态
+const shadowStatus = render.getSystemStatus('shadow');
+console.log('Shadow status:', shadowStatus);
+
+// 应用环境预设配置
+render.applyPresetConfig({
+    time: { hour: 12, minute: 0 },
+    lighting: {
+        enabled: true,
+        intensity: 1.5,
+        ambientIntensity: 0.3,
+        followSun: true
+    },
+    shadow: {
+        enabled: true,
+        darkness: 0.3,
+        softShadows: true
+    },
+    atmosphere: {
+        enabled: true,
+        intensity: 1.0,
+        rayleighIntensity: 1.0,
+        mieIntensity: 0.5,
+        absorptionIntensity: 0.5
+    },
+    clouds: {
+        enabled: true,
+        cover: 0.5,
+        base: 2000,
+        top: 6000,
+        lightIntensity: 5.3,
+        windSpeed: 5
+    },
+    fog: {
+        enabled: true,
+        type: 'distance' // 'distance' | 'height' | 'both'
+    },
+    postProcessing: {
+        enabled: true,
+        brightness: 1.0,
+        contrast: 1.0,
+        saturation: 1.0,
+        gamma: 1.0
+    }
+});
+
+// 获取调试信息
+const debugInfo = render.getDebugInfo();
+console.log('Debug info:', debugInfo);
+```
+
+## 系统架构
+
+SDK渲染引擎采用模块化架构，包含以下系统：
+
+### 渲染系统
+- **光照系统**：负责管理场景的光照
+- **阴影系统**：负责管理场景的阴影
+- **大气散射系统**：负责管理大气散射效果
+- **距离雾系统**：负责管理距离雾效果
+- **高度雾系统**：负责管理高度雾效果
+- **体积云系统**：负责管理体积云效果
+- **后处理系统**：负责管理后处理效果
+- **水体系统**：负责管理水体效果
+
+### 业务系统
+- **场景系统**：处理地名搜索和瓦片号查询定位的业务逻辑
+- **建筑系统**：负责管理和加载城市建筑模型
+- **图层系统**：负责管理Cesium场景中的各种图层以及实体和图元对象
+- **工具箱系统**：管理和执行各种工具，包含测量工具、地理数据处理工具等
+- **测量系统**：用于在三维场景中进行各种测量操作
+- **3DTiles搜索系统**：处理3D Tiles模型搜索和信息展示
+
+## 联系方式
+
+- **官方文档**：https://sdk.geovisearth.com/
+- **邮箱支持**：sunyc@geovis.com.cn

package/README_EN.md

@@ -0,0 +1,172 @@
+# Map SDK - 3D Earth Rendering Engine
+
+![Rendering Engine Preview](./RenderPreview.png)
+
+## Project Introduction
+
+The Map SDK is a 3D Earth rendering engine based on Cesium, providing rich map operations and data analysis capabilities. It adopts a modular architecture with multiple functional systems, supporting map loading, layer management, building model display, measurement tools, 3D Tiles search, and more.
+
+## Core Features
+
+### Map Rendering
+- Support for multiple map data sources
+- Rich map rendering configuration options
+- Map switching and base map control
+
+### Layer Management
+- Support for image layers, terrain layers, 3D Tiles layers, and more
+- Layer visibility and transparency control
+- Layer addition, removal, and search
+
+### Building Model Display
+- Support for loading city building models
+- City data search functionality
+- Display of production areas and building boundaries
+
+### Measurement Tools
+- Straight-line distance measurement
+- Ground-adhering distance measurement
+- Area measurement
+- Height measurement
+- Azimuth measurement
+
+### 3D Tiles Search
+- Attribute query functionality
+- Object highlighting display
+- 3D Tiles model loading and operation
+
+### Scene Control
+- Map positioning and flight
+- Scene state management
+- Environmental effect control
+
+## Quick Start
+
+### Installation
+
+```bash
+npm install @metagl/sdk-render
+```
+
+### Initialization
+
+```typescript
+import { Render, RenderConfig } from '@metagl/sdk-render';
+import { Viewer } from 'cesium';
+
+// Initialize Cesium Viewer
+const container = document.getElementById('cesiumContainer');
+const viewer = new Viewer(container);
+
+// Configure rendering engine
+const config: RenderConfig = {
+    viewer: viewer,
+    token: 'your-access-token'  // Token for accessing LACDT resources (required)
+};
+
+// Initialize rendering engine
+const render = new Render(config);
+```
+
+**Token Description**:
+- `token` is a required parameter for accessing LACDT resources
+
+### Basic Usage
+
+```typescript
+// Update system configuration
+render.updateSystemConfig('lighting', {
+    intensity: 1.2,
+    color: Cesium.Color.YELLOW
+});
+
+// Enable system
+render.enableSystem('lighting');
+
+// Disable system
+render.disableSystem('lighting');
+
+// Toggle system state
+render.toggleSystem('volumetricClouds');
+
+// Get system configuration
+const lightingConfig = render.getSystemConfig('lighting');
+console.log('Lighting config:', lightingConfig);
+
+// Get system status
+const shadowStatus = render.getSystemStatus('shadow');
+console.log('Shadow status:', shadowStatus);
+
+// Apply environment preset configuration
+render.applyPresetConfig({
+    time: { hour: 12, minute: 0 },
+    lighting: {
+        enabled: true,
+        intensity: 1.5,
+        ambientIntensity: 0.3,
+        followSun: true
+    },
+    shadow: {
+        enabled: true,
+        darkness: 0.3,
+        softShadows: true
+    },
+    atmosphere: {
+        enabled: true,
+        intensity: 1.0,
+        rayleighIntensity: 1.0,
+        mieIntensity: 0.5,
+        absorptionIntensity: 0.5
+    },
+    clouds: {
+        enabled: true,
+        cover: 0.5,
+        base: 2000,
+        top: 6000,
+        lightIntensity: 5.3,
+        windSpeed: 5
+    },
+    fog: {
+        enabled: true,
+        type: 'distance' // 'distance' | 'height' | 'both'
+    },
+    postProcessing: {
+        enabled: true,
+        brightness: 1.0,
+        contrast: 1.0,
+        saturation: 1.0,
+        gamma: 1.0
+    }
+});
+
+// Get debug information
+const debugInfo = render.getDebugInfo();
+console.log('Debug info:', debugInfo);
+```
+
+## System Architecture
+
+The SDK rendering engine adopts a modular architecture, including the following systems:
+
+### Rendering Systems
+- **Lighting System**: Manages scene lighting
+- **Shadow System**: Manages scene shadows
+- **Atmospheric Scattering System**: Manages atmospheric scattering effects
+- **Distance Fog System**: Manages distance fog effects
+- **Height Fog System**: Manages height fog effects
+- **Volumetric Clouds System**: Manages volumetric cloud effects
+- **Post-Processing System**: Manages post-processing effects
+- **Water System**: Manages water body effects
+
+### Business Systems
+- **Scene System**: Handles place name search and tile number query positioning business logic
+- **Building System**: Manages and loads city building models
+- **Layer System**: Manages various layers, entities, and primitives in the Cesium scene
+- **Toolbox System**: Manages and executes various tools, including measurement tools, geographic data processing tools, etc.
+- **Measurement System**: Performs various measurement operations in 3D scenes
+- **3DTiles Search System**: Handles 3D Tiles model search and information display
+
+## Contact Information
+
+- **Official Documentation**: https://sdk.geovisearth.com/
+- **Email Support**: sunyc@geovis.com.cn