Cesium-如何使用 Sandcastle

前言

这是一篇关于Sandcastle的简介,它是一个实时编码应用程序,可以快速查看Cesium样例和测试代码。 Cesium团队开发中经常使用Sandcastle,此后,我们也希望你也能够使用并能够帮助你!
Sandcastle 提供了一个 Cesium Viewer widget和一个代码编辑器。要修改样例,只需编辑代码,然后单击窗口顶部的RUN或者按F8
file

样例库

浏览的代码示例库,能够更好的了解Cesium能够干什么和怎么用。 样例列表在页面底部的可滚动幻灯片中。 这些示例可以通过标签过滤,也可以使用顶部的搜索栏对关键字进行过滤。 我们从一个初级的例子开始。
file

查看参考文档

Sandcastle能够很方便的访问类的文档。 只需在代码中双击Cesium类,功能或属性,即可在Sandcastle右侧的新选项卡中打开相关文档页面。

Sandcastle还提供了Cesium标识符和本机JavaScript的代码建议和自动完成。 只需按Ctrl-Space即可在代码中的光标当前位置打开所有可行的完成的下拉菜单。注意和输入法快捷键的冲突。
file

保存和分享

Sandcastle可以很方便的分享自己的代码。

分享

要在Sandcastle中分享代码示例,请单击顶部的“共享”按钮,将会把当前代码保存为GitHub Gist,并为加载代码的Sandcastle样例生成一个URL。

这是开发人员在Cesium论坛上寻求帮助时分享代码的最佳方式,因为这实际上包含了一个你代码运行的实例。Cesium团队也特别感谢您在GitHub上提交bug。

加载Github Gists

通过单击导入Gist按钮并输入生成的gist url或ID来加载已保存的Github Gists。
file

保存代码

为了将Sandcastle示例保存为用于本地铯存储库的html(并且希望稍后贡献代码!),只需单击顶部的另存为按钮即可将当前代码下载为html文件。 将文件另存为*Apps/Sandcastle/gallery/.html**以供本地构建使用。

添加简单的界面

Sandcastle还提供了一些基本的GUI小部件,有助于交互式测试和调试。 沙堡小部件包括按钮,下拉菜单和切换按钮。 请参阅代码示例

当触发GUI元素时,Sandcastle还将以绿色突出显示正在执行的代码,因此很容易定位到相关代码。
file

本地化构建

Sandcastle是托管在Cesium官方网站上的,但也包含在Cesium项目库中,可以构建使用本地版本的Cesium。 查看构建指南获取更多信息,使用本地构建对于测试具有不同Cesium分支的代码是非常有用的。

Contributing

你有一个简单的例子来演示一个有用或者有趣的Cesium功能吗? 我们总是希望Sandcastle拥有更丰富的功能展示! 我们随时打开pull request! 请参阅贡献者指南了解如何开始使用。
您的Sandcastle示例将需要几件事情:

  • 代码:只需在Sandcastle中创建一个代码示例,点击保存按钮,并将生成的html文件作为Apps/Sandcastle/gallery/*.html在铯储存库中。
  • 元信息:在保存代码示例之前,单击顶部的“信息”按钮为您的示例编写描述和标签。
  • 缩略图:点击“查看为缩略图”按钮,直到当前应用程序的显示为微型视图。 进行屏幕截图,然后添加到Apps/Sandcastle/gallery / .jpg。 确保名称与html文件匹配对应。

这就是所有的步骤!我们希望您能发挥Sandcastle最佳的作用!