SketchUp Ruby API入门指南：由Sugar编著

版权申诉

5星 · 超过95%的资源 101 浏览量更新于2024-07-05 收藏 2.67MB PDF 举报

"SketchUp Ruby API by Sugar" 是一份针对SketchUp这款著名的三维建模软件的官方文档，它详细介绍了如何通过Ruby编程语言与SketchUp进行交互和扩展其功能。SketchUp是一款广泛应用于建筑设计、室内设计、工程制图等领域的专业3D建模工具，而Ruby API则提供了访问SketchUp内部结构和执行高级定制操作的接口。这份文档分为两个主要部分：AppLevel Classes和Entity Classes。AppLevel Classes涵盖了与应用程序级别交互的核心类，如Sketchup对象（Model）、AttributeDictionary（属性字典）、Axes（坐标轴）等。它们在开发插件或自定义工具时至关重要，帮助开发者控制模型空间、处理用户界面和数据存储。 - Sketchup: 定义了整个应用的上下文环境，包括模型空间和视图管理。 - Model: 表示SketchUp中的模型容器，可以操作模型的几何体、材质和布局。 - AttributeDictionary: 存储模型对象的属性信息，允许开发者读取和修改这些属性。 - Axes: 用于定位和测量模型中的元素，如X、Y、Z轴和笛卡尔坐标系统。 - Animation: 提供动画相关的功能，支持创建和控制模型的运动路径。 - Camera: 控制视图的视角和摄像机设置，允许动态调整观察角度。 - Color: 用于定义模型的颜色和纹理。 - Importer: 实现导入外部3D模型格式的功能。 - LanguageHandler: 管理不同编程语言的集成，使得Ruby API能够与SketchUp其他组件协同工作。 - OptionsManager和OptionsProvider: 负责管理应用程序的全局设置和提供定制选项。 - Set: 代表模型空间中的选择集，用于选择多个元素。 - TextureWriter: 处理纹理的写入和管理。 - View: 创建和控制不同的视图，比如鸟瞰图、剖面图等。 - UVHelper: 提供与UV映射相关的工具，用于处理纹理贴图。 Entity Classes部分则专注于模型中的具体元素，如实体（Entity）、曲线（Curve）、尺寸（Dimension）、边（Edge）和面（Face）等。开发者可以利用这些类来创建、编辑和管理建模组件，如弧线、构造线、组件实例等。此外，文档还包含了如Group（组）、Image（图像）、Material（材质）、Loop（环）、Page（页面）、SectionPlane（截面平面）、ShadowInfo（阴影信息）、Style（样式）、Text（文本）、Texture（纹理）等对象的详细说明。 CollectionClasses和AttributeDictionaries类群则涉及到集合管理和对象的属性组织，而Classifications_class、DefinitionList_class、Entities_class、Layers_class、Materials_class、Pages_class等则是对模型层次结构、分类、层、材料、页面等更细致的管理类。最后，RenderingOptions_class用于渲染设置，Selection_类则涉及到选择操作的管理。"SketchUp Ruby API by Sugar"文档为开发者提供了一套完整的工具，使他们能够通过Ruby编程语言深度集成和扩展SketchUp的功能，实现自动化任务、脚本化操作和创建定制插件。

第 16 页共 274 页

 21234: display Area of all faces with selected material

 21236: select the Scale tool

 21237: display the Export 2D Graphics Window

 21245: display a Polygon Offset Factors dialog box

 21276: reverse selected face(s)

 21287: select the Divide feature

 21337: select the Section Plane Placement tool

 21354: open the Layer Window

 21386: open the Export Animation Window

 21405: select the Text tool

 21406: display Fog dialog box

 21410: select the Dim tool

 21433: toggle Edit toolbar

 21442: select the FollowMe tool

 21448: select the Axes tool

 21453: select all objects

 21460: display Licence

 21462: display Authorization dialog box

 21463: display un-authorizing message

 21464: display Open Licence files (Network) Window

 21466: display Quick reference Card in Adobe Reader

 21467: display Licences in use dialog box

 21469: zoom extents to selected objects

 21476: perform a non-planar check on selected objects

 21477: list accelerators in window

 21485: erase selected objects

 21487: display Edit current material dialog box

 21485: erase all new created pages

 21488: display Entity Info Window

 21490: display Soften Edges Window

 21491: display Profiles

 21492: display Extended Edges

 21493: display Jitter Lines

 21494: select Field of view tool

 21513: display the outliner

 21520: override Tile Rendering Size dialog box

 21525: select the FollowMe tool

 21542: display the Insert Image Window

 21560 and up: causes a runtime Error

