# cesium2s

**Repository Path**: cesium-developer/cesium2s

## Basic Information

- **Project Name**: cesium2s
- **Description**: 可能是最好用的开源cesium-sdk
- **Primary Language**: Unknown
- **License**: ISC
- **Default Branch**: dev
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 2
- **Created**: 2025-11-22
- **Last Updated**: 2025-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# cesium2s 

----

[![npm version](https://img.shields.io/npm/v/cesium2s.svg)](https://www.npmjs.com/package/cesium2s)[![npm downloads](https://img.shields.io/npm/dm/cesium2s.svg)](https://www.npmjs.com/package/cesium2s)[![GitHub stars](https://img.shields.io/github/stars/spring-fisher/cesium2s.svg?style=social)](https://github.com/spring-fisher/cesium2s)[![GitHub issues](https://img.shields.io/github/issues/spring-fisher/cesium2s.svg)](https://github.com/spring-fisher/cesium2s/issues)[![Bundle size](https://img.shields.io/bundlephobia/minzip/cesium2s)](https://bundlephobia.com/package/cesium2s)[![License: GPL-2.0](https://img.shields.io/badge/license-GPL--2.0-blue.svg)](./LICENSE)

**cesium2s是一个基于Cesium的应用级SDK，让你用更少的代码构建复杂的三维地球应用。**

---

## ✨ 主要特性

- 简化的 `Viewer` 初始化与管理
- 交互式绘图工具（点/线/面/箭头/样条/贝塞尔/矩形）
- 测量工具（距离 / 面积 / 三角测量）
- 相机漫游（键盘控制、路径录制与回放）
- 地形开挖与自定义材质支持
- 常用工具集：坐标转换、GeoJSON 转换、曲线算法等
- 继承自原生Viewer，对原生API的完全支持

---

## 🚀 快速开始

安装（包含 peerDependency 说明）：

```bash
npm install cesium2s
# 注意：本库将 `cesium` 声明为 peer dependency，需要在项目中另外安装 Cesium，兼容版本为1.109及更新的版本
npm install cesium
```

在 Vue 3 中的最简示例：

```vue
<template>
  <div ref="globe" style="width:100vw;height:100vh"></div>
</template>

<script setup lang="ts">
import { onMounted, ref } from 'vue'
import type { Ref } from 'vue'
import { Viewer } from 'cesium2s'

const globe: Ref<HTMLElement | null> = ref(null)

onMounted(() => {
  if (!globe.value) return
  const cesium2s = new Viewer(globe.value, {
    // baseLayer: 自定义 ImageryProvider
  })
})
</script>
```

---

## 🤝 贡献

欢迎任何形式的贡献（代码、文档、测试、Issue 报告）。主要流程：

1. 在 Issue 中提出需求或认领任务。
2. Fork 仓库并创建分支（`feature/<name>` 或 `fix/<issue-number>`）。
3. 实现、运行测试并格式化代码（`npm run format`）。
4. 提交 PR，描述修改内容并关联 Issue。

更多细节请参见：`CONTRIBUTING.md`

---

## 📄 许可证

本项目采用 **ISC License**。

简要说明：允许自由使用、复制、修改与分发，只需在分发的副本中保留版权与许可声明；软件按“原样”提供，不承担任何形式的担保或责任。

完整条款见根目录 `LICENSE` 文件。

---

## 🌐 维护者与社区

- Issues 跟踪：https://gitee.com/organizations/cesium-developer/issues
- 交流渠道：
  + 管理员微信：h1770195547
  + 邮箱：giser3d@163.com，cyanfish.site@qq.com，

---

## 🙏 致谢

感谢 CesiumJS、Turf.js 等开源项目提供的基础能力与灵感。

----

文档更新日期：2025-11-23