@yituengine/keymap 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,148 @@
+# 易图引擎
+
+易图引擎是基于 `cesium@1.106` 二次封装的 3D GIS SDK，面向业务系统提供地图初始化、图层管理、图形标绘、编辑交互、绘制测量、右键菜单、特效和自定义 Primitive 等能力。
+
+当前包名：`@yituengine/keymap`。
+
+## 特性
+
+- `initMap()` 一行初始化 Cesium Viewer，并返回统一的 `KeyMap` 实例。
+- `GraphicLayer` 管理业务图形资产，支持统一显示、隐藏、销毁和资产索引。
+- `HeatmapLayer` 支持二维人流密度热力图，以固定地理范围承载实时权重点数据。
+- 内置 `BillboardGraphic`、`PolylineGraphic`、`PolygonGraphic`、`CircleGraphic`、`ModelGraphic`、`PopupGraphic` 和 `CustomPopupGraphic`。
+- 折线、多边形、点位支持 `showHandler()` / `clearHandler()` 进入和退出编辑模式。
+- `KeyMap` 默认注册悬停高亮、弹窗、编辑拖拽、控制点右键删除和全局右键菜单。
+- `DrawPoint`、`DrawPolyline`、`DrawPolygon`、`DrawCircle` 支持交互式绘制，并支持 `Escape` 取消当前绘制。
+- `MeasureDistance`、`MeasureArea`、`MeasureHeight`、`MeasureCutFill` 支持测量流程，并与绘制工具互斥。
+
+## 安装
+
+```bash
+npm install @yituengine/keymap
+```
+
+业务项目需要同时提供 Cesium 和 Vue 运行环境：
+
+```bash
+npm install cesium@1.106 vue@^3.2.0
+```
+
+## 快速开始
+
+页面中准备一个全尺寸 `div`：
+
+```html
+<div
+  id="map"
+  style="width: 100%; height: 100vh"
+></div>
+```
+
+初始化地图：
+
+```ts
+import { initMap } from '@yituengine/keymap';
+
+const map = initMap('map');
+
+map?.flyTo({
+  position: [113.2644, 23.1291, 3000],
+  duration: 2,
+});
+```
+
+添加图层和图形：
+
+```ts
+import * as Cesium from 'cesium';
+import { initMap, layer, graphic } from '@yituengine/keymap';
+
+const map = initMap('map');
+if (!map) throw new Error('地图容器不存在');
+
+const graphicLayer = new layer.GraphicLayer({ name: '业务标绘图层' });
+map.addLayer(graphicLayer);
+
+const billboard = new graphic.BillboardGraphic({
+  name: '项目位置',
+  position: Cesium.Cartesian3.fromDegrees(113.2644, 23.1291, 30),
+  image: '/icons/location.svg',
+  width: 32,
+  height: 32,
+});
+
+graphicLayer.addGraphic(billboard);
+```
+
+添加二维热力图：
+
+```ts
+import * as Cesium from 'cesium';
+import { initMap, layer } from '@yituengine/keymap';
+
+const map = initMap('map');
+if (!map) throw new Error('地图容器不存在');
+
+const heatmapLayer = new layer.HeatmapLayer({
+  name: '校园人流密度',
+  rectangle: Cesium.Rectangle.fromDegrees(113.26, 23.12, 113.29, 23.15),
+  min: 0,
+  max: 100,
+  points: [
+    { lng: 113.2644, lat: 23.1291, value: 80 },
+    { lng: 113.276, lat: 23.136, value: 45 },
+  ],
+});
+
+map.addLayer(heatmapLayer);
+heatmapLayer.setData([{ lng: 113.268, lat: 23.132, value: 95 }]);
+```
+
+## 文档
+
+- [指南首页](docs/guide/index.md)
+- [快速开始](docs/guide/quick-start.md)
+- [图层与图形](docs/guide/graphic.md)
+- [右键菜单](docs/guide/menu.md)
+- [绘制与测量](docs/guide/draw-measure.md)
+- API Reference：运行 `npm run doc` 后查看 `docs/api/index.html`
+
+## 公开模块
+
+```ts
+import { initMap, KeyMap, layer, graphic, draw, measure, eventType, material, effect, primitive } from '@yituengine/keymap';
+```
+
+| 模块        | 说明                                                    |
+| ----------- | ------------------------------------------------------- |
+| `initMap`   | 创建 Cesium Viewer 并返回 `KeyMap`。                    |
+| `KeyMap`    | 地图实例封装，管理 Viewer、图层、资产、事件和默认交互。 |
+| `layer`     | `GraphicLayer`、`TilesetLayer`、`HeatmapLayer`。        |
+| `graphic`   | 点、线、面、圆、模型、弹窗等图形资产。                  |
+| `draw`      | 点、线、面、圆交互绘制。                                |
+| `measure`   | 距离、面积、高度、挖填方测量。                          |
+| `eventType` | `Menu`、`MousePick` 等事件能力。                        |
+| `material`  | Cesium 材质封装。                                       |
+| `effect`    | 雨、雪、雾、云、镜头光晕等场景效果。                    |
+| `primitive` | 自定义 Primitive 能力。                                 |
+
+## 开发命令
+
+```bash
+npm run dev
+npm run typecheck
+npm run build:types
+npm run build
+npm run doc
+```
+
+`npm run build` 会先执行 Rollup 生产构建，再生成 `dist/types` 类型声明。`npm run doc` 使用 TypeDoc 从 `src/main.ts` 生成 API Reference 到 `docs/api`。
+
+## 发布前检查
+
+```bash
+npm run typecheck
+npm run build:types
+npm run doc
+npm pack --dry-run
+```