sketchup-api-stubs 0.7.4 → 0.7.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (151) hide show
  1. checksums.yaml +4 -4
  2. data/lib/sketchup-api-stubs/sketchup.rb +148 -145
  3. data/lib/sketchup-api-stubs/stubs/{array.rb → Array.rb} +741 -741
  4. data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +322 -318
  5. data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +172 -172
  6. data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +126 -126
  7. data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +102 -102
  8. data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +400 -400
  9. data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +661 -661
  10. data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +523 -492
  11. data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +478 -478
  12. data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +263 -263
  13. data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +141 -141
  14. data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +522 -522
  15. data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +693 -691
  16. data/lib/sketchup-api-stubs/stubs/{geom.rb → Geom.rb} +351 -348
  17. data/lib/sketchup-api-stubs/stubs/{languagehandler.rb → LanguageHandler.rb} +93 -92
  18. data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +595 -573
  19. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +698 -411
  20. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +183 -174
  21. data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
  22. data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +516 -514
  23. data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
  24. data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +148 -143
  25. data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -353
  26. data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +354 -349
  27. data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +311 -311
  28. data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +261 -261
  29. data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +91 -91
  30. data/lib/sketchup-api-stubs/stubs/Layout/Label.rb +370 -371
  31. data/lib/sketchup-api-stubs/stubs/Layout/Layer.rb +218 -218
  32. data/lib/sketchup-api-stubs/stubs/Layout/LayerInstance.rb +128 -128
  33. data/lib/sketchup-api-stubs/stubs/Layout/Layers.rb +225 -220
  34. data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb +567 -567
  35. data/lib/sketchup-api-stubs/stubs/Layout/LockedEntityError.rb +10 -10
  36. data/lib/sketchup-api-stubs/stubs/Layout/LockedLayerError.rb +11 -11
  37. data/lib/sketchup-api-stubs/stubs/Layout/Page.rb +183 -183
  38. data/lib/sketchup-api-stubs/stubs/Layout/PageInfo.rb +387 -387
  39. data/lib/sketchup-api-stubs/stubs/Layout/Pages.rb +209 -204
  40. data/lib/sketchup-api-stubs/stubs/Layout/Path.rb +344 -344
  41. data/lib/sketchup-api-stubs/stubs/Layout/Rectangle.rb +174 -174
  42. data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +692 -694
  43. data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +1519 -1519
  44. data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +290 -290
  45. data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb +149 -149
  46. data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb +139 -139
  47. data/lib/sketchup-api-stubs/stubs/Layout/TableRow.rb +135 -135
  48. data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
  49. data/lib/sketchup-api-stubs/stubs/{length.rb → Length.rb} +278 -278
  50. data/lib/sketchup-api-stubs/stubs/{numeric.rb → Numeric.rb} +249 -249
  51. data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +144 -140
  52. data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +169 -157
  53. data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +209 -209
  54. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +152 -152
  55. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +286 -281
  56. data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
  57. data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +302 -328
  58. data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +478 -577
  59. data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
  60. data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +122 -122
  61. data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +294 -281
  62. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +619 -562
  63. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +593 -593
  64. data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
  65. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +257 -257
  66. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
  67. data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +201 -194
  68. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +426 -329
  69. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +74 -72
  70. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +104 -102
  71. data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
  72. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +306 -312
  73. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +42 -38
  74. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
  75. data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +396 -390
  76. data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +502 -508
  77. data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
  78. data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1205 -1119
  79. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesBuilder.rb +272 -0
  80. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +127 -125
  81. data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +545 -544
  82. data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +60 -59
  83. data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +126 -125
  84. data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +937 -750
  85. data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +104 -104
  86. data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +750 -697
  87. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +292 -285
  88. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
  89. data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
  90. data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +468 -409
  91. data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +266 -226
  92. data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +189 -190
  93. data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +407 -393
  94. data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +84 -82
  95. data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +306 -303
  96. data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +326 -285
  97. data/lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb +422 -0
  98. data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +427 -244
  99. data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +249 -136
  100. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
  101. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +48 -48
  102. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
  103. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +112 -112
  104. data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
  105. data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +414 -416
  106. data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +318 -311
  107. data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +142 -141
  108. data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +93 -95
  109. data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1651 -1638
  110. data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +357 -356
  111. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +131 -132
  112. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +284 -284
  113. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
  114. data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +797 -770
  115. data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +363 -353
  116. data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +77 -76
  117. data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +477 -456
  118. data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
  119. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +364 -364
  120. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +45 -44
  121. data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
  122. data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +459 -454
  123. data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +115 -115
  124. data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +212 -212
  125. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +260 -257
  126. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +59 -57
  127. data/lib/sketchup-api-stubs/stubs/Sketchup/Skp.rb +40 -0
  128. data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
  129. data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +217 -211
  130. data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
  131. data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +217 -225
  132. data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
  133. data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +837 -829
  134. data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
  135. data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +156 -154
  136. data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +75 -61
  137. data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
  138. data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1317 -1301
  139. data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +45 -43
  140. data/lib/sketchup-api-stubs/stubs/{sketchup.rb → Sketchup.rb} +1360 -1310
  141. data/lib/sketchup-api-stubs/stubs/{sketchupextension.rb → SketchupExtension.rb} +353 -353
  142. data/lib/sketchup-api-stubs/stubs/{string.rb → String.rb} +24 -24
  143. data/lib/sketchup-api-stubs/stubs/UI/Command.rb +389 -310
  144. data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +496 -356
  145. data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +269 -229
  146. data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +240 -240
  147. data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +635 -633
  148. data/lib/sketchup-api-stubs/stubs/{ui.rb → UI.rb} +683 -667
  149. data/lib/sketchup-api-stubs/stubs/_top_level.rb +311 -311
  150. data/lib/sketchup-api-stubs.rb +1 -1
  151. metadata +15 -12
