sketchup-api-stubs 0.6.1 → 0.7.4

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 (149) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +2 -0
  3. data/lib/sketchup-api-stubs.rb +1 -1
  4. data/lib/sketchup-api-stubs/sketchup.rb +145 -145
  5. data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +318 -318
  6. data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +172 -172
  7. data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +126 -126
  8. data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +102 -102
  9. data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +400 -401
  10. data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +661 -661
  11. data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +492 -492
  12. data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +478 -478
  13. data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +263 -263
  14. data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +141 -141
  15. data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +522 -523
  16. data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +691 -691
  17. data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
  18. data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +573 -569
  19. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +411 -411
  20. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +174 -186
  21. data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
  22. data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +514 -455
  23. data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
  24. data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +143 -155
  25. data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -359
  26. data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +349 -349
  27. data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +311 -123
  28. data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +261 -261
  29. data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +91 -86
  30. data/lib/sketchup-api-stubs/stubs/Layout/Label.rb +371 -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 +220 -232
  34. data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb +567 -563
  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 +204 -216
  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 +694 -547
  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/Sketchup/Animation.rb +140 -140
  49. data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +157 -157
  50. data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +209 -209
  51. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +152 -152
  52. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +281 -281
  53. data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
  54. data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +328 -328
  55. data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +577 -577
  56. data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
  57. data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +122 -122
  58. data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +281 -281
  59. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +562 -554
  60. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +593 -593
  61. data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
  62. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +257 -257
  63. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
  64. data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +194 -194
  65. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +329 -329
  66. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +72 -72
  67. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +102 -102
  68. data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
  69. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +312 -312
  70. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +38 -38
  71. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
  72. data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +390 -390
  73. data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +508 -508
  74. data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
  75. data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1119 -1097
  76. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +125 -125
  77. data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +544 -537
  78. data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +59 -59
  79. data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +125 -125
  80. data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +750 -750
  81. data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +104 -104
  82. data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +697 -697
  83. data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
  84. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +285 -285
  85. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
  86. data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +409 -409
  87. data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +226 -226
  88. data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +190 -190
  89. data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +393 -393
  90. data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +82 -82
  91. data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +303 -303
  92. data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +285 -262
  93. data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +244 -231
  94. data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +136 -136
  95. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +48 -48
  96. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
  97. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
  98. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +112 -123
  99. data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
  100. data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +416 -416
  101. data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +311 -311
  102. data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +141 -141
  103. data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +95 -95
  104. data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1638 -1483
  105. data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +356 -356
  106. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +132 -132
  107. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +284 -282
  108. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
  109. data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +770 -650
  110. data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +353 -353
  111. data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +76 -76
  112. data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +456 -456
  113. data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
  114. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +364 -356
  115. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +44 -44
  116. data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
  117. data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +454 -454
  118. data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +115 -115
  119. data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +212 -212
  120. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +257 -257
  121. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +57 -57
  122. data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
  123. data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +211 -211
  124. data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
  125. data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +225 -225
  126. data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
  127. data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +829 -829
  128. data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
  129. data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +154 -154
  130. data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +61 -61
  131. data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
  132. data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1301 -995
  133. data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +43 -43
  134. data/lib/sketchup-api-stubs/stubs/UI/Command.rb +310 -310
  135. data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +356 -356
  136. data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +229 -229
  137. data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +240 -240
  138. data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +633 -633
  139. data/lib/sketchup-api-stubs/stubs/_top_level.rb +311 -303
  140. data/lib/sketchup-api-stubs/stubs/array.rb +741 -741
  141. data/lib/sketchup-api-stubs/stubs/geom.rb +348 -233
  142. data/lib/sketchup-api-stubs/stubs/languagehandler.rb +92 -92
  143. data/lib/sketchup-api-stubs/stubs/length.rb +278 -262
  144. data/lib/sketchup-api-stubs/stubs/numeric.rb +249 -249
  145. data/lib/sketchup-api-stubs/stubs/sketchup.rb +1310 -1310
  146. data/lib/sketchup-api-stubs/stubs/sketchupextension.rb +353 -353
  147. data/lib/sketchup-api-stubs/stubs/string.rb +24 -24
  148. data/lib/sketchup-api-stubs/stubs/ui.rb +667 -660
  149. metadata +2 -16
