SketchUp Ruby API 中文文档

SketchUp Ruby API允许您与SketchUp模型和SketchUp应用程序互动。它可以在SketchUp内部使用,不能单独使用。

开始使用Ruby API概述

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

LayOut API

从SketchUp 2018开始,你也可以创建和操作LayOut文档。欲了解更多信息,请参考LayOut API概述

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

示例和教程

入门

为了让你开始学习,我们有一系列的例子和教程。这些将带您了解SketchUp API的各种常见情况和概念。

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

SketchUp中的Ruby C扩展

Ruby本身允许你通过C(和C++)来处理Ruby代码。这可以实现更复杂的功能和可能的性能改进。我们提供了如何创建Ruby C扩展的例子,这些扩展可以在各种SketchUp版本和平台上使用。

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

调试

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

github.com/SketchUp/sketchup-ruby-debugger

我们也有一个关于设置RubyMine的指南,作为你如何设置调试器的例子:

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

测试

Ruby的标准测试框架通常假定你的测试是从Ruby的控制台解释器中运行。当你想为需要在SketchUp中运行的代码设置单元测试时,这就造成了问题。

为了解决这个问题,我们创建了TestUp,一个Minitest的包装,它可以在SketchUp中运行,并有一个GUI界面来管理你的测试。

github.com/SketchUp/testup-2

工具

通过提供存根,让你的IDE了解SketchUp的Ruby API:

github.com/SketchUp/ruby-api-stubs

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

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

VSCode范例:

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

文档

如果你发现文档中有错别字,描述不清楚等,请在我们API的问题跟踪器中记录一个新问题:github.com/SketchUp/api-issue-tracker/issues