SketchUp Ruby API 中文文档

SketchUp Ruby API允许您与SketchUp模型和SketchUp应用程序交互。它可以从SketchUp中获得,但不能单独使用。

开始使用Ruby API概述.

访问我们的SketchUp开发中心有关SketchUp API的更多信息和资源。

LayOut API

从SketchUp 2018开始,您还可以创建和操作布局文档。有关更多信息,请参阅LayOut API概述.

目前,LayOut Ruby API仅在SketchUp中可用。

示例和教程

开始

为了让你开始,我们收集了一些教程的例子。这些将带您了解SketchUp API的各种常见场景和概念。

github.com/SketchUp/sketchup-ruby-api-tutorials

SketchUp中的Ruby C扩展

Ruby本身允许您通过C(和C++)与Ruby代码一起工作。这允许更复杂的功能和可能的性能改进。我们提供了一些示例,说明如何创建可与各种SketchUp版本和平台一起使用的Ruby C扩展:

github.com/SketchUp/ruby-c-extension-examples

调试

为了使调试SketchUp Ruby扩展更容易,我们有一个Ruby调试器界面,可以添加到SketchUp安装中。这将允许您使用支持Ruby调试协议的IDE/编辑器的调试功能:

github.com/SketchUp/sketchup-ruby-debugger

我们还提供了关于如何设置RubyMine的指南,作为如何设置调试器的示例:

github.com/SketchUp/sketchup-ruby-api-tutorials/wiki/RubyMine-Debugger-Setup

测试

通常假设您的Ruby测试框架是从标准的Ruby测试控制台运行的。如果要为需要在SketchUp中运行的代码设置单元测试,则会出现问题。

为了解决这个问题,我们创建了TestUp,在Minitest它与GUI界面一起在SketchUp中工作,以管理测试。

github.com/SketchUp/testup-2

工具

通过输入SketchUp Ruby API的存根,让您的IDE深入了解SketchUp Ruby API:

github.com/SketchUp/ruby-api-stubs

作为如何设置IDE的示例,我们创建了一个描述RubyMine过程的示例:

github.com/SketchUp/sketchup-ruby-api-tutorials/wiki/RubyMine-Project-Setup#making-the-ide-sketchup-api-aware

VSCode示例:

github.com/SketchUp/sketchup-extension-vscode-project

文档

如果您在文档中发现打字错误、描述不清等,请在API的问题跟踪器中记录新问题:github.com/SketchUp/api-issue-tracker/issues