Arguments:

action

The action to be performed.

Returns:

result

true if successful, false if unsuccessful

result = Sketchup.send_action "selectArcTool:"

Sketchup.set_status_tex

result = Sketchup.set_status_text "This is a Test", SB

_VCB_VALUE

if (result)

#code to do something if set_status_text is succes

sful

end

SketchUp 6.0+

The set_status_text method is used to set the text appearing on

the status bar within the drawing window.

If no arguments are passed, the status bar content is cleared.

Valid positions are:

 SB_PROMPT - the text will appear at the left-side of

the status bar

 SB_VCB_LABEL - the text will appear in place of the

VCB label

 SB_VCB_VALUE - the text will appear in the VCB

Arguments:

status

text (optional) the status text that will appear.

position

(optional) the position where the text will appear.

Returns:

第 17 页共 274 页

result

true if successful, false if unsuccessful.

Sketchup.status_text=

result = Sketchup.status_text = "This is a Test"

SketchUp 6.0+

The status_text= method is used to set the text appearing on the

status bar within the drawing window.

This is the same as calling set_status_text with a 2nd parameter

of SB_PROMPT.

Arguments:

status_text

The status text that will appear.

Returns:

result

true if successful, false if unsuccessful.

Sketchup.temp_dir

temp_dir = Sketchup.temp_dir

SketchUp 2014+

The temp_dir method is used to retrieve the OS temporary

directory for the current user. You can use this directory to write

temporary files that are not required to persist between SketchUp

sessions.

Returns:

String containing the full temporary directory path

Sketchup.template

name = Sketchup.template

SketchUp 6.0+

The template method is used to get the file name of the current

template. Templates are the .skp files that are loaded when the

user select File > New.

Returns:

name

the current template

Sketchup.template=

status = Sketchup.template= "filename"

SketchUp 6.0+

The template= method is used to set the file name of the current

template. Templates are the .skp files that are loaded when the

user select File > New.

Arguments:

filename

The name of the template to set.

Returns:

status

true if successful, false if unsuccessful.

Sketchup.template_dir

directory = Sketchup.template_dir

SketchUp 6.0+

The template_dir is used to retrieve the directory where

templates are stored by the SketchUp install. Templates are

the .skp files that are loaded when the user select File > New.

Returns:

String containing the full template directory path

Sketchup.undo

SketchUp 6.0+

The undo method is used undo the last transaction on the undo

stack.

Returns:

nil

Sketchup.vcb_label=

result = Sketchup.vcb_label = "This is a Test"

SketchUp 6.0+

The vcb_label= method is used to set the label that appears on

the vcb, or the "value control box", which is another word for the

"measurements" text entry box that appears at the bottom on the

SketchUp window.

This is the same as calling set_status_text with a 2nd parameter

of SB_VCB_LABEL.

Arguments:

label_text

The label text that will appear.

Returns:

result

true if successful, false if unsuccessful.

第 19 页共 274 页

class

Parent: Object

Introduction

This is the interface to a SketchUp model. The model is the 3D drawing that the user is working with, and it serves as the "entry point" for most Ruby API interactions. The Sketchup.active_model method gives you a handle to the current model, and from there you can use the

model-level methods to start getting information and making changes.

Constants: Product Family

 Model::ProTrial

 Model::ProLicensed

 Model::MakeTrial

 Model::MakeTrialExpired



# Grab a handle to the currently active model (aka the one the user is

# looking at in SketchUp.)

model = Sketchup.active_model

# Grab other handles to commonly used collections inside the model.

entities = model.entities

layers = model.layers

materials = model.materials

component_definitions = model.definitions

selection = model.selection

# Now that we have our handles, we can start pulling objects and making

# method calls that are useful.

first_entity = entities[0]