@@ -1,770 +1,797 @@
1
- # Copyright:: Copyright 2020 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 {#get_drawingelement_visibility} method is used to get the visibility
118
- # of a drawing element on a particular page.
119
- #
120
- # @example
121
- # model = Sketchup.active_model
122
- # entities = model.active_entities
123
- # point1 = Geom::Point3d.new(10,0,0)
124
- # constpoint = entities.add_cpoint(point1)
125
- # pages = model.pages
126
- # page = pages.add("My Page")
127
- # result = page.get_drawingelement_visibility(constpoint)
128
- #
129
- # @param [Sketchup::Drawingelement] element
130
- #
131
- # @return [Boolean] - true if visible, false if not.
132
- #
133
- # @version SketchUp 2020.0
134
- def get_drawingelement_visibility(element)
135
- end
136
-
137
- # The hidden_entities method retrieves all hidden entities within a page.
138
- #
139
- # @example
140
- # model = Sketchup.active_model
141
- # pages = model.pages
142
- # page = pages.add "My Page"
143
- # entities = page.hidden_entities
144
- #
145
- # @return entities - an Entities object containing hidden
146
- # entities on the page.
147
- #
148
- # @version SketchUp 6.0
149
- def hidden_entities
150
- end
151
-
152
- # The {#include_in_animation=} method controls whether the page should be
153
- # included when exporting an animation from the model.
154
- #
155
- # @example Turn off animation for all pages.
156
- # model = Sketchup.active_model
157
- # model.pages.each { |page|
158
- # page.include_in_animation = false
159
- # }
160
- #
161
- # @param [Boolean] include
162
- #
163
- # @return [Sketchup::Page]
164
- #
165
- # @version SketchUp 2018
166
- def include_in_animation=(include)
167
- end
168
-
169
- # The {#include_in_animation?} method determines whether the page should be
170
- # included when exporting an animation from the model.
171
- #
172
- # @example Toggle inclusion in animation for all pages.
173
- # model = Sketchup.active_model
174
- # in_animation = model.pages.select { |page| page.include_in_animation? }
175
- #
176
- # @return [Boolean]
177
- #
178
- # @version SketchUp 2018
179
- def include_in_animation?
180
- end
181
-
182
- # The label method retrieves the label for a page from the page tab.
183
- #
184
- # @example
185
- # model = Sketchup.active_model
186
- # pages = model.pages
187
- # page = pages.add "My Page"
188
- # label = page.label
189
- #
190
- # @return label - a string label for the page tab
191
- #
192
- # @version SketchUp 6.0
193
- def label
194
- end
195
-
196
- # The layers method retrieves the non-visible layers associated with a page.
197
- #
198
- # @example
199
- # model = Sketchup.active_model
200
- # pages = model.pages
201
- # page = pages.add "My Page"
202
- # layers = page.layers
203
- # # layers now contains the layers in the model that are
204
- # # set to non-visible on the page
205
- #
206
- # @return layers - an array with zero or more Layers objects.
207
- #
208
- # @version SketchUp 6.0
209
- def layers
210
- end
211
-
212
- # The name method retrieves the name for a page from the page tab.
213
- #
214
- # @example
215
- # model = Sketchup.active_model
216
- # pages = model.pages
217
- # page = pages.add "My Page"
218
- # name = page.name
219
- #
220
- # @return label - a string name for the page tab
221
- #
222
- # @version SketchUp 6.0
223
- def name
224
- end
225
-
226
- # The name= method sets the name for a page's tab.
227
- #
228
- # @example
229
- # model = Sketchup.active_model
230
- # pages = model.pages
231
- # page = pages.add "My Page"
232
- # name = page.name = "Page Name"
233
- #
234
- # @param name
235
- # The name of the page to be set.
236
- #
237
- # @return name - the name that you have set
238
- #
239
- # @version SketchUp 6.0
240
- def name=(name)
241
- end
242
-
243
- # The rendering_options method retrieves a RenderingOptions object for the
244
- # page.
245
- #
246
- # @example
247
- # model = Sketchup.active_model
248
- # pages = model.pages
249
- # page = pages.add "My Page"
250
- # renderingoptions = page.rendering_options
251
- #
252
- # @return renderingoptions - a RenderingOptions object
253
- #
254
- # @version SketchUp 6.0
255
- def rendering_options
256
- end
257
-
258
- # The {#set_drawingelement_visibility} method is used to change the visibility
259
- # of a drawing element on a particular page. Only drawing elements on the root
260
- # of the model, as well as nested instances of components, groups, and images
261
- # are controlled by Page visibility.
262
- #
263
- # @example
264
- # model = Sketchup.active_model
265
- # entities = model.active_entities
266
- # point1 = Geom::Point3d.new(10, 0, 0)
267
- # constpoint = entities.add_cpoint(point1)
268
- # pages = model.pages
269
- # page = pages.add("My Page")
270
- # page.set_drawingelement_visibility(constpoint, false)
271
- #
272
- # @param [Sketchup::Drawingelement] element
273
- #
274
- # @param [Boolean] visibility
275
- #
276
- # @return [Boolean]
277
- #
278
- # @version SketchUp 2020.0
279
- def set_drawingelement_visibility(element, visibility)
280
- end
281
-
282
- # The set_visibility method sets the visibility for a layer on a page.
283
- #
284
- # @example
285
- # model = Sketchup.active_model
286
- # pages = model.pages
287
- # page = pages.add "My Page"
288
- # layer = page.layers[0]
289
- # visibility = true
290
- # page = page.set_visibility layer, visibility
291
- #
292
- # @param layer
293
- # The layer whose visibility you are setting.
294
- #
295
- # @param visibility
296
- # true if you want items on the layer to be visible, false if you do not want items visible.
297
- #
298
- # @return page - the page whose visibility was set.
299
- #
300
- # @version SketchUp 6.0
301
- def set_visibility(layer, visibility)
302
- end
303
-
304
- # The shadow_info method retrieves the ShadowInfo object for the page.
305
- #
306
- # @example
307
- # model = Sketchup.active_model
308
- # pages = model.pages
309
- # page = pages.add "My Page"
310
- # shadowinfo = page.shadow_info
311
- #
312
- # @return shadowinfo - a ShadowInfo object if successful, nil if
313
- # the page does not save shadow information
314
- #
315
- # @version SketchUp 6.0
316
- def shadow_info
317
- end
318
-
319
- # The style method retrieves the style associated with the page.
320
- #
321
- # @example
322
- # model = Sketchup.active_model
323
- # pages = model.pages
324
- # page = pages.add "My Page"
325
- # style = page.style
326
- #
327
- # @return style - the Style object if successful
328
- #
329
- # @version SketchUp 6.0
330
- def style
331
- end
332
-
333
- # Get the amount of time that it takes to transition to this page during a
334
- # slideshow or animation export. If this value is -1, it means to use the
335
- # default transition time.
336
- #
337
- # @example
338
- # model = Sketchup.active_model
339
- # pages = model.pages
340
- # page = pages.add "My Page"
341
- # time = page.transition_time
342
- #
343
- # @return transitiontime - the amount of time it takes to
344
- # transition to this page during a slideshow or animation
345
- # export.
346
- #
347
- # @version SketchUp 6.0
348
- def transition_time
349
- end
350
-
351
- # The transition_time= method is used to set the transition time.
352
- #
353
- # @example
354
- # model = Sketchup.active_model
355
- # pages = model.pages
356
- # page = pages.add "My Page"
357
- # time = page.transition_time=20
358
- #
359
- # @param trans_time
360
- # The transition time in seconds.
361
- #
362
- # @return transitiontime - the new transition time
363
- #
364
- # @version SketchUp 6.0
365
- def transition_time=(trans_time)
366
- end
367
-
368
- # The update method performs an update on the page properties based on the
369
- # current view that the user has. Which parts of the Page get updated are
370
- # controlled via an integer whose bits represent which parts to update. You
371
- # can determine the integer you need to pass by adding these numbers together:
372
- #
373
- # - 1 - Camera Location,
374
- # - 2 - Drawing Style,
375
- # - 4 - Shadow Settings,
376
- # - 8 - Axes Location,
377
- # - 16 - Hidden Geometry & Objects,
378
- # - 32 - Visible Layers,
379
- # - 64 - Active Section Planes,
380
- # - 128 - Hidden Geometry,
381
- # - 256 - Hidden Objects
382
- #
383
- # The bit code values are added together to provide the flags value. For
384
- # example, to update the Camera Location, Axes Location, and Active Section
385
- # Planes properties, the flag would be 73 (1 + 8 + 64).
386
- #
387
- # @example
388
- # model = Sketchup.active_model
389
- # pages = model.pages
390
- # page = pages.add "My Page"
391
- # status = page.update
392
- #
393
- # # Updates Camera Location (+1), Shadow Settings(+4),
394
- # # and Visible Layers (+32).
395
- # status = page.update(37)
396
- #
397
- # @param flags
398
- # Integer representing the sum of the bit flags.
399
- #
400
- # @return status - true if successful, false if unsuccessful
401
- #
402
- # @version SketchUp 6.0
403
- def update(flags)
404
- end
405
-
406
- # The use_axes= method sets the page's axes property.
407
- #
408
- # @example
409
- # model = Sketchup.active_model
410
- # pages = model.pages
411
- # page = pages.add "My Page"
412
- # # Set use_axes to false
413
- # status = page.use_axes=false
414
- #
415
- # @param pagesettings
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_axes=(pagesettings)
424
- end
425
-
426
- # The use_axes? method determines whether you are storing the axes property
427
- # 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_axes?
434
- #
435
- # @return [Boolean] 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
- # @version SketchUp 6.0
440
- def use_axes?
441
- end
442
-
443
- # The use_camera= method sets the page's camera property.
444
- #
445
- # @example
446
- # model = Sketchup.active_model
447
- # pages = model.pages
448
- # page = pages.add "My Page"
449
- # status = page.use_camera = true
450
- #
451
- # @param setting
452
- # true if you want your page to save this property, false
453
- # if you do not want your page to save this property.
454
- #
455
- # @return status - true if you are saving the property, false if
456
- # you are not saving the property.
457
- #
458
- # @version SketchUp 6.0
459
- def use_camera=(setting)
460
- end
461
-
462
- # The use_camera? method determines whether you are storing the camera
463
- # property with the page.
464
- #
465
- # @example
466
- # model = Sketchup.active_model
467
- # pages = model.pages
468
- # page = pages.add "My Page"
469
- # status = page.use_camera?
470
- #
471
- # @return [Boolean] status - true if you are storing the this property with
472
- # the page, false if you are not storing this property
473
- # with the page.
474
- #
475
- # @version SketchUp 6.0
476
- def use_camera?
477
- end
478
-
479
- # The use_hidden= method sets the page's hidden property.
480
- #
481
- # @deprecated The functionality is replaced by {use_hidden_geometry=}
482
- # and {use_hidden_objects=} in SketchUp 2020.1.
483
- #
484
- # @example
485
- # model = Sketchup.active_model
486
- # pages = model.pages
487
- # page = pages.add "My Page"
488
- # status = page.use_hidden = false
489
- #
490
- # @param setting
491
- # true if you want your page to save this property, false
492
- # if you do not want your page to save this property.
493
- #
494
- # @return status - true if you are saving the property, false if
495
- # you are not saving the property.
496
- #
497
- # @see #use_hidden_geometry=
498
- #
499
- # @see #use_hidden_objects=
500
- #
501
- # @version SketchUp 6.0
502
- def use_hidden=(setting)
503
- end
504
-
505
- # The use_hidden? method determines whether you are storing the hidden
506
- # property with the page.
507
- #
508
- # @deprecated The functionality is replaced by {use_hidden_geometry?}
509
- # and {use_hidden_objects?} in SketchUp 2020.1.
510
- #
511
- # @example
512
- # model = Sketchup.active_model
513
- # pages = model.pages
514
- # page = pages.add("My Page")
515
- # status = page.use_hidden?
516
- #
517
- # @return [Boolean] status - true if you are storing the this property with
518
- # the page, false if you are not storing this property
519
- # with the page.
520
- #
521
- # @see #use_hidden_geometry?
522
- #
523
- # @see #use_hidden_objects?
524
- #
525
- # @version SketchUp 6.0
526
- def use_hidden?
527
- end
528
-
529
- # Sets the page's use hidden geometry property.
530
- #
531
- # @example
532
- # model = Sketchup.active_model
533
- # pages = model.pages
534
- # page = pages.add("My Page")
535
- # status = page.use_hidden_geometry = false
536
- #
537
- # @param [Boolean] setting
538
- # `true` if you want your page to save this property,
539
- # `false` if you do not want your page to save this property.
540
- #
541
- # @version SketchUp 2020.1
542
- def use_hidden_geometry=(setting)
543
- end
544
-
545
- # Returns the use hidden geometry property from the page.
546
- #
547
- # @example
548
- # model = Sketchup.active_model
549
- # pages = model.pages
550
- # page = pages.add("My Page")
551
- # status = page.use_hidden_geometry?
552
- #
553
- # @return [Boolean]
554
- #
555
- # @version SketchUp 2020.1
556
- def use_hidden_geometry?
557
- end
558
-
559
- # The use_hidden_layers= method sets the page's hidden layers
560
- # property.
561
- #
562
- # @example
563
- # model = Sketchup.active_model
564
- # pages = model.pages
565
- # page = pages.add "My Page"
566
- # status = page.use_hidden_layers = false
567
- #
568
- # @param setting
569
- # true if you want your page to save this property, false
570
- # if you do not want your page to save this property.
571
- #
572
- # @return status - true if you are saving the property, false if
573
- # you are not saving the property.
574
- #
575
- # @version SketchUp 6.0
576
- def use_hidden_layers=(setting)
577
- end
578
-
579
- # The use_hidden_layers? method determines whether you are storing the hidden
580
- # layers property with the page.
581
- #
582
- # @example
583
- # model = Sketchup.active_model
584
- # pages = model.pages
585
- # page = pages.add "My Page"
586
- # status = page.use_hidden_layers?
587
- #
588
- # @return [Boolean] status - true if you are storing the this property with
589
- # the page, false if you are not storing this property
590
- # with the page.
591
- #
592
- # @version SketchUp 6.0
593
- def use_hidden_layers?
594
- end
595
-
596
- # Sets the page's use hidden objects property.
597
- #
598
- # @example
599
- # model = Sketchup.active_model
600
- # pages = model.pages
601
- # page = pages.add("My Page")
602
- # status = page.use_hidden_objects = false
603
- #
604
- # @param [Boolean] setting
605
- # `true` if you want your page to save this property,
606
- # `false` if you do not want your page to save this property.
607
- #
608
- # @version SketchUp 2020.1
609
- def use_hidden_objects=(setting)
610
- end
611
-
612
- # Returns the use hidden objects property from the page.
613
- #
614
- # @example
615
- # model = Sketchup.active_model
616
- # pages = model.pages
617
- # page = pages.add("My Page")
618
- # status = page.use_hidden_objects?
619
- #
620
- # @return [Boolean]
621
- #
622
- # @version SketchUp 2020.1
623
- def use_hidden_objects?
624
- end
625
-
626
- # The use_rendering_optoins= method sets the page's display
627
- # settings property.
628
- #
629
- # @example
630
- # model = Sketchup.active_model
631
- # pages = model.pages
632
- # page = pages.add "My Page"
633
- # status = page.use_rendering_options = false
634
- #
635
- # @param setting
636
- # true if you want your page to save this property, false
637
- # if you do not want your page to save this property.
638
- #
639
- # @return status - true if you are saving the property, false
640
- # if you are not saving the property.
641
- #
642
- # @version SketchUp 6.0
643
- def use_rendering_options=(setting)
644
- end
645
-
646
- # The use_rendering_options? method determines whether you are storing the
647
- # rendering options property with the page.
648
- #
649
- # @example
650
- # model = Sketchup.active_model
651
- # pages = model.pages
652
- # page = pages.add "My Page"
653
- # status = page.use_rendering_options?
654
- #
655
- # @return [Boolean] status - true if you are storing the this property with
656
- # the page, false if you are not storing this property
657
- # with the page.
658
- #
659
- # @version SketchUp 6.0
660
- def use_rendering_options?
661
- end
662
-
663
- # The use_section_planes= method sets the page's section planes
664
- # property.
665
- #
666
- # @example
667
- # model = Sketchup.active_model
668
- # pages = model.pages
669
- # page = pages.add "My Page"
670
- # status = page.use_section_planes=false
671
- #
672
- # @param setting
673
- # true if you want your page to save this property, false
674
- # if you do not want your page to save this property.
675
- #
676
- # @return status - true if you are saving the property, false if
677
- # you are not saving the property.
678
- #
679
- # @version SketchUp 6.0
680
- def use_section_planes=(setting)
681
- end
682
-
683
- # The use_section_planes? method determines whether you are storing the
684
- # section planes property with the page.
685
- #
686
- # @example
687
- # model = Sketchup.active_model
688
- # pages = model.pages
689
- # page = pages.add "My Page"
690
- # status = page.use_section_planes?
691
- #
692
- # @return [Boolean] status - true if you are storing the this property with
693
- # the page, false if you are not storing this property
694
- # with the page.
695
- #
696
- # @version SketchUp 6.0
697
- def use_section_planes?
698
- end
699
-
700
- # The use_shadow_info= method sets the page's shadow info property.
701
- #
702
- # @example
703
- # model = Sketchup.active_model
704
- # pages = model.pages
705
- # page = pages.add "My Page"
706
- # status = page.use_shadow_info=false
707
- #
708
- # @param setting
709
- # true if you want your page to save this property, false
710
- # if you do not want your page to save this property.
711
- #
712
- # @return status - true if you are saving the property, false if
713
- # you are not saving the property.
714
- #
715
- # @version SketchUp 6.0
716
- def use_shadow_info=(setting)
717
- end
718
-
719
- # The use_shadow_info? method determines whether you are storing the shadow
720
- # info property with the page.
721
- #
722
- # @example
723
- # model = Sketchup.active_model
724
- # pages = model.pages
725
- # page = pages.add "My Page"
726
- # status = page.use_shadow_info?
727
- #
728
- # @return [Boolean] status - true if you are storing the this property with
729
- # the page, false if you are not storing this property
730
- # with the page.
731
- #
732
- # @version SketchUp 6.0
733
- def use_shadow_info?
734
- end
735
-
736
- # The use_style= method sets the style to be used by the page.
737
- #
738
- # @example
739
- # model = Sketchup.active_model
740
- # pages = model.pages
741
- # page = pages.add "My Page"
742
- # style = model.styles[0]
743
- # page.use_style = style
744
- #
745
- # @param style
746
- # The Style object to use.
747
- #
748
- # @return nil
749
- #
750
- # @version SketchUp 6.0
751
- def use_style=(style)
752
- end
753
-
754
- # The use_style? method determines whether storing a style with the page.
755
- #
756
- # @example
757
- # model = Sketchup.active_model
758
- # pages = model.pages
759
- # page = pages.add "My Page"
760
- # use_style = page.use_style?
761
- #
762
- # @return [Boolean] status - true if you are storing the this property with
763
- # the page, false if you are not storing this property
764
- # with the page.
765
- #
766
- # @version SketchUp 6.0
767
- def use_style?
768
- end
769
-
770
- end
1
+ # Copyright:: Copyright 2022 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 {#get_drawingelement_visibility} method is used to get the visibility
118
+ # of a drawing element on a particular page.
119
+ #
120
+ # @example
121
+ # model = Sketchup.active_model
122
+ # entities = model.active_entities
123
+ # point1 = Geom::Point3d.new(10,0,0)
124
+ # constpoint = entities.add_cpoint(point1)
125
+ # pages = model.pages
126
+ # page = pages.add("My Page")
127
+ # result = page.get_drawingelement_visibility(constpoint)
128
+ #
129
+ # @param [Sketchup::Drawingelement] element
130
+ #
131
+ # @return [Boolean] - true if visible, false if not.
132
+ #
133
+ # @version SketchUp 2020.0
134
+ def get_drawingelement_visibility(element)
135
+ end
136
+
137
+ # The hidden_entities method retrieves all hidden entities within a page.
138
+ #
139
+ # @example
140
+ # model = Sketchup.active_model
141
+ # pages = model.pages
142
+ # page = pages.add "My Page"
143
+ # entities = page.hidden_entities
144
+ #
145
+ # @return entities - an Entities object containing hidden
146
+ # entities on the page.
147
+ #
148
+ # @version SketchUp 6.0
149
+ def hidden_entities
150
+ end
151
+
152
+ # The {#include_in_animation=} method controls whether the page should be
153
+ # included when exporting an animation from the model.
154
+ #
155
+ # @example Turn off animation for all pages.
156
+ # model = Sketchup.active_model
157
+ # model.pages.each { |page|
158
+ # page.include_in_animation = false
159
+ # }
160
+ #
161
+ # @param [Boolean] include
162
+ #
163
+ # @return [Sketchup::Page]
164
+ #
165
+ # @version SketchUp 2018
166
+ def include_in_animation=(include)
167
+ end
168
+
169
+ # The {#include_in_animation?} method determines whether the page should be
170
+ # included when exporting an animation from the model.
171
+ #
172
+ # @example
173
+ # model = Sketchup.active_model
174
+ # in_animation = model.pages.select { |page| page.include_in_animation? }
175
+ #
176
+ # @return [Boolean]
177
+ #
178
+ # @version SketchUp 2018
179
+ def include_in_animation?
180
+ end
181
+
182
+ # The label method retrieves the label for a page from the page tab.
183
+ #
184
+ # @example
185
+ # model = Sketchup.active_model
186
+ # pages = model.pages
187
+ # page = pages.add "My Page"
188
+ # label = page.label
189
+ #
190
+ # @return label - a string label for the page tab
191
+ #
192
+ # @version SketchUp 6.0
193
+ def label
194
+ end
195
+
196
+ # The {#layer_folders} method retrieves the hidden layer folders
197
+ # associated with a page.
198
+ #
199
+ # @example
200
+ # model = Sketchup.active_model
201
+ # pages = model.pages
202
+ # page = pages.add("My Page")
203
+ # folders = page.layer_folders
204
+ #
205
+ # @return [Array<Sketchup::LayerFolder>, nil] Returns +nil+ if {#use_hidden_layers?}
206
+ # returns +false+
207
+ #
208
+ # @version SketchUp 2021.0
209
+ def layer_folders
210
+ end
211
+
212
+ # The {#layers} method retrieves layers that don't use their default visibility
213
+ # on this page.
214
+ #
215
+ # @example
216
+ # model = Sketchup.active_model
217
+ # pages = model.pages
218
+ # page = pages.add("My Page")
219
+ # layers = page.layers
220
+ #
221
+ # @example Test layer visibility
222
+ # def visible_in_scene?(layer, scene)
223
+ # scene.layers.include?(layer) == hidden_by_default?(layer)
224
+ # end
225
+ #
226
+ # def hidden_by_default?(layer)
227
+ # layer.page_behavior & LAYER_HIDDEN_BY_DEFAULT == LAYER_HIDDEN_BY_DEFAULT
228
+ # end
229
+ #
230
+ # @return [Array<Sketchup::Layer>, nil] Returns +nil+ if {#use_hidden_layers?}
231
+ # returns +false+
232
+ #
233
+ # @version SketchUp 6.0
234
+ def layers
235
+ end
236
+
237
+ # The name method retrieves the name for a page from the page tab.
238
+ #
239
+ # @example
240
+ # model = Sketchup.active_model
241
+ # pages = model.pages
242
+ # page = pages.add "My Page"
243
+ # name = page.name
244
+ #
245
+ # @return label - a string name for the page tab
246
+ #
247
+ # @version SketchUp 6.0
248
+ def name
249
+ end
250
+
251
+ # The name= method sets the name for a page's tab.
252
+ #
253
+ # @example
254
+ # model = Sketchup.active_model
255
+ # pages = model.pages
256
+ # page = pages.add "My Page"
257
+ # name = page.name = "Page Name"
258
+ #
259
+ # @param name
260
+ # The name of the page to be set.
261
+ #
262
+ # @return name - the name that you have set
263
+ #
264
+ # @version SketchUp 6.0
265
+ def name=(name)
266
+ end
267
+
268
+ # The rendering_options method retrieves a RenderingOptions object for the
269
+ # page.
270
+ #
271
+ # @example
272
+ # model = Sketchup.active_model
273
+ # pages = model.pages
274
+ # page = pages.add "My Page"
275
+ # renderingoptions = page.rendering_options
276
+ #
277
+ # @return renderingoptions - a RenderingOptions object
278
+ #
279
+ # @version SketchUp 6.0
280
+ def rendering_options
281
+ end
282
+
283
+ # The {#set_drawingelement_visibility} method is used to change the visibility
284
+ # of a drawing element on a particular page. Only drawing elements on the root
285
+ # of the model, as well as nested instances of components, groups, and images
286
+ # are controlled by Page visibility.
287
+ #
288
+ # @example
289
+ # model = Sketchup.active_model
290
+ # entities = model.active_entities
291
+ # point1 = Geom::Point3d.new(10, 0, 0)
292
+ # constpoint = entities.add_cpoint(point1)
293
+ # pages = model.pages
294
+ # page = pages.add("My Page")
295
+ # page.set_drawingelement_visibility(constpoint, false)
296
+ #
297
+ # @param [Sketchup::Drawingelement] element
298
+ #
299
+ # @param [Boolean] visibility
300
+ #
301
+ # @return [Boolean]
302
+ #
303
+ # @version SketchUp 2020.0
304
+ def set_drawingelement_visibility(element, visibility)
305
+ end
306
+
307
+ # The {#set_visibility} method sets the visibility for a layer or
308
+ # layer folder on a page.
309
+ #
310
+ # @example
311
+ # model = Sketchup.active_model
312
+ # pages = model.pages
313
+ # page = pages.add("My Page")
314
+ # layer = model.layers.add("My Layer")
315
+ # page.set_visibility(layer, false)
316
+ #
317
+ # @overload set_visibility(layer, visible_for_page)
318
+ #
319
+ # @param [Sketchup::Layer] layer
320
+ # @param [Boolean] visible_for_page
321
+ #
322
+ # @overload set_visibility(layer_folder, visible_for_page)
323
+ #
324
+ # @version SketchUp 2021.0
325
+ # @param [Sketchup::LayerFolder] layer_folder
326
+ # @param [Boolean] visible_for_page
327
+ #
328
+ # @return [Sketchup::Page] the page whose visibility was set.
329
+ #
330
+ # @version SketchUp 6.0
331
+ def set_visibility(arg1, arg2)
332
+ end
333
+
334
+ # The shadow_info method retrieves the ShadowInfo object for the page.
335
+ #
336
+ # @example
337
+ # model = Sketchup.active_model
338
+ # pages = model.pages
339
+ # page = pages.add "My Page"
340
+ # shadowinfo = page.shadow_info
341
+ #
342
+ # @return shadowinfo - a ShadowInfo object if successful, nil if
343
+ # the page does not save shadow information
344
+ #
345
+ # @version SketchUp 6.0
346
+ def shadow_info
347
+ end
348
+
349
+ # The style method retrieves the style associated with the page.
350
+ #
351
+ # @example
352
+ # model = Sketchup.active_model
353
+ # pages = model.pages
354
+ # page = pages.add "My Page"
355
+ # style = page.style
356
+ #
357
+ # @return style - the Style object if successful
358
+ #
359
+ # @version SketchUp 6.0
360
+ def style
361
+ end
362
+
363
+ # Get the amount of time that it takes to transition to this page during a
364
+ # slideshow or animation export. If this value is -1, it means to use the
365
+ # default transition time.
366
+ #
367
+ # @example
368
+ # model = Sketchup.active_model
369
+ # pages = model.pages
370
+ # page = pages.add "My Page"
371
+ # time = page.transition_time
372
+ #
373
+ # @return transitiontime - the amount of time it takes to
374
+ # transition to this page during a slideshow or animation
375
+ # export.
376
+ #
377
+ # @version SketchUp 6.0
378
+ def transition_time
379
+ end
380
+
381
+ # The transition_time= method is used to set the transition time.
382
+ #
383
+ # @example
384
+ # model = Sketchup.active_model
385
+ # pages = model.pages
386
+ # page = pages.add "My Page"
387
+ # time = page.transition_time=20
388
+ #
389
+ # @param trans_time
390
+ # The transition time in seconds.
391
+ #
392
+ # @return transitiontime - the new transition time
393
+ #
394
+ # @version SketchUp 6.0
395
+ def transition_time=(trans_time)
396
+ end
397
+
398
+ # The {#update} method performs an update on the page properties based on the
399
+ # current view that the user has. What properties of the Page get updated are
400
+ # controlled via an integer whose bits corresponds to different properties.
401
+ # These flags can be used individually or combined using bitwise OR.
402
+ #
403
+ # PAGE_USE_CAMERA # Camera Location
404
+ # PAGE_USE_RENDERING_OPTIONS # Drawing Style
405
+ # PAGE_USE_SHADOWINFO # Shadow Setting
406
+ # PAGE_USE_SKETCHCS # Axes Location
407
+ # PAGE_USE_HIDDEN # Hidden Geometry & Objects (Up 2019 and older)
408
+ # PAGE_USE_HIDDEN_GEOMETRY # Hidden Geometry (SU 2020 and later)
409
+ # PAGE_USE_HIDDEN_OBJECTS # Hidden Objects (SU 2020 and later)
410
+ # PAGE_USE_LAYER_VISIBILITY # Visible Layers
411
+ # PAGE_USE_SECTION_PLANES # Active Section Planes
412
+ # PAGE_USE_ALL # All possible scene properties
413
+ #
414
+ # @example
415
+ # model = Sketchup.active_model
416
+ # pages = model.pages
417
+ # page = pages.add "My Page"
418
+ # status = page.update
419
+ #
420
+ # # Updates Camera Location, Shadow Settings and Visible Layers.
421
+ # flags = PAGE_USE_CAMERA | PAGE_USE_SHADOWINFO | PAGE_USE_LAYER_VISIBILITY
422
+ # status = page.update(flags)
423
+ #
424
+ # @param [Integer] flags
425
+ # The bitwise OR of the bit flags.
426
+ #
427
+ # @return [Boolean]
428
+ #
429
+ # @version SketchUp 6.0
430
+ def update(flags)
431
+ end
432
+
433
+ # The use_axes= method sets the page's axes property.
434
+ #
435
+ # @example
436
+ # model = Sketchup.active_model
437
+ # pages = model.pages
438
+ # page = pages.add "My Page"
439
+ # # Set use_axes to false
440
+ # status = page.use_axes=false
441
+ #
442
+ # @param pagesettings
443
+ # true if you want your page to save this property, false
444
+ # if you do not want your page to save this property.
445
+ #
446
+ # @return status - true if you are saving the property, false if
447
+ # you are not saving the property.
448
+ #
449
+ # @version SketchUp 6.0
450
+ def use_axes=(pagesettings)
451
+ end
452
+
453
+ # The use_axes? method determines whether you are storing the axes property
454
+ # with the page.
455
+ #
456
+ # @example
457
+ # model = Sketchup.active_model
458
+ # pages = model.pages
459
+ # page = pages.add "My Page"
460
+ # status = page.use_axes?
461
+ #
462
+ # @return [Boolean] status - true if you are storing the this property with
463
+ # the page, false if you are not storing this property
464
+ # with the page.
465
+ #
466
+ # @version SketchUp 6.0
467
+ def use_axes?
468
+ end
469
+
470
+ # The use_camera= method sets the page's camera property.
471
+ #
472
+ # @example
473
+ # model = Sketchup.active_model
474
+ # pages = model.pages
475
+ # page = pages.add "My Page"
476
+ # status = page.use_camera = true
477
+ #
478
+ # @param setting
479
+ # true if you want your page to save this property, false
480
+ # if you do not want your page to save this property.
481
+ #
482
+ # @return status - true if you are saving the property, false if
483
+ # you are not saving the property.
484
+ #
485
+ # @version SketchUp 6.0
486
+ def use_camera=(setting)
487
+ end
488
+
489
+ # The use_camera? method determines whether you are storing the camera
490
+ # property with the page.
491
+ #
492
+ # @example
493
+ # model = Sketchup.active_model
494
+ # pages = model.pages
495
+ # page = pages.add "My Page"
496
+ # status = page.use_camera?
497
+ #
498
+ # @return [Boolean] status - true if you are storing the this property with
499
+ # the page, false if you are not storing this property
500
+ # with the page.
501
+ #
502
+ # @version SketchUp 6.0
503
+ def use_camera?
504
+ end
505
+
506
+ # The use_hidden= method sets the page's hidden property.
507
+ #
508
+ # @deprecated The functionality is replaced by {use_hidden_geometry=}
509
+ # and {use_hidden_objects=} in SketchUp 2020.1.
510
+ #
511
+ # @example
512
+ # model = Sketchup.active_model
513
+ # pages = model.pages
514
+ # page = pages.add "My Page"
515
+ # status = page.use_hidden = false
516
+ #
517
+ # @param setting
518
+ # true if you want your page to save this property, false
519
+ # if you do not want your page to save this property.
520
+ #
521
+ # @return status - true if you are saving the property, false if
522
+ # you are not saving the property.
523
+ #
524
+ # @see #use_hidden_geometry=
525
+ #
526
+ # @see #use_hidden_objects=
527
+ #
528
+ # @version SketchUp 6.0
529
+ def use_hidden=(setting)
530
+ end
531
+
532
+ # The use_hidden? method determines whether you are storing the hidden
533
+ # property with the page.
534
+ #
535
+ # @deprecated The functionality is replaced by {use_hidden_geometry?}
536
+ # and {use_hidden_objects?} in SketchUp 2020.1.
537
+ #
538
+ # @example
539
+ # model = Sketchup.active_model
540
+ # pages = model.pages
541
+ # page = pages.add("My Page")
542
+ # status = page.use_hidden?
543
+ #
544
+ # @return [Boolean] status - true if you are storing the this property with
545
+ # the page, false if you are not storing this property
546
+ # with the page.
547
+ #
548
+ # @see #use_hidden_geometry?
549
+ #
550
+ # @see #use_hidden_objects?
551
+ #
552
+ # @version SketchUp 6.0
553
+ def use_hidden?
554
+ end
555
+
556
+ # Sets the page's use hidden geometry property.
557
+ #
558
+ # @example
559
+ # model = Sketchup.active_model
560
+ # pages = model.pages
561
+ # page = pages.add("My Page")
562
+ # status = page.use_hidden_geometry = false
563
+ #
564
+ # @param [Boolean] setting
565
+ # `true` if you want your page to save this property,
566
+ # `false` if you do not want your page to save this property.
567
+ #
568
+ # @version SketchUp 2020.1
569
+ def use_hidden_geometry=(setting)
570
+ end
571
+
572
+ # Returns the use hidden geometry property from the page.
573
+ #
574
+ # @example
575
+ # model = Sketchup.active_model
576
+ # pages = model.pages
577
+ # page = pages.add("My Page")
578
+ # status = page.use_hidden_geometry?
579
+ #
580
+ # @return [Boolean]
581
+ #
582
+ # @version SketchUp 2020.1
583
+ def use_hidden_geometry?
584
+ end
585
+
586
+ # The use_hidden_layers= method sets the page's hidden layers
587
+ # property.
588
+ #
589
+ # @example
590
+ # model = Sketchup.active_model
591
+ # pages = model.pages
592
+ # page = pages.add "My Page"
593
+ # status = page.use_hidden_layers = false
594
+ #
595
+ # @param setting
596
+ # true if you want your page to save this property, false
597
+ # if you do not want your page to save this property.
598
+ #
599
+ # @return status - true if you are saving the property, false if
600
+ # you are not saving the property.
601
+ #
602
+ # @version SketchUp 6.0
603
+ def use_hidden_layers=(setting)
604
+ end
605
+
606
+ # The use_hidden_layers? method determines whether you are storing the hidden
607
+ # layers property with the page.
608
+ #
609
+ # @example
610
+ # model = Sketchup.active_model
611
+ # pages = model.pages
612
+ # page = pages.add "My Page"
613
+ # status = page.use_hidden_layers?
614
+ #
615
+ # @return [Boolean] status - true if you are storing the this property with
616
+ # the page, false if you are not storing this property
617
+ # with the page.
618
+ #
619
+ # @version SketchUp 6.0
620
+ def use_hidden_layers?
621
+ end
622
+
623
+ # Sets the page's use hidden objects property.
624
+ #
625
+ # @example
626
+ # model = Sketchup.active_model
627
+ # pages = model.pages
628
+ # page = pages.add("My Page")
629
+ # status = page.use_hidden_objects = false
630
+ #
631
+ # @param [Boolean] setting
632
+ # `true` if you want your page to save this property,
633
+ # `false` if you do not want your page to save this property.
634
+ #
635
+ # @version SketchUp 2020.1
636
+ def use_hidden_objects=(setting)
637
+ end
638
+
639
+ # Returns the use hidden objects property from the page.
640
+ #
641
+ # @example
642
+ # model = Sketchup.active_model
643
+ # pages = model.pages
644
+ # page = pages.add("My Page")
645
+ # status = page.use_hidden_objects?
646
+ #
647
+ # @return [Boolean]
648
+ #
649
+ # @version SketchUp 2020.1
650
+ def use_hidden_objects?
651
+ end
652
+
653
+ # The use_rendering_optoins= method sets the page's display
654
+ # settings property.
655
+ #
656
+ # @example
657
+ # model = Sketchup.active_model
658
+ # pages = model.pages
659
+ # page = pages.add "My Page"
660
+ # status = page.use_rendering_options = false
661
+ #
662
+ # @param setting
663
+ # true if you want your page to save this property, false
664
+ # if you do not want your page to save this property.
665
+ #
666
+ # @return status - true if you are saving the property, false
667
+ # if you are not saving the property.
668
+ #
669
+ # @version SketchUp 6.0
670
+ def use_rendering_options=(setting)
671
+ end
672
+
673
+ # The use_rendering_options? method determines whether you are storing the
674
+ # rendering options property with the page.
675
+ #
676
+ # @example
677
+ # model = Sketchup.active_model
678
+ # pages = model.pages
679
+ # page = pages.add "My Page"
680
+ # status = page.use_rendering_options?
681
+ #
682
+ # @return [Boolean] status - true if you are storing the this property with
683
+ # the page, false if you are not storing this property
684
+ # with the page.
685
+ #
686
+ # @version SketchUp 6.0
687
+ def use_rendering_options?
688
+ end
689
+
690
+ # The use_section_planes= method sets the page's section planes
691
+ # property.
692
+ #
693
+ # @example
694
+ # model = Sketchup.active_model
695
+ # pages = model.pages
696
+ # page = pages.add "My Page"
697
+ # status = page.use_section_planes=false
698
+ #
699
+ # @param setting
700
+ # true if you want your page to save this property, false
701
+ # if you do not want your page to save this property.
702
+ #
703
+ # @return status - true if you are saving the property, false if
704
+ # you are not saving the property.
705
+ #
706
+ # @version SketchUp 6.0
707
+ def use_section_planes=(setting)
708
+ end
709
+
710
+ # The use_section_planes? method determines whether you are storing the
711
+ # section planes property with the page.
712
+ #
713
+ # @example
714
+ # model = Sketchup.active_model
715
+ # pages = model.pages
716
+ # page = pages.add "My Page"
717
+ # status = page.use_section_planes?
718
+ #
719
+ # @return [Boolean] status - true if you are storing the this property with
720
+ # the page, false if you are not storing this property
721
+ # with the page.
722
+ #
723
+ # @version SketchUp 6.0
724
+ def use_section_planes?
725
+ end
726
+
727
+ # The use_shadow_info= method sets the page's shadow info property.
728
+ #
729
+ # @example
730
+ # model = Sketchup.active_model
731
+ # pages = model.pages
732
+ # page = pages.add "My Page"
733
+ # status = page.use_shadow_info=false
734
+ #
735
+ # @param setting
736
+ # true if you want your page to save this property, false
737
+ # if you do not want your page to save this property.
738
+ #
739
+ # @return status - true if you are saving the property, false if
740
+ # you are not saving the property.
741
+ #
742
+ # @version SketchUp 6.0
743
+ def use_shadow_info=(setting)
744
+ end
745
+
746
+ # The use_shadow_info? method determines whether you are storing the shadow
747
+ # info property with the page.
748
+ #
749
+ # @example
750
+ # model = Sketchup.active_model
751
+ # pages = model.pages
752
+ # page = pages.add "My Page"
753
+ # status = page.use_shadow_info?
754
+ #
755
+ # @return [Boolean] status - true if you are storing the this property with
756
+ # the page, false if you are not storing this property
757
+ # with the page.
758
+ #
759
+ # @version SketchUp 6.0
760
+ def use_shadow_info?
761
+ end
762
+
763
+ # The use_style= method sets the style to be used by the page.
764
+ #
765
+ # @example
766
+ # model = Sketchup.active_model
767
+ # pages = model.pages
768
+ # page = pages.add "My Page"
769
+ # style = model.styles[0]
770
+ # page.use_style = style
771
+ #
772
+ # @param style
773
+ # The Style object to use.
774
+ #
775
+ # @return nil
776
+ #
777
+ # @version SketchUp 6.0
778
+ def use_style=(style)
779
+ end
780
+
781
+ # The use_style? method determines whether storing a style with the page.
782
+ #
783
+ # @example
784
+ # model = Sketchup.active_model
785
+ # pages = model.pages
786
+ # page = pages.add "My Page"
787
+ # use_style = page.use_style?
788
+ #
789
+ # @return [Boolean] status - true if you are storing the this property with
790
+ # the page, false if you are not storing this property
791
+ # with the page.
792
+ #
793
+ # @version SketchUp 6.0
794
+ def use_style?
795
+ end
796
+
797
+ end