sketchup-api-stubs 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/SketchUp/Geom/BoundingBox.rb +335 -0
- data/SketchUp/Geom/LatLong.rb +123 -0
- data/SketchUp/Geom/Point3d.rb +643 -0
- data/SketchUp/Geom/PolygonMesh.rb +478 -0
- data/SketchUp/Geom/Transformation.rb +476 -0
- data/SketchUp/Geom/UTM.rb +135 -0
- data/SketchUp/Geom/Vector3d.rb +684 -0
- data/SketchUp/Sketchup/Animation.rb +137 -0
- data/SketchUp/Sketchup/AppObserver.rb +157 -0
- data/SketchUp/Sketchup/ArcCurve.rb +209 -0
- data/SketchUp/Sketchup/AttributeDictionaries.rb +146 -0
- data/SketchUp/Sketchup/AttributeDictionary.rb +280 -0
- data/SketchUp/Sketchup/Axes.rb +149 -0
- data/SketchUp/Sketchup/Behavior.rb +338 -0
- data/SketchUp/Sketchup/Camera.rb +594 -0
- data/SketchUp/Sketchup/ClassificationSchema.rb +63 -0
- data/SketchUp/Sketchup/Classifications.rb +118 -0
- data/SketchUp/Sketchup/Color.rb +291 -0
- data/SketchUp/Sketchup/ComponentDefinition.rb +562 -0
- data/SketchUp/Sketchup/ComponentInstance.rb +597 -0
- data/SketchUp/Sketchup/Console.rb +78 -0
- data/SketchUp/Sketchup/ConstructionLine.rb +257 -0
- data/SketchUp/Sketchup/ConstructionPoint.rb +32 -0
- data/SketchUp/Sketchup/Curve.rb +196 -0
- data/SketchUp/Sketchup/DefinitionList.rb +312 -0
- data/SketchUp/Sketchup/DefinitionObserver.rb +73 -0
- data/SketchUp/Sketchup/DefinitionsObserver.rb +102 -0
- data/SketchUp/Sketchup/Dimension.rb +167 -0
- data/SketchUp/Sketchup/DimensionLinear.rb +232 -0
- data/SketchUp/Sketchup/DimensionObserver.rb +38 -0
- data/SketchUp/Sketchup/DimensionRadial.rb +87 -0
- data/SketchUp/Sketchup/Drawingelement.rb +400 -0
- data/SketchUp/Sketchup/Edge.rb +517 -0
- data/SketchUp/Sketchup/EdgeUse.rb +213 -0
- data/SketchUp/Sketchup/Entities.rb +1011 -0
- data/SketchUp/Sketchup/EntitiesObserver.rb +125 -0
- data/SketchUp/Sketchup/Entity.rb +522 -0
- data/SketchUp/Sketchup/EntityObserver.rb +59 -0
- data/SketchUp/Sketchup/ExtensionsManager.rb +129 -0
- data/SketchUp/Sketchup/Face.rb +737 -0
- data/SketchUp/Sketchup/FrameChangeObserver.rb +104 -0
- data/SketchUp/Sketchup/Group.rb +705 -0
- data/SketchUp/Sketchup/Http.rb +27 -0
- data/SketchUp/Sketchup/Http/Request.rb +285 -0
- data/SketchUp/Sketchup/Http/Response.rb +62 -0
- data/SketchUp/Sketchup/Image.rb +393 -0
- data/SketchUp/Sketchup/Importer.rb +192 -0
- data/SketchUp/Sketchup/InputPoint.rb +393 -0
- data/SketchUp/Sketchup/InstanceObserver.rb +82 -0
- data/SketchUp/Sketchup/InstancePath.rb +297 -0
- data/SketchUp/Sketchup/Layer.rb +240 -0
- data/SketchUp/Sketchup/Layers.rb +235 -0
- data/SketchUp/Sketchup/LayersObserver.rb +136 -0
- data/SketchUp/Sketchup/Licensing.rb +47 -0
- data/SketchUp/Sketchup/Licensing/ExtensionLicense.rb +88 -0
- data/SketchUp/Sketchup/Loop.rb +141 -0
- data/SketchUp/Sketchup/Material.rb +384 -0
- data/SketchUp/Sketchup/Materials.rb +283 -0
- data/SketchUp/Sketchup/MaterialsObserver.rb +141 -0
- data/SketchUp/Sketchup/Menu.rb +97 -0
- data/SketchUp/Sketchup/Model.rb +1459 -0
- data/SketchUp/Sketchup/ModelObserver.rb +356 -0
- data/SketchUp/Sketchup/OptionsManager.rb +135 -0
- data/SketchUp/Sketchup/OptionsProvider.rb +277 -0
- data/SketchUp/Sketchup/OptionsProviderObserver.rb +58 -0
- data/SketchUp/Sketchup/Page.rb +636 -0
- data/SketchUp/Sketchup/Pages.rb +349 -0
- data/SketchUp/Sketchup/PagesObserver.rb +76 -0
- data/SketchUp/Sketchup/PickHelper.rb +457 -0
- data/SketchUp/Sketchup/RegionalSettings.rb +43 -0
- data/SketchUp/Sketchup/RenderingOptions.rb +337 -0
- data/SketchUp/Sketchup/RenderingOptionsObserver.rb +44 -0
- data/SketchUp/Sketchup/SectionPlane.rb +88 -0
- data/SketchUp/Sketchup/Selection.rb +470 -0
- data/SketchUp/Sketchup/SelectionObserver.rb +115 -0
- data/SketchUp/Sketchup/Set.rb +253 -0
- data/SketchUp/Sketchup/ShadowInfo.rb +257 -0
- data/SketchUp/Sketchup/ShadowInfoObserver.rb +57 -0
- data/SketchUp/Sketchup/Style.rb +77 -0
- data/SketchUp/Sketchup/Styles.rb +204 -0
- data/SketchUp/Sketchup/Text.rb +241 -0
- data/SketchUp/Sketchup/Texture.rb +211 -0
- data/SketchUp/Sketchup/TextureWriter.rb +237 -0
- data/SketchUp/Sketchup/Tool.rb +808 -0
- data/SketchUp/Sketchup/Tools.rb +120 -0
- data/SketchUp/Sketchup/ToolsObserver.rb +154 -0
- data/SketchUp/Sketchup/UVHelper.rb +61 -0
- data/SketchUp/Sketchup/Vertex.rb +143 -0
- data/SketchUp/Sketchup/View.rb +965 -0
- data/SketchUp/Sketchup/ViewObserver.rb +40 -0
- data/SketchUp/UI/Command.rb +307 -0
- data/SketchUp/UI/HtmlDialog.rb +346 -0
- data/SketchUp/UI/Notification.rb +229 -0
- data/SketchUp/UI/Toolbar.rb +243 -0
- data/SketchUp/UI/WebDialog.rb +623 -0
- data/SketchUp/_top_level.rb +193 -0
- data/SketchUp/array.rb +593 -0
- data/SketchUp/geom.rb +231 -0
- data/SketchUp/languagehandler.rb +92 -0
- data/SketchUp/length.rb +210 -0
- data/SketchUp/numeric.rb +249 -0
- data/SketchUp/sketchup.rb +1290 -0
- data/SketchUp/sketchupextension.rb +355 -0
- data/SketchUp/string.rb +24 -0
- data/SketchUp/ui.rb +637 -0
- metadata +176 -0
@@ -0,0 +1,277 @@
|
|
1
|
+
# Copyright:: Copyright 2017 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# An OptionsProvider class provides various kinds of options on a Model. You
|
5
|
+
# get an OptionsProvider from the OptionsManager. The options are given as
|
6
|
+
# name/value pairs.
|
7
|
+
#
|
8
|
+
# @version SketchUp 6.0
|
9
|
+
class Sketchup::OptionsProvider
|
10
|
+
|
11
|
+
# Includes
|
12
|
+
|
13
|
+
include Enumerable
|
14
|
+
|
15
|
+
# Instance Methods
|
16
|
+
|
17
|
+
# The [] method is used to get a value by name or index of the key.
|
18
|
+
#
|
19
|
+
# @example
|
20
|
+
# model = Sketchup.active_model
|
21
|
+
# manager = model.options
|
22
|
+
# provider = manager[0]
|
23
|
+
# # Retrieves the provider at index 1
|
24
|
+
# option = provider[1]
|
25
|
+
#
|
26
|
+
# @overload [](index)
|
27
|
+
#
|
28
|
+
# @param index The index for a specific key.
|
29
|
+
# @return value - the value if successful
|
30
|
+
#
|
31
|
+
# @overload [](name)
|
32
|
+
#
|
33
|
+
# @param name The name of the specific key.
|
34
|
+
# @return value - the value if successful
|
35
|
+
#
|
36
|
+
# @version SketchUp 6.0
|
37
|
+
def [](arg)
|
38
|
+
end
|
39
|
+
|
40
|
+
# The []= method is used to set the value of a specific key.
|
41
|
+
#
|
42
|
+
# Creates a new attribute for the given key if needed.
|
43
|
+
#
|
44
|
+
# @example
|
45
|
+
# option = provider[1]=10
|
46
|
+
#
|
47
|
+
# @param key
|
48
|
+
# The valid key.
|
49
|
+
#
|
50
|
+
# @param value
|
51
|
+
# The value to be set.
|
52
|
+
#
|
53
|
+
# @return value - the value that was set if successful, or false
|
54
|
+
# if unsuccessful.
|
55
|
+
#
|
56
|
+
# @version SketchUp 6.0
|
57
|
+
def []=(key, value)
|
58
|
+
end
|
59
|
+
|
60
|
+
# The add_observer method is used to add an observer to the current object.
|
61
|
+
#
|
62
|
+
# @example
|
63
|
+
# status = object.add_observer observer
|
64
|
+
#
|
65
|
+
# @param observer
|
66
|
+
# An observer.
|
67
|
+
#
|
68
|
+
# @return true if successful, false if unsuccessful.
|
69
|
+
#
|
70
|
+
# @version SketchUp 6.0
|
71
|
+
def add_observer(observer)
|
72
|
+
end
|
73
|
+
|
74
|
+
#
|
75
|
+
# @example
|
76
|
+
# optionsprovider = Sketchup.active_model.options['UnitsOptions']
|
77
|
+
# number = optionsprovider.count
|
78
|
+
#
|
79
|
+
# @note Since SketchUp 2014 the count method is inherited from Ruby's
|
80
|
+
# +Enumable+ mix-in module. Prior to that the {#count} method is an alias
|
81
|
+
# for {#length}.
|
82
|
+
#
|
83
|
+
# @return integer - the size of the options provider if
|
84
|
+
# successful
|
85
|
+
#
|
86
|
+
# @see #length
|
87
|
+
#
|
88
|
+
# @version SketchUp 6.0
|
89
|
+
def count
|
90
|
+
end
|
91
|
+
|
92
|
+
# The each method is used to iterate through all of the attributes.
|
93
|
+
#
|
94
|
+
# Throws an exception if there are no keys.
|
95
|
+
#
|
96
|
+
# The {#each_pair} method is an alias of {#each}.
|
97
|
+
#
|
98
|
+
# @example
|
99
|
+
# # Retrieves each key
|
100
|
+
# provider.each { |key, value| UI.messagebox key }
|
101
|
+
# # Retrieves each corresponding value
|
102
|
+
# provider.each { |key, value| UI.messagebox value }
|
103
|
+
#
|
104
|
+
# @return nil
|
105
|
+
#
|
106
|
+
# @version SketchUp 6.0
|
107
|
+
#
|
108
|
+
# @yield [key, value] Variables that will hold each key and value as they are
|
109
|
+
# found.
|
110
|
+
def each
|
111
|
+
end
|
112
|
+
|
113
|
+
# The each_key method is used to iterate through all of the attribute keys.
|
114
|
+
#
|
115
|
+
# Throws an exception if there are no keys.
|
116
|
+
#
|
117
|
+
# @example
|
118
|
+
# provider.each_key { |key| UI.messagebox key }
|
119
|
+
#
|
120
|
+
# @return nil
|
121
|
+
#
|
122
|
+
# @version SketchUp 6.0
|
123
|
+
#
|
124
|
+
# @yield [key] A variable that will hold each key as they are found.
|
125
|
+
def each_key
|
126
|
+
end
|
127
|
+
|
128
|
+
# The each method is used to iterate through all of the attributes.
|
129
|
+
#
|
130
|
+
# Throws an exception if there are no keys.
|
131
|
+
#
|
132
|
+
# The {#each_pair} method is an alias of {#each}.
|
133
|
+
#
|
134
|
+
# @example
|
135
|
+
# # Retrieves each key
|
136
|
+
# provider.each { |key, value| UI.messagebox key }
|
137
|
+
# # Retrieves each corresponding value
|
138
|
+
# provider.each { |key, value| UI.messagebox value }
|
139
|
+
#
|
140
|
+
# @return nil
|
141
|
+
#
|
142
|
+
# @version SketchUp 6.0
|
143
|
+
#
|
144
|
+
# @yield [key, value] Variables that will hold each key and value as they are
|
145
|
+
# found.
|
146
|
+
def each_pair
|
147
|
+
end
|
148
|
+
|
149
|
+
# The each_value method is used to iterate through all of the attribute
|
150
|
+
# values.
|
151
|
+
#
|
152
|
+
# Throws an exception if there are no keys.
|
153
|
+
#
|
154
|
+
# @example
|
155
|
+
# provider.each_value { |value| UI.messagebox value }
|
156
|
+
#
|
157
|
+
# @return nil
|
158
|
+
#
|
159
|
+
# @version SketchUp 6.0
|
160
|
+
#
|
161
|
+
# @yield [value] A variable that will hold each value as they are found.
|
162
|
+
def each_value
|
163
|
+
end
|
164
|
+
|
165
|
+
# The key? method is used to determine if the options provider has a specific
|
166
|
+
# key. This method is the same as has_key? See also OptionsManager.has_key
|
167
|
+
#
|
168
|
+
# @example
|
169
|
+
# status = provider.key? "name"
|
170
|
+
#
|
171
|
+
# @param name
|
172
|
+
# The name of the key you are looking for.
|
173
|
+
#
|
174
|
+
# @return status - true if the key exists, false if the key does
|
175
|
+
# not exist.
|
176
|
+
#
|
177
|
+
# @return [Boolean]
|
178
|
+
#
|
179
|
+
# @version SketchUp 6.0
|
180
|
+
def has_key?(name)
|
181
|
+
end
|
182
|
+
|
183
|
+
# The key? method is used to determine if the options provider has a specific
|
184
|
+
# key. This method is the same as has_key? See also OptionsManager.has_key
|
185
|
+
#
|
186
|
+
# @example
|
187
|
+
# status = provider.key? "name"
|
188
|
+
#
|
189
|
+
# @param name
|
190
|
+
# The name of the key you are looking for.
|
191
|
+
#
|
192
|
+
# @return status - true if the key exists, false if the key does
|
193
|
+
# not exist.
|
194
|
+
#
|
195
|
+
# @return [Boolean]
|
196
|
+
#
|
197
|
+
# @version SketchUp 6.0
|
198
|
+
def key?(name)
|
199
|
+
end
|
200
|
+
|
201
|
+
# The keys method is used to retrieve an array with all of the attribute keys.
|
202
|
+
#
|
203
|
+
# @example
|
204
|
+
# keys = provider.keys
|
205
|
+
# key = keys[0]
|
206
|
+
# if (key)
|
207
|
+
# UI.messagebox key
|
208
|
+
# else
|
209
|
+
# UI.messagebox "Failure"
|
210
|
+
# end
|
211
|
+
#
|
212
|
+
# @return keys - an array of keys within the options provider if
|
213
|
+
# successful
|
214
|
+
#
|
215
|
+
# @version SketchUp 6.0
|
216
|
+
def keys
|
217
|
+
end
|
218
|
+
|
219
|
+
# The {#size} method is used to retrieve the size (number of elements) of an
|
220
|
+
# options provider.
|
221
|
+
#
|
222
|
+
# The {#length} method is an alias of {#size}.
|
223
|
+
#
|
224
|
+
# @example
|
225
|
+
# optionsprovider = Sketchup.active_model.options['UnitsOptions']
|
226
|
+
# number = optionsprovider.size
|
227
|
+
#
|
228
|
+
# @return integer - the size of the options provider if
|
229
|
+
# successful
|
230
|
+
#
|
231
|
+
# @version SketchUp 6.0
|
232
|
+
def length
|
233
|
+
end
|
234
|
+
|
235
|
+
# The name method is used to retrieve the name of an options provider.
|
236
|
+
#
|
237
|
+
# @example
|
238
|
+
# name = provider.name
|
239
|
+
#
|
240
|
+
# @return name - the name of the options provider if successful
|
241
|
+
#
|
242
|
+
# @version SketchUp 6.0
|
243
|
+
def name
|
244
|
+
end
|
245
|
+
|
246
|
+
# The remove_observer method is used to remove an observer from the current
|
247
|
+
# object.
|
248
|
+
#
|
249
|
+
# @example
|
250
|
+
# status = object.remove_observer observer
|
251
|
+
#
|
252
|
+
# @param observer
|
253
|
+
# An observer.
|
254
|
+
#
|
255
|
+
# @return true if successful, false if unsuccessful.
|
256
|
+
#
|
257
|
+
# @version SketchUp 6.0
|
258
|
+
def remove_observer(observer)
|
259
|
+
end
|
260
|
+
|
261
|
+
# The {#size} method is used to retrieve the size (number of elements) of an
|
262
|
+
# options provider.
|
263
|
+
#
|
264
|
+
# The {#length} method is an alias of {#size}.
|
265
|
+
#
|
266
|
+
# @example
|
267
|
+
# optionsprovider = Sketchup.active_model.options['UnitsOptions']
|
268
|
+
# number = optionsprovider.size
|
269
|
+
#
|
270
|
+
# @return integer - the size of the options provider if
|
271
|
+
# successful
|
272
|
+
#
|
273
|
+
# @version SketchUp 6.0
|
274
|
+
def size
|
275
|
+
end
|
276
|
+
|
277
|
+
end
|
@@ -0,0 +1,58 @@
|
|
1
|
+
# Copyright:: Copyright 2017 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# This observer interface is implemented to react to operations provider
|
5
|
+
# events. What this means is that you can watch as the user changes SketchUp
|
6
|
+
# options and react to them. The following {Sketchup::OptionsProviders} are
|
7
|
+
# defined in the API:
|
8
|
+
#
|
9
|
+
# - <code>"UnitsOptions"</code>
|
10
|
+
# - <code>"PrintOptions"</code>
|
11
|
+
# - <code>"PageOptions"</code>
|
12
|
+
# - <code>"SlideshowOptions"</code>
|
13
|
+
# - <code>"NamedOptions"</code>
|
14
|
+
#
|
15
|
+
# Each of these has a list of specific options that the user can set. See the
|
16
|
+
# {Sketchup::OptionsManager} and {Sketchup::OptionsProvider} classes for more
|
17
|
+
# details.
|
18
|
+
#
|
19
|
+
# To implement this observer, create a Ruby class of this type,
|
20
|
+
# override the desired methods, and add an instance of the observer to the
|
21
|
+
# objects of interests.
|
22
|
+
#
|
23
|
+
# @example
|
24
|
+
# class MyOptionsProviderObserver < Sketchup::OptionsProviderObserver
|
25
|
+
# def onOptionsProviderChanged(provider, name)
|
26
|
+
# puts "onOptionsProviderChanged: #{name}"
|
27
|
+
# end
|
28
|
+
# end
|
29
|
+
#
|
30
|
+
# # Detect when the end user changes their units settings.
|
31
|
+
# options_provider = Sketchup.active_model.options["UnitsOptions"]
|
32
|
+
# options_provider.add_observer(MyOptionsProviderObserver.new)
|
33
|
+
#
|
34
|
+
# @version SketchUp 6.0
|
35
|
+
class Sketchup::OptionsProviderObserver
|
36
|
+
|
37
|
+
# Instance Methods
|
38
|
+
|
39
|
+
# The {#onOptionsProviderChanged} method is invoked when a property of an
|
40
|
+
# {Sketchup::OptionsProvider} changes.
|
41
|
+
#
|
42
|
+
# @example
|
43
|
+
# def onOptionsProviderChanged(provider, name)
|
44
|
+
# puts "onOptionsProviderChanged: #{name}"
|
45
|
+
# end
|
46
|
+
#
|
47
|
+
# @param [Sketchup::OptionsProvider] provider
|
48
|
+
#
|
49
|
+
# @param [String] name
|
50
|
+
# The name of the specific option that was changed.
|
51
|
+
#
|
52
|
+
# @return [nil]
|
53
|
+
#
|
54
|
+
# @version SketchUp 6.0
|
55
|
+
def onOptionsProviderChanged(provider, name)
|
56
|
+
end
|
57
|
+
|
58
|
+
end
|
@@ -0,0 +1,636 @@
|
|
1
|
+
# Copyright:: Copyright 2017 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# The Page class contains methods to extract information and modify the
|
5
|
+
# properties of an individual page.
|
6
|
+
#
|
7
|
+
# Note that inside the SketchUp user interface pages are called "Scenes".
|
8
|
+
#
|
9
|
+
# @version SketchUp 6.0
|
10
|
+
class Sketchup::Page < Sketchup::Entity
|
11
|
+
|
12
|
+
# Instance Methods
|
13
|
+
|
14
|
+
# The axes method returns the drawing axes for the page.
|
15
|
+
#
|
16
|
+
# @example
|
17
|
+
# page = Sketchup.active_model.pages.add("Example Page")
|
18
|
+
# xaxis = Geom::Vector3d.new(3, 5, 0)
|
19
|
+
# yaxis = xaxis * Z_AXIS
|
20
|
+
# page.axes.set([10,0,0], xaxis, yaxis, Z_AXIS)
|
21
|
+
#
|
22
|
+
# @return Axes - the axes for the page.
|
23
|
+
#
|
24
|
+
# @version SketchUp 2016
|
25
|
+
def axes
|
26
|
+
end
|
27
|
+
|
28
|
+
# The camera method retrieves the camera for a particular page.
|
29
|
+
#
|
30
|
+
# @example
|
31
|
+
# model = Sketchup.active_model
|
32
|
+
# pages = model.pages
|
33
|
+
# page = pages.add "My Page"
|
34
|
+
# camera = page.camera
|
35
|
+
#
|
36
|
+
# @return camera - a Camera object if successful, nil if the page
|
37
|
+
# does not save camera information
|
38
|
+
#
|
39
|
+
# @version SketchUp 6.0
|
40
|
+
def camera
|
41
|
+
end
|
42
|
+
|
43
|
+
# The delay_time method retrieves the amount of time, in seconds, that a page
|
44
|
+
# will be displayed before transition to another page during a tour.
|
45
|
+
#
|
46
|
+
# The default delay time can be modified in the Model Info > Animation panel
|
47
|
+
# of the SketchUp User Interface. If this method returns -1, the default
|
48
|
+
# delay time is used.
|
49
|
+
#
|
50
|
+
# @example
|
51
|
+
# model = Sketchup.active_model
|
52
|
+
# pages = model.pages
|
53
|
+
# page = pages.add "My Page"
|
54
|
+
# time = page.delay_time
|
55
|
+
#
|
56
|
+
# @return time - the number of seconds of delay
|
57
|
+
#
|
58
|
+
# @version SketchUp 6.0
|
59
|
+
def delay_time
|
60
|
+
end
|
61
|
+
|
62
|
+
# The delay_time= method sets the amount of time, in seconds, that a page will
|
63
|
+
# be displayed before transitioning to another page during a tour. If you set
|
64
|
+
# the delay for a page to be -1, the default delay time will be used.
|
65
|
+
#
|
66
|
+
# The default delay time can be modified in the Model Info > Animation panel
|
67
|
+
# of the SketchUp User Interface.
|
68
|
+
#
|
69
|
+
# @example
|
70
|
+
# model = Sketchup.active_model
|
71
|
+
# pages = model.pages
|
72
|
+
# page = pages.add "My Page"
|
73
|
+
# time = page.delay_time = 10
|
74
|
+
#
|
75
|
+
# @param seconds
|
76
|
+
# The number of seconds to set as the delay time.
|
77
|
+
#
|
78
|
+
# @return time - the number of seconds of delay
|
79
|
+
#
|
80
|
+
# @version SketchUp 6.0
|
81
|
+
def delay_time=(seconds)
|
82
|
+
end
|
83
|
+
|
84
|
+
# The description method retrieves the description for a page as found in the
|
85
|
+
# Scenes manager dialog.
|
86
|
+
#
|
87
|
+
# @example
|
88
|
+
# model = Sketchup.active_model
|
89
|
+
# pages = model.pages
|
90
|
+
# page = pages.add "My Page"
|
91
|
+
# description = page.description
|
92
|
+
#
|
93
|
+
# @return description - a textual description for the page.
|
94
|
+
#
|
95
|
+
# @version SketchUp 6.0
|
96
|
+
def description
|
97
|
+
end
|
98
|
+
|
99
|
+
# The description method sets the description for a page as found in the
|
100
|
+
# Scenes manager dialog.
|
101
|
+
#
|
102
|
+
# @example
|
103
|
+
# model = Sketchup.active_model
|
104
|
+
# pages = model.pages
|
105
|
+
# page = pages.add "My Page"
|
106
|
+
# description = page.description = "This is my first page"
|
107
|
+
#
|
108
|
+
# @param description
|
109
|
+
# A string description for the page.
|
110
|
+
#
|
111
|
+
# @return description - the new string description for the page
|
112
|
+
#
|
113
|
+
# @version SketchUp 6.0
|
114
|
+
def description=(description)
|
115
|
+
end
|
116
|
+
|
117
|
+
# The hidden_entities method retrieves all hidden entities within a page.
|
118
|
+
#
|
119
|
+
# @example
|
120
|
+
# model = Sketchup.active_model
|
121
|
+
# pages = model.pages
|
122
|
+
# page = pages.add "My Page"
|
123
|
+
# entities = page.hidden_entities
|
124
|
+
#
|
125
|
+
# @return entities - an Entities object containing hidden
|
126
|
+
# entities on the page.
|
127
|
+
#
|
128
|
+
# @version SketchUp 6.0
|
129
|
+
def hidden_entities
|
130
|
+
end
|
131
|
+
|
132
|
+
# The label method retrieves the label for a page from the page tab.
|
133
|
+
#
|
134
|
+
# @example
|
135
|
+
# model = Sketchup.active_model
|
136
|
+
# pages = model.pages
|
137
|
+
# page = pages.add "My Page"
|
138
|
+
# label = page.label
|
139
|
+
#
|
140
|
+
# @return label - a string label for the page tab
|
141
|
+
#
|
142
|
+
# @version SketchUp 6.0
|
143
|
+
def label
|
144
|
+
end
|
145
|
+
|
146
|
+
# The layers method retrieves the non-visible layers associated with a page.
|
147
|
+
#
|
148
|
+
# @example
|
149
|
+
# model = Sketchup.active_model
|
150
|
+
# pages = model.pages
|
151
|
+
# page = pages.add "My Page"
|
152
|
+
# layers = page.layers
|
153
|
+
# # layers now contains the layers in the model that are
|
154
|
+
# # set to non-visible on the page
|
155
|
+
#
|
156
|
+
# @return layers - an array with zero or more Layers objects.
|
157
|
+
#
|
158
|
+
# @version SketchUp 6.0
|
159
|
+
def layers
|
160
|
+
end
|
161
|
+
|
162
|
+
# The name method retrieves the name for a page from the page tab.
|
163
|
+
#
|
164
|
+
# @example
|
165
|
+
# model = Sketchup.active_model
|
166
|
+
# pages = model.pages
|
167
|
+
# page = pages.add "My Page"
|
168
|
+
# name = page.name
|
169
|
+
#
|
170
|
+
# @return label - a string name for the page tab
|
171
|
+
#
|
172
|
+
# @version SketchUp 6.0
|
173
|
+
def name
|
174
|
+
end
|
175
|
+
|
176
|
+
# The name= method sets the name for a page's tab.
|
177
|
+
#
|
178
|
+
# @example
|
179
|
+
# model = Sketchup.active_model
|
180
|
+
# pages = model.pages
|
181
|
+
# page = pages.add "My Page"
|
182
|
+
# name = page.name = "Page Name"
|
183
|
+
#
|
184
|
+
# @param name
|
185
|
+
# The name of the page to be set.
|
186
|
+
#
|
187
|
+
# @return name - the name that you have set
|
188
|
+
#
|
189
|
+
# @version SketchUp 6.0
|
190
|
+
def name=(name)
|
191
|
+
end
|
192
|
+
|
193
|
+
# The rendering_options method retrieves a RenderingOptions object for the
|
194
|
+
# page.
|
195
|
+
#
|
196
|
+
# @example
|
197
|
+
# model = Sketchup.active_model
|
198
|
+
# pages = model.pages
|
199
|
+
# page = pages.add "My Page"
|
200
|
+
# renderingoptions = page.rendering_options
|
201
|
+
#
|
202
|
+
# @return renderingoptions - a RenderingOptions object
|
203
|
+
#
|
204
|
+
# @version SketchUp 6.0
|
205
|
+
def rendering_options
|
206
|
+
end
|
207
|
+
|
208
|
+
# The set_visibility method sets the visibility for a layer on a page.
|
209
|
+
#
|
210
|
+
# @example
|
211
|
+
# model = Sketchup.active_model
|
212
|
+
# pages = model.pages
|
213
|
+
# page = pages.add "My Page"
|
214
|
+
# layer = page.layers[0]
|
215
|
+
# visibility = true
|
216
|
+
# page = page.set_visibility layer, visibility
|
217
|
+
#
|
218
|
+
# @param layer
|
219
|
+
# The layer whose visibility you are setting.
|
220
|
+
#
|
221
|
+
# @param visibility
|
222
|
+
# true if you want items on the layer to be visible, false if you do not want items visible.
|
223
|
+
#
|
224
|
+
# @return page - the page whose visibility was set.
|
225
|
+
#
|
226
|
+
# @version SketchUp 6.0
|
227
|
+
def set_visibility(layer, visibility)
|
228
|
+
end
|
229
|
+
|
230
|
+
# The shadow_info method retrieves the ShadowInfo object for the page.
|
231
|
+
#
|
232
|
+
# @example
|
233
|
+
# model = Sketchup.active_model
|
234
|
+
# pages = model.pages
|
235
|
+
# page = pages.add "My Page"
|
236
|
+
# shadowinfo = page.shadow_info
|
237
|
+
#
|
238
|
+
# @return shadowinfo - a ShadowInfo object if successful, nil if
|
239
|
+
# the page does not save shadow information
|
240
|
+
#
|
241
|
+
# @version SketchUp 6.0
|
242
|
+
def shadow_info
|
243
|
+
end
|
244
|
+
|
245
|
+
# The style method retrieves the style associated with the page.
|
246
|
+
#
|
247
|
+
# @example
|
248
|
+
# model = Sketchup.active_model
|
249
|
+
# pages = model.pages
|
250
|
+
# page = pages.add "My Page"
|
251
|
+
# style = page.style
|
252
|
+
#
|
253
|
+
# @return style - the Style object if successful
|
254
|
+
#
|
255
|
+
# @version SketchUp 6.0
|
256
|
+
def style
|
257
|
+
end
|
258
|
+
|
259
|
+
# Get the amount of time that it takes to transition to this page during a
|
260
|
+
# slideshow or animation export. If this value is -1, it means to use the
|
261
|
+
# default transition time.
|
262
|
+
#
|
263
|
+
# @example
|
264
|
+
# model = Sketchup.active_model
|
265
|
+
# pages = model.pages
|
266
|
+
# page = pages.add "My Page"
|
267
|
+
# time = page.transition_time
|
268
|
+
#
|
269
|
+
# @return transitiontime - the amount of time it takes to
|
270
|
+
# transition to this page during a slideshow or animation
|
271
|
+
# export.
|
272
|
+
#
|
273
|
+
# @version SketchUp 6.0
|
274
|
+
def transition_time
|
275
|
+
end
|
276
|
+
|
277
|
+
# The transition_time= method is used to set the transition time.
|
278
|
+
#
|
279
|
+
# @example
|
280
|
+
# model = Sketchup.active_model
|
281
|
+
# pages = model.pages
|
282
|
+
# page = pages.add "My Page"
|
283
|
+
# time = page.transition_time=20
|
284
|
+
#
|
285
|
+
# @param trans_time
|
286
|
+
# The transition time in seconds.
|
287
|
+
#
|
288
|
+
# @return transitiontime - the new transition time
|
289
|
+
#
|
290
|
+
# @version SketchUp 6.0
|
291
|
+
def transition_time=(trans_time)
|
292
|
+
end
|
293
|
+
|
294
|
+
# The update method performs an update on the page properties based on the
|
295
|
+
# current view that the user has. Which parts of the Page get updated are
|
296
|
+
# controlled via an integer whose bits represent which parts to update. You
|
297
|
+
# can determine the integer you need to pass by adding these numbers together:
|
298
|
+
#
|
299
|
+
# - 1 - Camera Location,
|
300
|
+
# - 2 - Drawing Style,
|
301
|
+
# - 4 - Shadow Settings,
|
302
|
+
# - 8 - Axes Location,
|
303
|
+
# - 16 - Hidden Geometry,
|
304
|
+
# - 32 - Visible Layers,
|
305
|
+
# - 64 - Active Section Planes.
|
306
|
+
#
|
307
|
+
# The bit code values are added together to provide the flags value. For
|
308
|
+
# example, to update the Camera Location, Axes Location, and Active Section
|
309
|
+
# Planes properties, the flag would be 73 (1 + 8 + 64).
|
310
|
+
#
|
311
|
+
# @example
|
312
|
+
# model = Sketchup.active_model
|
313
|
+
# pages = model.pages
|
314
|
+
# page = pages.add "My Page"
|
315
|
+
# status = page.update
|
316
|
+
#
|
317
|
+
# # Updates Camera Location (+1), Shadow Settings(+4),
|
318
|
+
# # and Visible Layers (+32).
|
319
|
+
# status = page.update(37)
|
320
|
+
#
|
321
|
+
# @param flags
|
322
|
+
# Integer representing the sum of the bit flags.
|
323
|
+
#
|
324
|
+
# @return status - true if successful, false if unsuccessful
|
325
|
+
#
|
326
|
+
# @version SketchUp 6.0
|
327
|
+
def update(flags)
|
328
|
+
end
|
329
|
+
|
330
|
+
# The use_axes= method sets the page's axes property.
|
331
|
+
#
|
332
|
+
# @example
|
333
|
+
# model = Sketchup.active_model
|
334
|
+
# pages = model.pages
|
335
|
+
# page = pages.add "My Page"
|
336
|
+
# # Set use_axes to false
|
337
|
+
# status = page.use_axes=false
|
338
|
+
#
|
339
|
+
# @param pagesettings
|
340
|
+
# true if you want your page to save this property, false
|
341
|
+
# if you do not want your page to save this property.
|
342
|
+
#
|
343
|
+
# @return status - true if you are saving the property, false if
|
344
|
+
# you are not saving the property.
|
345
|
+
#
|
346
|
+
# @version SketchUp 6.0
|
347
|
+
def use_axes=(pagesettings)
|
348
|
+
end
|
349
|
+
|
350
|
+
# The use_axes? method determines whether you are storing the axes property
|
351
|
+
# with the page.
|
352
|
+
#
|
353
|
+
# @example
|
354
|
+
# model = Sketchup.active_model
|
355
|
+
# pages = model.pages
|
356
|
+
# page = pages.add "My Page"
|
357
|
+
# status = page.use_axes?
|
358
|
+
#
|
359
|
+
# @return status - true if you are storing the this property with
|
360
|
+
# the page, false if you are not storing this property
|
361
|
+
# with the page.
|
362
|
+
#
|
363
|
+
# @return [Boolean]
|
364
|
+
#
|
365
|
+
# @version SketchUp 6.0
|
366
|
+
def use_axes?
|
367
|
+
end
|
368
|
+
|
369
|
+
# The use_camera= method sets the page's camera property.
|
370
|
+
#
|
371
|
+
# @example
|
372
|
+
# model = Sketchup.active_model
|
373
|
+
# pages = model.pages
|
374
|
+
# page = pages.add "My Page"
|
375
|
+
# status = page.use_camera = true
|
376
|
+
#
|
377
|
+
# @param setting
|
378
|
+
# true if you want your page to save this property, false
|
379
|
+
# if you do not want your page to save this property.
|
380
|
+
#
|
381
|
+
# @return status - true if you are saving the property, false if
|
382
|
+
# you are not saving the property.
|
383
|
+
#
|
384
|
+
# @version SketchUp 6.0
|
385
|
+
def use_camera=(setting)
|
386
|
+
end
|
387
|
+
|
388
|
+
# The use_camera? method determines whether you are storing the camera
|
389
|
+
# property with the page.
|
390
|
+
#
|
391
|
+
# @example
|
392
|
+
# model = Sketchup.active_model
|
393
|
+
# pages = model.pages
|
394
|
+
# page = pages.add "My Page"
|
395
|
+
# status = page.use_camera?
|
396
|
+
#
|
397
|
+
# @return status - true if you are storing the this property with
|
398
|
+
# the page, false if you are not storing this property
|
399
|
+
# with the page.
|
400
|
+
#
|
401
|
+
# @return [Boolean]
|
402
|
+
#
|
403
|
+
# @version SketchUp 6.0
|
404
|
+
def use_camera?
|
405
|
+
end
|
406
|
+
|
407
|
+
# The use_hidden= method sets the page's hidden property.
|
408
|
+
#
|
409
|
+
# @example
|
410
|
+
# model = Sketchup.active_model
|
411
|
+
# pages = model.pages
|
412
|
+
# page = pages.add "My Page"
|
413
|
+
# status = page.use_hidden=false
|
414
|
+
#
|
415
|
+
# @param setting
|
416
|
+
# true if you want your page to save this property, false
|
417
|
+
# if you do not want your page to save this property.
|
418
|
+
#
|
419
|
+
# @return status - true if you are saving the property, false if
|
420
|
+
# you are not saving the property.
|
421
|
+
#
|
422
|
+
# @version SketchUp 6.0
|
423
|
+
def use_hidden=(setting)
|
424
|
+
end
|
425
|
+
|
426
|
+
# The use_hidden? method determines whether you are storing the hidden
|
427
|
+
# property with the page.
|
428
|
+
#
|
429
|
+
# @example
|
430
|
+
# model = Sketchup.active_model
|
431
|
+
# pages = model.pages
|
432
|
+
# page = pages.add "My Page"
|
433
|
+
# status = page.use_hidden?
|
434
|
+
#
|
435
|
+
# @return status - true if you are storing the this property with
|
436
|
+
# the page, false if you are not storing this property
|
437
|
+
# with the page.
|
438
|
+
#
|
439
|
+
# @return [Boolean]
|
440
|
+
#
|
441
|
+
# @version SketchUp 6.0
|
442
|
+
def use_hidden?
|
443
|
+
end
|
444
|
+
|
445
|
+
# The use_hidden_layers= method sets the page's hidden layers
|
446
|
+
# property.
|
447
|
+
#
|
448
|
+
# @example
|
449
|
+
# model = Sketchup.active_model
|
450
|
+
# pages = model.pages
|
451
|
+
# page = pages.add "My Page"
|
452
|
+
# status = page.use_hidden_layers = false
|
453
|
+
#
|
454
|
+
# @param setting
|
455
|
+
# true if you want your page to save this property, false
|
456
|
+
# if you do not want your page to save this property.
|
457
|
+
#
|
458
|
+
# @return status - true if you are saving the property, false if
|
459
|
+
# you are not saving the property.
|
460
|
+
#
|
461
|
+
# @version SketchUp 6.0
|
462
|
+
def use_hidden_layers=(setting)
|
463
|
+
end
|
464
|
+
|
465
|
+
# The use_hidden_layers? method determines whether you are storing the hidden
|
466
|
+
# layers property with the page.
|
467
|
+
#
|
468
|
+
# @example
|
469
|
+
# model = Sketchup.active_model
|
470
|
+
# pages = model.pages
|
471
|
+
# page = pages.add "My Page"
|
472
|
+
# status = page.use_hidden_layers?
|
473
|
+
#
|
474
|
+
# @return status - true if you are storing the this property with
|
475
|
+
# the page, false if you are not storing this property
|
476
|
+
# with the page.
|
477
|
+
#
|
478
|
+
# @return [Boolean]
|
479
|
+
#
|
480
|
+
# @version SketchUp 6.0
|
481
|
+
def use_hidden_layers?
|
482
|
+
end
|
483
|
+
|
484
|
+
# The use_rendering_optoins= method sets the page's display
|
485
|
+
# settings property.
|
486
|
+
#
|
487
|
+
# @example
|
488
|
+
# model = Sketchup.active_model
|
489
|
+
# pages = model.pages
|
490
|
+
# page = pages.add "My Page"
|
491
|
+
# status = page.use_rendering_options = false
|
492
|
+
#
|
493
|
+
# @param setting
|
494
|
+
# true if you want your page to save this property, false
|
495
|
+
# if you do not want your page to save this property.
|
496
|
+
#
|
497
|
+
# @return status - true if you are saving the property, false
|
498
|
+
# if you are not saving the property.
|
499
|
+
#
|
500
|
+
# @version SketchUp 6.0
|
501
|
+
def use_rendering_options=(setting)
|
502
|
+
end
|
503
|
+
|
504
|
+
# The use_rendering_options? method determines whether you are storing the
|
505
|
+
# rendering options property with the page.
|
506
|
+
#
|
507
|
+
# @example
|
508
|
+
# model = Sketchup.active_model
|
509
|
+
# pages = model.pages
|
510
|
+
# page = pages.add "My Page"
|
511
|
+
# status = page.use_rendering_options?
|
512
|
+
#
|
513
|
+
# @return status - true if you are storing the this property with
|
514
|
+
# the page, false if you are not storing this property
|
515
|
+
# with the page.
|
516
|
+
#
|
517
|
+
# @return [Boolean]
|
518
|
+
#
|
519
|
+
# @version SketchUp 6.0
|
520
|
+
def use_rendering_options?
|
521
|
+
end
|
522
|
+
|
523
|
+
# The use_section_planes= method sets the page's section planes
|
524
|
+
# property.
|
525
|
+
#
|
526
|
+
# @example
|
527
|
+
# model = Sketchup.active_model
|
528
|
+
# pages = model.pages
|
529
|
+
# page = pages.add "My Page"
|
530
|
+
# status = page.use_section_planes=false
|
531
|
+
#
|
532
|
+
# @param setting
|
533
|
+
# true if you want your page to save this property, false
|
534
|
+
# if you do not want your page to save this property.
|
535
|
+
#
|
536
|
+
# @return status - true if you are saving the property, false if
|
537
|
+
# you are not saving the property.
|
538
|
+
#
|
539
|
+
# @version SketchUp 6.0
|
540
|
+
def use_section_planes=(setting)
|
541
|
+
end
|
542
|
+
|
543
|
+
# The use_section_planes? method determines whether you are storing the
|
544
|
+
# section planes property with the page.
|
545
|
+
#
|
546
|
+
# @example
|
547
|
+
# model = Sketchup.active_model
|
548
|
+
# pages = model.pages
|
549
|
+
# page = pages.add "My Page"
|
550
|
+
# status = page.use_section_planes?
|
551
|
+
#
|
552
|
+
# @return status - true if you are storing the this property with
|
553
|
+
# the page, false if you are not storing this property
|
554
|
+
# with the page.
|
555
|
+
#
|
556
|
+
# @return [Boolean]
|
557
|
+
#
|
558
|
+
# @version SketchUp 6.0
|
559
|
+
def use_section_planes?
|
560
|
+
end
|
561
|
+
|
562
|
+
# The use_shadow_info= method sets the page's shadow info property.
|
563
|
+
#
|
564
|
+
# @example
|
565
|
+
# model = Sketchup.active_model
|
566
|
+
# pages = model.pages
|
567
|
+
# page = pages.add "My Page"
|
568
|
+
# status = page.use_shadow_info=false
|
569
|
+
#
|
570
|
+
# @param setting
|
571
|
+
# true if you want your page to save this property, false
|
572
|
+
# if you do not want your page to save this property.
|
573
|
+
#
|
574
|
+
# @return status - true if you are saving the property, false if
|
575
|
+
# you are not saving the property.
|
576
|
+
#
|
577
|
+
# @version SketchUp 6.0
|
578
|
+
def use_shadow_info=(setting)
|
579
|
+
end
|
580
|
+
|
581
|
+
# The use_shadow_info? method determines whether you are storing the shadow
|
582
|
+
# info property with the page.
|
583
|
+
#
|
584
|
+
# @example
|
585
|
+
# model = Sketchup.active_model
|
586
|
+
# pages = model.pages
|
587
|
+
# page = pages.add "My Page"
|
588
|
+
# status = page.use_shadow_info?
|
589
|
+
#
|
590
|
+
# @return status - true if you are storing the this property with
|
591
|
+
# the page, false if you are not storing this property
|
592
|
+
# with the page.
|
593
|
+
#
|
594
|
+
# @return [Boolean]
|
595
|
+
#
|
596
|
+
# @version SketchUp 6.0
|
597
|
+
def use_shadow_info?
|
598
|
+
end
|
599
|
+
|
600
|
+
# The use_style= method sets the style to be used by the page.
|
601
|
+
#
|
602
|
+
# @example
|
603
|
+
# model = Sketchup.active_model
|
604
|
+
# pages = model.pages
|
605
|
+
# page = pages.add "My Page"
|
606
|
+
# style = model.styles[0]
|
607
|
+
# page.use_style = style
|
608
|
+
#
|
609
|
+
# @param style
|
610
|
+
# The Style object to use.
|
611
|
+
#
|
612
|
+
# @return nil
|
613
|
+
#
|
614
|
+
# @version SketchUp 6.0
|
615
|
+
def use_style=(style)
|
616
|
+
end
|
617
|
+
|
618
|
+
# The use_style? method determines whether storing a style with the page.
|
619
|
+
#
|
620
|
+
# @example
|
621
|
+
# model = Sketchup.active_model
|
622
|
+
# pages = model.pages
|
623
|
+
# page = pages.add "My Page"
|
624
|
+
# use_style = page.use_style?
|
625
|
+
#
|
626
|
+
# @return status - true if you are storing the this property with
|
627
|
+
# the page, false if you are not storing this property
|
628
|
+
# with the page.
|
629
|
+
#
|
630
|
+
# @return [Boolean]
|
631
|
+
#
|
632
|
+
# @version SketchUp 6.0
|
633
|
+
def use_style?
|
634
|
+
end
|
635
|
+
|
636
|
+
end
|