UI.messagebox("First thing in your model is a #{first_entity.typename}")

number_materials = materials.length

UI.messagebox("Your model has #{number_materials} materials.")

new_edge = entities.add_line([0,0,0], [500,500,0])

Model.abort_operation

status = model.abort_operation

SketchUp 6.0+

The abort_operation method aborts the current

operation started with the start_operation

method.

The abort_operation method is normally called

from inside of a rescue clause to cancel an

operation if something goes wrong.

Returns:

status

true if successful, false if

unsuccessful

Model.active_entities

model = Sketchup.active_model

entities = model.active_entities

SketchUp 6.0+

The active_entities method is used to retrieve

an Entities object containing all of the entities in

the active model, component, or group (if you

are within a group or component edit session.)

Returns:

entities

an entities object

Model.active_layer

model = Sketchup.active_model

layer = model.active_layer

SketchUp 6.0+

The active_layer method retrieves the

active Layer.

The default layer in SketchUp is layer 0.

Returns:

layer

a layer object containing the currently

active layer

Model.active_layer=

model = Sketchup.active_model

layers = model.layers

SketchUp 6.0+

The active_layer= method sets the

active Layer object.

第 20 页共 274 页

layer = layers.add('My Layer')

model.active_layer = layer

Arguments:

layer

The layer object to be set as the active

layer.

Returns:

activelayer

the newly set active layer object

Model.active_path

active_path = Sketchup.active_model.active_path

SketchUp 7.0+

Returns an array containing the sequence of

entities the user has double-clicked on for

editing. This allows one to determine whether

they are in component edit mode and where in

the model they are.

For example, if a user has double-clicked into a

component to edit its geometry, and then

double clicked into a sub-group to edit that, the

active_path might contain:

[<Sketchup::ComponentInstance>,

<Sketchup::Group>]

Returns:

path

array of entities showing where the user

is currently editing.

Model.active_view

model = Sketchup.active_model

view = model.active_view

SketchUp 6.0+

The active_view method returns the

active View object for this model.

Returns:

view

a view object

Model.add_note

model = Sketchup.active_model

# Add a note 1/10 ways down the screen and 1/10 ways right from th

# upper left corner of model window.

note = Sketchup.active_model.add_note('Hello World', 0.1, 0.1)

SketchUp 6.0+

Add a text note to the Model. The position of

the note is given as relative window positions

between 0 and 1. For example, the following

command would create a note that start 1/10 of

the ways down the screen from the upper left

corner of the window.

Arguments:

note

A string note.

A distance along the x axis between 0 and

A distance along the y axis between 0 and

Returns:

note

a note object or an exception if it is

unsuccessful.

Model.add_observer

model = Sketchup.active_model

observer = Sketchup::ModelObserver.new

status = model.add_observer(observer)

SketchUp 6.0+

The add_observer method is used to add an

observer to the current object.

Arguments:

observer

An observer.

Returns:

true if successful, false if

unsuccessful.

Model.attribute_dictionaries

model = Sketchup.active_model

dictionaries = model.attribute_dictionaries

if dictionaries

# Code to do something if attribute dictionaries exist (usually you

# parse the array of dictionaries.

else

# Code to do something if attribute dictionaries do not exist.

end

SketchUp 6.0+

The attribute_dictionaries method retrieves

the AttributeDictionaries object that is

associated with the Model.

Returns:

attributedictionaries

the AttributeDictionaries object associated with the

entity, or nil if there are no attribute_dictionary

objects associated with the model. Care must be

taken if nil is returned, for example: invoking

attribute_dictionaries.length will throw a

剩余273页未读，继续阅读

少年小鱼

粉丝: 32
资源: 528

SketchUp Ruby API入门指南：由Sugar编著

【sketchup开发必备】RUBY API for sketchup (狂刀整理版).CHM

Ruby API(CHM格式)

ruby中文文档.chm

sketch-ios, iOS Sketch.app 模板.zip

餐厅、饮食app ui capi .sketch .xd .psd素材下载

sketch.pdf

sketch.js 画图工具效果.zip

Sketch中文用户手册.pdf

Sketch基础入门.pdf

Sketch 52.2（已验证）.dmg.zip

最新资源