@@ -1,58 +1,58 @@
1
- # Copyright:: Copyright 2019 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
1
+ # Copyright:: Copyright 2020 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
@@ -1,650 +1,770 @@
1
- # Copyright:: Copyright 2019 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 {#include_in_animation=} method controls whether the page should be
133
- # included when exporting an animation from the model.
134
- #
135
- # @example Turn off animation for all pages.
136
- # model = Sketchup.active_model
137
- # model.pages.each { |page|
138
- # page.include_in_animation = false
139
- # }
140
- #
141
- # @param [Boolean] include
142
- #
143
- # @return [Sketchup::Page]
144
- #
145
- # @version SketchUp 2018
146
- def include_in_animation=(include)
147
- end
148
-
149
- # The {#include_in_animation?} method determines whether the page should be
150
- # included when exporting an animation from the model.
151
- #
152
- # @example Toggle inclusion in animation for all pages.
153
- # model = Sketchup.active_model
154
- # in_animation = model.pages.select { |page| page.include_in_animation? }
155
- #
156
- # @return [Boolean]
157
- #
158
- # @version SketchUp 2018
159
- def include_in_animation?
160
- end
161
-
162
- # The label method retrieves the label 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
- # label = page.label
169
- #
170
- # @return label - a string label for the page tab
171
- #
172
- # @version SketchUp 6.0
173
- def label
174
- end
175
-
176
- # The layers method retrieves the non-visible layers associated with a page.
177
- #
178
- # @example
179
- # model = Sketchup.active_model
180
- # pages = model.pages
181
- # page = pages.add "My Page"
182
- # layers = page.layers
183
- # # layers now contains the layers in the model that are
184
- # # set to non-visible on the page
185
- #
186
- # @return layers - an array with zero or more Layers objects.
187
- #
188
- # @version SketchUp 6.0
189
- def layers
190
- end
191
-
192
- # The name method retrieves the name for a page from the page tab.
193
- #
194
- # @example
195
- # model = Sketchup.active_model
196
- # pages = model.pages
197
- # page = pages.add "My Page"
198
- # name = page.name
199
- #
200
- # @return label - a string name for the page tab
201
- #
202
- # @version SketchUp 6.0
203
- def name
204
- end
205
-
206
- # The name= method sets the name for a page's tab.
207
- #
208
- # @example
209
- # model = Sketchup.active_model
210
- # pages = model.pages
211
- # page = pages.add "My Page"
212
- # name = page.name = "Page Name"
213
- #
214
- # @param name
215
- # The name of the page to be set.
216
- #
217
- # @return name - the name that you have set
218
- #
219
- # @version SketchUp 6.0
220
- def name=(name)
221
- end
222
-
223
- # The rendering_options method retrieves a RenderingOptions object for the
224
- # page.
225
- #
226
- # @example
227
- # model = Sketchup.active_model
228
- # pages = model.pages
229
- # page = pages.add "My Page"
230
- # renderingoptions = page.rendering_options
231
- #
232
- # @return renderingoptions - a RenderingOptions object
233
- #
234
- # @version SketchUp 6.0
235
- def rendering_options
236
- end
237
-
238
- # The set_visibility method sets the visibility for a layer on a page.
239
- #
240
- # @example
241
- # model = Sketchup.active_model
242
- # pages = model.pages
243
- # page = pages.add "My Page"
244
- # layer = page.layers[0]
245
- # visibility = true
246
- # page = page.set_visibility layer, visibility
247
- #
248
- # @param layer
249
- # The layer whose visibility you are setting.
250
- #
251
- # @param visibility
252
- # true if you want items on the layer to be visible, false if you do not want items visible.
253
- #
254
- # @return page - the page whose visibility was set.
255
- #
256
- # @version SketchUp 6.0
257
- def set_visibility(layer, visibility)
258
- end
259
-
260
- # The shadow_info method retrieves the ShadowInfo object for the page.
261
- #
262
- # @example
263
- # model = Sketchup.active_model
264
- # pages = model.pages
265
- # page = pages.add "My Page"
266
- # shadowinfo = page.shadow_info
267
- #
268
- # @return shadowinfo - a ShadowInfo object if successful, nil if
269
- # the page does not save shadow information
270
- #
271
- # @version SketchUp 6.0
272
- def shadow_info
273
- end
274
-
275
- # The style method retrieves the style associated with the page.
276
- #
277
- # @example
278
- # model = Sketchup.active_model
279
- # pages = model.pages
280
- # page = pages.add "My Page"
281
- # style = page.style
282
- #
283
- # @return style - the Style object if successful
284
- #
285
- # @version SketchUp 6.0
286
- def style
287
- end
288
-
289
- # Get the amount of time that it takes to transition to this page during a
290
- # slideshow or animation export. If this value is -1, it means to use the
291
- # default transition time.
292
- #
293
- # @example
294
- # model = Sketchup.active_model
295
- # pages = model.pages
296
- # page = pages.add "My Page"
297
- # time = page.transition_time
298
- #
299
- # @return transitiontime - the amount of time it takes to
300
- # transition to this page during a slideshow or animation
301
- # export.
302
- #
303
- # @version SketchUp 6.0
304
- def transition_time
305
- end
306
-
307
- # The transition_time= method is used to set the transition time.
308
- #
309
- # @example
310
- # model = Sketchup.active_model
311
- # pages = model.pages
312
- # page = pages.add "My Page"
313
- # time = page.transition_time=20
314
- #
315
- # @param trans_time
316
- # The transition time in seconds.
317
- #
318
- # @return transitiontime - the new transition time
319
- #
320
- # @version SketchUp 6.0
321
- def transition_time=(trans_time)
322
- end
323
-
324
- # The update method performs an update on the page properties based on the
325
- # current view that the user has. Which parts of the Page get updated are
326
- # controlled via an integer whose bits represent which parts to update. You
327
- # can determine the integer you need to pass by adding these numbers together:
328
- #
329
- # - 1 - Camera Location,
330
- # - 2 - Drawing Style,
331
- # - 4 - Shadow Settings,
332
- # - 8 - Axes Location,
333
- # - 16 - Hidden Geometry,
334
- # - 32 - Visible Layers,
335
- # - 64 - Active Section Planes.
336
- #
337
- # The bit code values are added together to provide the flags value. For
338
- # example, to update the Camera Location, Axes Location, and Active Section
339
- # Planes properties, the flag would be 73 (1 + 8 + 64).
340
- #
341
- # @example
342
- # model = Sketchup.active_model
343
- # pages = model.pages
344
- # page = pages.add "My Page"
345
- # status = page.update
346
- #
347
- # # Updates Camera Location (+1), Shadow Settings(+4),
348
- # # and Visible Layers (+32).
349
- # status = page.update(37)
350
- #
351
- # @param flags
352
- # Integer representing the sum of the bit flags.
353
- #
354
- # @return status - true if successful, false if unsuccessful
355
- #
356
- # @version SketchUp 6.0
357
- def update(flags)
358
- end
359
-
360
- # The use_axes= method sets the page's axes property.
361
- #
362
- # @example
363
- # model = Sketchup.active_model
364
- # pages = model.pages
365
- # page = pages.add "My Page"
366
- # # Set use_axes to false
367
- # status = page.use_axes=false
368
- #
369
- # @param pagesettings
370
- # true if you want your page to save this property, false
371
- # if you do not want your page to save this property.
372
- #
373
- # @return status - true if you are saving the property, false if
374
- # you are not saving the property.
375
- #
376
- # @version SketchUp 6.0
377
- def use_axes=(pagesettings)
378
- end
379
-
380
- # The use_axes? method determines whether you are storing the axes property
381
- # with the page.
382
- #
383
- # @example
384
- # model = Sketchup.active_model
385
- # pages = model.pages
386
- # page = pages.add "My Page"
387
- # status = page.use_axes?
388
- #
389
- # @return [Boolean] status - true if you are storing the this property with
390
- # the page, false if you are not storing this property
391
- # with the page.
392
- #
393
- # @version SketchUp 6.0
394
- def use_axes?
395
- end
396
-
397
- # The use_camera= method sets the page's camera property.
398
- #
399
- # @example
400
- # model = Sketchup.active_model
401
- # pages = model.pages
402
- # page = pages.add "My Page"
403
- # status = page.use_camera = true
404
- #
405
- # @param setting
406
- # true if you want your page to save this property, false
407
- # if you do not want your page to save this property.
408
- #
409
- # @return status - true if you are saving the property, false if
410
- # you are not saving the property.
411
- #
412
- # @version SketchUp 6.0
413
- def use_camera=(setting)
414
- end
415
-
416
- # The use_camera? method determines whether you are storing the camera
417
- # property with the page.
418
- #
419
- # @example
420
- # model = Sketchup.active_model
421
- # pages = model.pages
422
- # page = pages.add "My Page"
423
- # status = page.use_camera?
424
- #
425
- # @return [Boolean] status - true if you are storing the this property with
426
- # the page, false if you are not storing this property
427
- # with the page.
428
- #
429
- # @version SketchUp 6.0
430
- def use_camera?
431
- end
432
-
433
- # The use_hidden= method sets the page's hidden property.
434
- #
435
- # @example
436
- # model = Sketchup.active_model
437
- # pages = model.pages
438
- # page = pages.add "My Page"
439
- # status = page.use_hidden=false
440
- #
441
- # @param setting
442
- # true if you want your page to save this property, false
443
- # if you do not want your page to save this property.
444
- #
445
- # @return status - true if you are saving the property, false if
446
- # you are not saving the property.
447
- #
448
- # @version SketchUp 6.0
449
- def use_hidden=(setting)
450
- end
451
-
452
- # The use_hidden? method determines whether you are storing the hidden
453
- # property with the page.
454
- #
455
- # @example
456
- # model = Sketchup.active_model
457
- # pages = model.pages
458
- # page = pages.add "My Page"
459
- # status = page.use_hidden?
460
- #
461
- # @return [Boolean] status - true if you are storing the this property with
462
- # the page, false if you are not storing this property
463
- # with the page.
464
- #
465
- # @version SketchUp 6.0
466
- def use_hidden?
467
- end
468
-
469
- # The use_hidden_layers= method sets the page's hidden layers
470
- # property.
471
- #
472
- # @example
473
- # model = Sketchup.active_model
474
- # pages = model.pages
475
- # page = pages.add "My Page"
476
- # status = page.use_hidden_layers = false
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_hidden_layers=(setting)
487
- end
488
-
489
- # The use_hidden_layers? method determines whether you are storing the hidden
490
- # layers 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_hidden_layers?
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_hidden_layers?
504
- end
505
-
506
- # The use_rendering_optoins= method sets the page's display
507
- # settings property.
508
- #
509
- # @example
510
- # model = Sketchup.active_model
511
- # pages = model.pages
512
- # page = pages.add "My Page"
513
- # status = page.use_rendering_options = false
514
- #
515
- # @param setting
516
- # true if you want your page to save this property, false
517
- # if you do not want your page to save this property.
518
- #
519
- # @return status - true if you are saving the property, false
520
- # if you are not saving the property.
521
- #
522
- # @version SketchUp 6.0
523
- def use_rendering_options=(setting)
524
- end
525
-
526
- # The use_rendering_options? method determines whether you are storing the
527
- # rendering options property with the page.
528
- #
529
- # @example
530
- # model = Sketchup.active_model
531
- # pages = model.pages
532
- # page = pages.add "My Page"
533
- # status = page.use_rendering_options?
534
- #
535
- # @return [Boolean] status - true if you are storing the this property with
536
- # the page, false if you are not storing this property
537
- # with the page.
538
- #
539
- # @version SketchUp 6.0
540
- def use_rendering_options?
541
- end
542
-
543
- # The use_section_planes= method sets the page's section planes
544
- # property.
545
- #
546
- # @example
547
- # model = Sketchup.active_model
548
- # pages = model.pages
549
- # page = pages.add "My Page"
550
- # status = page.use_section_planes=false
551
- #
552
- # @param setting
553
- # true if you want your page to save this property, false
554
- # if you do not want your page to save this property.
555
- #
556
- # @return status - true if you are saving the property, false if
557
- # you are not saving the property.
558
- #
559
- # @version SketchUp 6.0
560
- def use_section_planes=(setting)
561
- end
562
-
563
- # The use_section_planes? method determines whether you are storing the
564
- # section planes property with the page.
565
- #
566
- # @example
567
- # model = Sketchup.active_model
568
- # pages = model.pages
569
- # page = pages.add "My Page"
570
- # status = page.use_section_planes?
571
- #
572
- # @return [Boolean] status - true if you are storing the this property with
573
- # the page, false if you are not storing this property
574
- # with the page.
575
- #
576
- # @version SketchUp 6.0
577
- def use_section_planes?
578
- end
579
-
580
- # The use_shadow_info= method sets the page's shadow info property.
581
- #
582
- # @example
583
- # model = Sketchup.active_model
584
- # pages = model.pages
585
- # page = pages.add "My Page"
586
- # status = page.use_shadow_info=false
587
- #
588
- # @param setting
589
- # true if you want your page to save this property, false
590
- # if you do not want your page to save this property.
591
- #
592
- # @return status - true if you are saving the property, false if
593
- # you are not saving the property.
594
- #
595
- # @version SketchUp 6.0
596
- def use_shadow_info=(setting)
597
- end
598
-
599
- # The use_shadow_info? method determines whether you are storing the shadow
600
- # info property with the page.
601
- #
602
- # @example
603
- # model = Sketchup.active_model
604
- # pages = model.pages
605
- # page = pages.add "My Page"
606
- # status = page.use_shadow_info?
607
- #
608
- # @return [Boolean] status - true if you are storing the this property with
609
- # the page, false if you are not storing this property
610
- # with the page.
611
- #
612
- # @version SketchUp 6.0
613
- def use_shadow_info?
614
- end
615
-
616
- # The use_style= method sets the style to be used by the page.
617
- #
618
- # @example
619
- # model = Sketchup.active_model
620
- # pages = model.pages
621
- # page = pages.add "My Page"
622
- # style = model.styles[0]
623
- # page.use_style = style
624
- #
625
- # @param style
626
- # The Style object to use.
627
- #
628
- # @return nil
629
- #
630
- # @version SketchUp 6.0
631
- def use_style=(style)
632
- end
633
-
634
- # The use_style? method determines whether storing a style with the page.
635
- #
636
- # @example
637
- # model = Sketchup.active_model
638
- # pages = model.pages
639
- # page = pages.add "My Page"
640
- # use_style = page.use_style?
641
- #
642
- # @return [Boolean] status - true if you are storing the this property with
643
- # the page, false if you are not storing this property
644
- # with the page.
645
- #
646
- # @version SketchUp 6.0
647
- def use_style?
648
- end
649
-
650
- end
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