sketchup-api-stubs 0.7.4 → 0.7.5

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 (150) hide show
  1. checksums.yaml +4 -4
  2. data/lib/sketchup-api-stubs.rb +1 -1
  3. data/lib/sketchup-api-stubs/sketchup.rb +147 -145
  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 +498 -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 +691 -691
  16. data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
  17. data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +573 -573
  18. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +411 -411
  19. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +179 -174
  20. data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
  21. data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +515 -514
  22. data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
  23. data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +148 -143
  24. data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -353
  25. data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +349 -349
  26. data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +311 -311
  27. data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +261 -261
  28. data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +91 -91
  29. data/lib/sketchup-api-stubs/stubs/Layout/Label.rb +370 -371
  30. data/lib/sketchup-api-stubs/stubs/Layout/Layer.rb +218 -218
  31. data/lib/sketchup-api-stubs/stubs/Layout/LayerInstance.rb +128 -128
  32. data/lib/sketchup-api-stubs/stubs/Layout/Layers.rb +225 -220
  33. data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb +567 -567
  34. data/lib/sketchup-api-stubs/stubs/Layout/LockedEntityError.rb +10 -10
  35. data/lib/sketchup-api-stubs/stubs/Layout/LockedLayerError.rb +11 -11
  36. data/lib/sketchup-api-stubs/stubs/Layout/Page.rb +183 -183
  37. data/lib/sketchup-api-stubs/stubs/Layout/PageInfo.rb +387 -387
  38. data/lib/sketchup-api-stubs/stubs/Layout/Pages.rb +209 -204
  39. data/lib/sketchup-api-stubs/stubs/Layout/Path.rb +344 -344
  40. data/lib/sketchup-api-stubs/stubs/Layout/Rectangle.rb +174 -174
  41. data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +694 -694
  42. data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +1519 -1519
  43. data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +290 -290
  44. data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb +149 -149
  45. data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb +139 -139
  46. data/lib/sketchup-api-stubs/stubs/Layout/TableRow.rb +135 -135
  47. data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +144 -140
  48. data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +157 -157
  49. data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +209 -209
  50. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +152 -152
  51. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +286 -281
  52. data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
  53. data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +302 -328
  54. data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +478 -577
  55. data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
  56. data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +122 -122
  57. data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +294 -281
  58. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +577 -562
  59. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +604 -593
  60. data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
  61. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +257 -257
  62. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
  63. data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +201 -194
  64. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +362 -329
  65. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +74 -72
  66. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +104 -102
  67. data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
  68. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +306 -312
  69. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +42 -38
  70. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
  71. data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +396 -390
  72. data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +502 -508
  73. data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
  74. data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1126 -1119
  75. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +127 -125
  76. data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +545 -544
  77. data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +60 -59
  78. data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +126 -125
  79. data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +751 -750
  80. data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +104 -104
  81. data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +699 -697
  82. data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
  83. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +285 -285
  84. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
  85. data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +417 -409
  86. data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +266 -226
  87. data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +189 -190
  88. data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +405 -393
  89. data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +84 -82
  90. data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +306 -303
  91. data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +327 -285
  92. data/lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb +422 -0
  93. data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +427 -244
  94. data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +249 -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 -112
  99. data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
  100. data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +414 -416
  101. data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +318 -311
  102. data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +142 -141
  103. data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +93 -95
  104. data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1651 -1638
  105. data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +357 -356
  106. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +131 -132
  107. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +284 -284
  108. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
  109. data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +797 -770
  110. data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +363 -353
  111. data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +77 -76
  112. data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +478 -456
  113. data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
  114. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +364 -364
  115. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +45 -44
  116. data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
  117. data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +459 -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 +59 -57
  122. data/lib/sketchup-api-stubs/stubs/Sketchup/Skp.rb +40 -0
  123. data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
  124. data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +217 -211
  125. data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
  126. data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +217 -225
  127. data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
  128. data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +835 -829
  129. data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
  130. data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +156 -154
  131. data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +71 -61
  132. data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
  133. data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1307 -1301
  134. data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +45 -43
  135. data/lib/sketchup-api-stubs/stubs/UI/Command.rb +317 -310
  136. data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +387 -356
  137. data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +255 -229
  138. data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +240 -240
  139. data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +633 -633
  140. data/lib/sketchup-api-stubs/stubs/_top_level.rb +311 -311
  141. data/lib/sketchup-api-stubs/stubs/array.rb +741 -741
  142. data/lib/sketchup-api-stubs/stubs/geom.rb +351 -348
  143. data/lib/sketchup-api-stubs/stubs/languagehandler.rb +92 -92
  144. data/lib/sketchup-api-stubs/stubs/length.rb +278 -278
  145. data/lib/sketchup-api-stubs/stubs/numeric.rb +249 -249
  146. data/lib/sketchup-api-stubs/stubs/sketchup.rb +1342 -1310
  147. data/lib/sketchup-api-stubs/stubs/sketchupextension.rb +353 -353
  148. data/lib/sketchup-api-stubs/stubs/string.rb +24 -24
  149. data/lib/sketchup-api-stubs/stubs/ui.rb +668 -667
  150. metadata +4 -2
@@ -1,157 +1,157 @@
1
- # Copyright:: Copyright 2020 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # This observer interface is implemented to react to application events.
5
- # This interface is often used to attach other observers to models as they
6
- # are opened or started.
7
- # This ensures that your observers are watching all open models.
8
- #
9
- # For example, when one attaches a {Sketchup::SelectionObserver}, it is only
10
- # attached to the {Sketchup::Selection} collection of a given model. If a 2nd
11
- # model is opened, the new model's selection changes will not fire selection
12
- # callbacks unless you've attached a {Sketchup::SelectionObserver} to the new
13
- # model as well. By watching for {#onNewModel}, you can be sure to do so.
14
- #
15
- # To implement this observer, create a Ruby class of this type, override the
16
- # desired methods, and add an instance of the observer to the
17
- # application class.
18
- #
19
- # @example
20
- # # This is an example of an observer that watches the application for
21
- # # new models and shows a messagebox.
22
- # class MyAppObserver < Sketchup::AppObserver
23
- # def onNewModel(model)
24
- # puts "onNewModel: #{model}"
25
- #
26
- # # Here is where one might attach other observers to the new model.
27
- # model.selection.add_observer(MySelectionObserver.new)
28
- # end
29
- # end
30
- #
31
- # # Attach the observer
32
- # Sketchup.add_observer(MyAppObserver.new)
33
- #
34
- # @version SketchUp 6.0
35
- class Sketchup::AppObserver
36
-
37
- # Instance Methods
38
-
39
- # The {#expectsStartupModelNotifications} method is called to determine if the
40
- # observer expects to receive {#onNewModel} and {#onOpenModel} calls for the
41
- # models that are created or opened at SketchUp startup. This includes the
42
- # empty initial model, a model opened via command line arguments, or
43
- # auto-restored models on Mac OS X.
44
- #
45
- # @example
46
- # def expectsStartupModelNotifications
47
- # return true
48
- # end
49
- #
50
- # @note Prior to SketchUp 2014, {#onNewModel} and {#onOpenModel} were
51
- # not being called for the startup models. This issue is now fixed but
52
- # observers still need to express their intent to receive these calls. This is
53
- # for back-compatibility with existing scripts which worked around these
54
- # missing calls by other means. For new code, this method should be implemented
55
- # and should return +true+.
56
- #
57
- # @return [Boolean] +true+ to receive {#onNewModel} and {#onOpenModel} calls
58
- # for startup models. Return +false+ or simply not
59
- # implement the method in order to not receive these calls
60
- # (which was the behavior prior to SketchUp 2014).
61
- #
62
- # @version SketchUp 2014
63
- def expectsStartupModelNotifications
64
- end
65
-
66
- # The {#onActivateModel} method is called when an open model is activated. This
67
- # is relevant on Mac only which supports multiple documents to be opened
68
- # simultaneously.
69
- #
70
- # @example
71
- # def onActivateModel(model)
72
- # puts "onActivateModel: #{model}"
73
- # end
74
- #
75
- # @param [Sketchup::Model] model
76
- # The newly-activated model object.
77
- #
78
- # @return [nil]
79
- #
80
- # @version SketchUp 2015
81
- def onActivateModel(model)
82
- end
83
-
84
- # The {#onNewModel} method is called when the application creates a new, empty
85
- # model.
86
- #
87
- # @example
88
- # def onNewModel(model)
89
- # puts "onNewModel: #{model}"
90
- # end
91
- #
92
- # @param [Sketchup::Model] model
93
- # The active model object.
94
- #
95
- # @return [nil]
96
- #
97
- # @version SketchUp 6.0
98
- def onNewModel(model)
99
- end
100
-
101
- # The {#onOpenModel} method is called when the application opens an existing
102
- # model.
103
- #
104
- # @example
105
- # def onOpenModel(model)
106
- # puts "onOpenModel: #{model}"
107
- # end
108
- #
109
- # @note If a skp file is loaded via the command line or double-clicking on
110
- # a skp in explorer (which is also is the command line) then this
111
- # observer will not be called. The Ruby interpreter in SketchUp is
112
- # initialized after command line processing so the observer won't
113
- # be added in time to get the notification.
114
- #
115
- # @param [Sketchup::Model] model
116
- # The active model object.
117
- #
118
- # @return [nil]
119
- #
120
- # @version SketchUp 6.0
121
- def onOpenModel(model)
122
- end
123
-
124
- # The {#onQuit} method is called when SketchUp closes. This is useful if you
125
- # need to clean up anything or store your application state upon close.
126
- #
127
- # @example
128
- # def onQuit()
129
- # puts "onQuit"
130
- # end
131
- #
132
- # @return [nil]
133
- #
134
- # @version SketchUp 6.0
135
- def onQuit
136
- end
137
-
138
- # The {#onUnloadExtension} method is called when the user turns off a Ruby
139
- # extension. This is useful for detecting if the user is deactivating
140
- # some critical set of observers, for example, so you can warn them
141
- # or cache your extension state.
142
- #
143
- # @example
144
- # def onUnloadExtension(extension_name)
145
- # puts "onUnloadExtension: #{extension_name}"
146
- # end
147
- #
148
- # @param [String] extension_name
149
- # The name of the extension just unloaded.
150
- #
151
- # @return [nil]
152
- #
153
- # @version SketchUp 7.0
154
- def onUnloadExtension(extension_name)
155
- end
156
-
157
- end
1
+ # Copyright:: Copyright 2020 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # This observer interface is implemented to react to application events.
5
+ # This interface is often used to attach other observers to models as they
6
+ # are opened or started.
7
+ # This ensures that your observers are watching all open models.
8
+ #
9
+ # For example, when one attaches a {Sketchup::SelectionObserver}, it is only
10
+ # attached to the {Sketchup::Selection} collection of a given model. If a 2nd
11
+ # model is opened, the new model's selection changes will not fire selection
12
+ # callbacks unless you've attached a {Sketchup::SelectionObserver} to the new
13
+ # model as well. By watching for {#onNewModel}, you can be sure to do so.
14
+ #
15
+ # @abstract To implement this observer, create a Ruby class of this type, override the
16
+ # desired methods, and add an instance of the observer to the
17
+ # application class.
18
+ #
19
+ # @example
20
+ # # This is an example of an observer that watches the application for
21
+ # # new models and shows a messagebox.
22
+ # class MyAppObserver < Sketchup::AppObserver
23
+ # def onNewModel(model)
24
+ # puts "onNewModel: #{model}"
25
+ #
26
+ # # Here is where one might attach other observers to the new model.
27
+ # model.selection.add_observer(MySelectionObserver.new)
28
+ # end
29
+ # end
30
+ #
31
+ # # Attach the observer
32
+ # Sketchup.add_observer(MyAppObserver.new)
33
+ #
34
+ # @version SketchUp 6.0
35
+ class Sketchup::AppObserver
36
+
37
+ # Instance Methods
38
+
39
+ # The {#expectsStartupModelNotifications} method is called to determine if the
40
+ # observer expects to receive {#onNewModel} and {#onOpenModel} calls for the
41
+ # models that are created or opened at SketchUp startup. This includes the
42
+ # empty initial model, a model opened via command line arguments, or
43
+ # auto-restored models on Mac OS X.
44
+ #
45
+ # @example
46
+ # def expectsStartupModelNotifications
47
+ # return true
48
+ # end
49
+ #
50
+ # @note Prior to SketchUp 2014, {#onNewModel} and {#onOpenModel} were
51
+ # not being called for the startup models. This issue is now fixed but
52
+ # observers still need to express their intent to receive these calls. This is
53
+ # for back-compatibility with existing scripts which worked around these
54
+ # missing calls by other means. For new code, this method should be implemented
55
+ # and should return +true+.
56
+ #
57
+ # @return [Boolean] +true+ to receive {#onNewModel} and {#onOpenModel} calls
58
+ # for startup models. Return +false+ or simply not
59
+ # implement the method in order to not receive these calls
60
+ # (which was the behavior prior to SketchUp 2014).
61
+ #
62
+ # @version SketchUp 2014
63
+ def expectsStartupModelNotifications
64
+ end
65
+
66
+ # The {#onActivateModel} method is called when an open model is activated. This
67
+ # is relevant on Mac only which supports multiple documents to be opened
68
+ # simultaneously.
69
+ #
70
+ # @example
71
+ # def onActivateModel(model)
72
+ # puts "onActivateModel: #{model}"
73
+ # end
74
+ #
75
+ # @param [Sketchup::Model] model
76
+ # The newly-activated model object.
77
+ #
78
+ # @return [nil]
79
+ #
80
+ # @version SketchUp 2015
81
+ def onActivateModel(model)
82
+ end
83
+
84
+ # The {#onNewModel} method is called when the application creates a new, empty
85
+ # model.
86
+ #
87
+ # @example
88
+ # def onNewModel(model)
89
+ # puts "onNewModel: #{model}"
90
+ # end
91
+ #
92
+ # @param [Sketchup::Model] model
93
+ # The active model object.
94
+ #
95
+ # @return [nil]
96
+ #
97
+ # @version SketchUp 6.0
98
+ def onNewModel(model)
99
+ end
100
+
101
+ # The {#onOpenModel} method is called when the application opens an existing
102
+ # model.
103
+ #
104
+ # @example
105
+ # def onOpenModel(model)
106
+ # puts "onOpenModel: #{model}"
107
+ # end
108
+ #
109
+ # @note If a skp file is loaded via the command line or double-clicking on
110
+ # a skp in explorer (which is also is the command line) then this
111
+ # observer will not be called. The Ruby interpreter in SketchUp is
112
+ # initialized after command line processing so the observer won't
113
+ # be added in time to get the notification.
114
+ #
115
+ # @param [Sketchup::Model] model
116
+ # The active model object.
117
+ #
118
+ # @return [nil]
119
+ #
120
+ # @version SketchUp 6.0
121
+ def onOpenModel(model)
122
+ end
123
+
124
+ # The {#onQuit} method is called when SketchUp closes. This is useful if you
125
+ # need to clean up anything or store your application state upon close.
126
+ #
127
+ # @example
128
+ # def onQuit()
129
+ # puts "onQuit"
130
+ # end
131
+ #
132
+ # @return [nil]
133
+ #
134
+ # @version SketchUp 6.0
135
+ def onQuit
136
+ end
137
+
138
+ # The {#onUnloadExtension} method is called when the user turns off a Ruby
139
+ # extension. This is useful for detecting if the user is deactivating
140
+ # some critical set of observers, for example, so you can warn them
141
+ # or cache your extension state.
142
+ #
143
+ # @example
144
+ # def onUnloadExtension(extension_name)
145
+ # puts "onUnloadExtension: #{extension_name}"
146
+ # end
147
+ #
148
+ # @param [String] extension_name
149
+ # The name of the extension just unloaded.
150
+ #
151
+ # @return [nil]
152
+ #
153
+ # @version SketchUp 7.0
154
+ def onUnloadExtension(extension_name)
155
+ end
156
+
157
+ end
@@ -1,209 +1,209 @@
1
- # Copyright:: Copyright 2020 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # An ArcCurve is a Curve that makes up part of a circle. This is the
5
- # underlying class for circles as well.
6
- #
7
- # You can think of ArcCurves as entities that were created with SketchUp's
8
- # Arc or Circle drawing tools and Curves as entities that were created with
9
- # the Freehand drawing tool.
10
- #
11
- # However, keep in mind that all Curves in SketchUp are really edges with
12
- # some extra data attached to them. When you use the API to draw a Curve or
13
- # ArcCurve, you are really drawing edges.
14
- #
15
- # ArcCurve is a subclass of Curve, so all of the methods that are available
16
- # to Curves are also available to ArcCurves.
17
- #
18
- # @example
19
- # # Draw a circle on the ground plane around the origin.
20
- # center_point = Geom::Point3d.new(0,0,0)
21
- # normal_vector = Geom::Vector3d.new(0,0,1)
22
- # radius = 10
23
- #
24
- # entities = Sketchup.active_model.entities
25
- # edgearray = entities.add_circle center_point, normal_vector, radius
26
- # first_edge = edgearray[0]
27
- # arccurve = first_edge.curve
28
- #
29
- # @version SketchUp 6.0
30
- class Sketchup::ArcCurve < Sketchup::Curve
31
-
32
- # Instance Methods
33
-
34
- # The center method is used to retrieve the Point3d that is at the center of
35
- # the circular arc.
36
- #
37
- # @example
38
- # centerpoint = Geom::Point3d.new
39
- # # Create a circle perpendicular to the normal or Z axis
40
- # vector = Geom::Vector3d.new 0,0,1
41
- # vector2 = vector.normalize!
42
- # model = Sketchup.active_model
43
- # entities = model.entities
44
- # edgearray = entities.add_circle centerpoint, vector2, 10
45
- # edge = edgearray[0]
46
- # arccurve = edge.curve
47
- # point = arccurve.center
48
- #
49
- # @return point - a Point3d at the center of the arc if
50
- # successful
51
- #
52
- # @version SketchUp 6.0
53
- def center
54
- end
55
-
56
- # The {#end_angle} method is used to retrieve the angle of the end of the arc
57
- # measured from the X axis in radians.
58
- #
59
- # @example
60
- # # Create a 1/2 circle, normal to the Z axis
61
- # start_a = 0.0
62
- # end_a = 180.degrees
63
- # model = Sketchup.active_model
64
- # entities = model.entities
65
- # edges = entities.add_arc(ORIGIN, X_AXIS, Z_AXIS, 5, start_a, end_a)
66
- # arc_curve = edges.first.curve
67
- # end_angle = arc_curve.end_angle
68
- #
69
- # @note A bug in SketchUp 2017 and older will report the end-angle for some
70
- # circles as more than 360 degrees. In such case, subtract +2 * PI+ from
71
- # the end angle value.
72
- #
73
- # @return [Float]
74
- #
75
- # @version SketchUp 6.0
76
- def end_angle
77
- end
78
-
79
- # The normal method retrieves a Vector3d that is perpendicular to the plane of
80
- # the arc.
81
- #
82
- # @example
83
- # centerpoint = Geom::Point3d.new
84
- # # Create a circle perpendicular to the normal or Z axis
85
- # vector = Geom::Vector3d.new 0,0,1
86
- # vector2 = vector.normalize!
87
- # model = Sketchup.active_model
88
- # entities = model.entities
89
- # edgearray = entities.add_circle centerpoint, vector2, 10
90
- # edge = edgearray[0]
91
- # arccurve = edge.curve
92
- # v = arccurve.normal
93
- #
94
- # @return vector - a Vector3d object if successful
95
- #
96
- # @version SketchUp 6.0
97
- def normal
98
- end
99
-
100
- # The plane method is used to retrieve the plane of the arc.
101
- #
102
- # Refer to the Geom module for instructions to create a plane.
103
- #
104
- # @example
105
- # centerpoint = Geom::Point3d.new
106
- # # Create a circle perpendicular to the normal or Z axis
107
- # vector = Geom::Vector3d.new 0,0,1
108
- # vector2 = vector.normalize!
109
- # model = Sketchup.active_model
110
- # entities = model.entities
111
- # edgearray = entities.add_circle centerpoint, vector2, 10
112
- # edge = edgearray[0]
113
- # arccurve = edge.curve
114
- # plane = arccurve.plane
115
- #
116
- # @return plane - the plane of the arc if successful
117
- #
118
- # @version SketchUp 6.0
119
- def plane
120
- end
121
-
122
- # The radius method is used to retrieve the radius of the arc.
123
- #
124
- # @example
125
- # centerpoint = Geom::Point3d.new
126
- # # Create a circle perpendicular to the normal or Z axis
127
- # vector = Geom::Vector3d.new 0,0,1
128
- # vector2 = vector.normalize!
129
- # model = Sketchup.active_model
130
- # entities = model.entities
131
- # edgearray = entities.add_circle centerpoint, vector2, 10
132
- # edge = edgearray[0]
133
- # arccurve = edge.curve
134
- # radius = arccurve.radius
135
- #
136
- # @return radius - the radius of the arc if successful
137
- #
138
- # @version SketchUp 6.0
139
- def radius
140
- end
141
-
142
- # The start_angle method is used to retrieve the angle of the start of the
143
- # arc, measured from the X axis in radians.
144
- #
145
- # @example
146
- # # Create a 1/4 circle, radius of 5, normal to the Z axis
147
- # center = Geom::Point3d.new 0, 0, -1
148
- # normal = Geom::Vector3d.new 0,0,1
149
- # xaxis = Geom::Vector3d.new 1,0,0
150
- # start_a = Math::PI/2
151
- # end_a = Math::PI
152
- # model = Sketchup.active_model
153
- # entities = model.entities
154
- # edgearray = entities.add_arc center, xaxis, normal, 5, start_a, end_a
155
- # edge = edgearray[0]
156
- # arccurve = edge.curve
157
- # start_angle = arccurve.start_angle
158
- #
159
- # @return angle - the angle of the start of the arc if successful
160
- #
161
- # @version SketchUp 6.0
162
- def start_angle
163
- end
164
-
165
- # The xaxis method is used to retrieve the X axis of the coordinate system for
166
- # the curve. Note that the length of the returned vector is equal to the radius
167
- # of the underlying curve.
168
- #
169
- # @example
170
- # centerpoint = Geom::Point3d.new
171
- # # Create a circle perpendicular to the normal or Z axis
172
- # vector = Geom::Vector3d.new 0,0,1
173
- # vector2 = vector.normalize!
174
- # model = Sketchup.active_model
175
- # entities = model.entities
176
- # edgearray = entities.add_circle centerpoint, vector2, 10
177
- # edge = edgearray[0]
178
- # arccurve = edge.curve
179
- # v = arccurve.xaxis
180
- #
181
- # @return vector - a Vector3d object if successful
182
- #
183
- # @version SketchUp 6.0
184
- def xaxis
185
- end
186
-
187
- # The yaxis method is used to retrieve the Y axis of the coordinate system for
188
- # the curve. Note that the length of the returned vector is equal to the radius
189
- # of the underlying curve.
190
- #
191
- # @example
192
- # centerpoint = Geom::Point3d.new
193
- # # Create a circle perpendicular to the normal or Z axis
194
- # vector = Geom::Vector3d.new 0,0,1
195
- # vector2 = vector.normalize!
196
- # model = Sketchup.active_model
197
- # entities = model.entities
198
- # edgearray = entities.add_circle centerpoint, vector2, 10
199
- # edge = edgearray[0]
200
- # arccurve = edge.curve
201
- # v = arccurve.yaxis
202
- #
203
- # @return vector - a Vector3d object if successful
204
- #
205
- # @version SketchUp 6.0
206
- def yaxis
207
- end
208
-
209
- end
1
+ # Copyright:: Copyright 2020 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # An ArcCurve is a Curve that makes up part of a circle. This is the
5
+ # underlying class for circles as well.
6
+ #
7
+ # You can think of ArcCurves as entities that were created with SketchUp's
8
+ # Arc or Circle drawing tools and Curves as entities that were created with
9
+ # the Freehand drawing tool.
10
+ #
11
+ # However, keep in mind that all Curves in SketchUp are really edges with
12
+ # some extra data attached to them. When you use the API to draw a Curve or
13
+ # ArcCurve, you are really drawing edges.
14
+ #
15
+ # ArcCurve is a subclass of Curve, so all of the methods that are available
16
+ # to Curves are also available to ArcCurves.
17
+ #
18
+ # @example
19
+ # # Draw a circle on the ground plane around the origin.
20
+ # center_point = Geom::Point3d.new(0,0,0)
21
+ # normal_vector = Geom::Vector3d.new(0,0,1)
22
+ # radius = 10
23
+ #
24
+ # entities = Sketchup.active_model.entities
25
+ # edgearray = entities.add_circle center_point, normal_vector, radius
26
+ # first_edge = edgearray[0]
27
+ # arccurve = first_edge.curve
28
+ #
29
+ # @version SketchUp 6.0
30
+ class Sketchup::ArcCurve < Sketchup::Curve
31
+
32
+ # Instance Methods
33
+
34
+ # The center method is used to retrieve the Point3d that is at the center of
35
+ # the circular arc.
36
+ #
37
+ # @example
38
+ # centerpoint = Geom::Point3d.new
39
+ # # Create a circle perpendicular to the normal or Z axis
40
+ # vector = Geom::Vector3d.new 0,0,1
41
+ # vector2 = vector.normalize!
42
+ # model = Sketchup.active_model
43
+ # entities = model.entities
44
+ # edgearray = entities.add_circle centerpoint, vector2, 10
45
+ # edge = edgearray[0]
46
+ # arccurve = edge.curve
47
+ # point = arccurve.center
48
+ #
49
+ # @return point - a Point3d at the center of the arc if
50
+ # successful
51
+ #
52
+ # @version SketchUp 6.0
53
+ def center
54
+ end
55
+
56
+ # The {#end_angle} method is used to retrieve the angle of the end of the arc
57
+ # measured from the X axis in radians.
58
+ #
59
+ # @example
60
+ # # Create a 1/2 circle, normal to the Z axis
61
+ # start_a = 0.0
62
+ # end_a = 180.degrees
63
+ # model = Sketchup.active_model
64
+ # entities = model.entities
65
+ # edges = entities.add_arc(ORIGIN, X_AXIS, Z_AXIS, 5, start_a, end_a)
66
+ # arc_curve = edges.first.curve
67
+ # end_angle = arc_curve.end_angle
68
+ #
69
+ # @note A bug in SketchUp 2017 and older will report the end-angle for some
70
+ # circles as more than 360 degrees. In such case, subtract +2 * PI+ from
71
+ # the end angle value.
72
+ #
73
+ # @return [Float]
74
+ #
75
+ # @version SketchUp 6.0
76
+ def end_angle
77
+ end
78
+
79
+ # The normal method retrieves a Vector3d that is perpendicular to the plane of
80
+ # the arc.
81
+ #
82
+ # @example
83
+ # centerpoint = Geom::Point3d.new
84
+ # # Create a circle perpendicular to the normal or Z axis
85
+ # vector = Geom::Vector3d.new 0,0,1
86
+ # vector2 = vector.normalize!
87
+ # model = Sketchup.active_model
88
+ # entities = model.entities
89
+ # edgearray = entities.add_circle centerpoint, vector2, 10
90
+ # edge = edgearray[0]
91
+ # arccurve = edge.curve
92
+ # v = arccurve.normal
93
+ #
94
+ # @return vector - a Vector3d object if successful
95
+ #
96
+ # @version SketchUp 6.0
97
+ def normal
98
+ end
99
+
100
+ # The plane method is used to retrieve the plane of the arc.
101
+ #
102
+ # Refer to the Geom module for instructions to create a plane.
103
+ #
104
+ # @example
105
+ # centerpoint = Geom::Point3d.new
106
+ # # Create a circle perpendicular to the normal or Z axis
107
+ # vector = Geom::Vector3d.new 0,0,1
108
+ # vector2 = vector.normalize!
109
+ # model = Sketchup.active_model
110
+ # entities = model.entities
111
+ # edgearray = entities.add_circle centerpoint, vector2, 10
112
+ # edge = edgearray[0]
113
+ # arccurve = edge.curve
114
+ # plane = arccurve.plane
115
+ #
116
+ # @return plane - the plane of the arc if successful
117
+ #
118
+ # @version SketchUp 6.0
119
+ def plane
120
+ end
121
+
122
+ # The radius method is used to retrieve the radius of the arc.
123
+ #
124
+ # @example
125
+ # centerpoint = Geom::Point3d.new
126
+ # # Create a circle perpendicular to the normal or Z axis
127
+ # vector = Geom::Vector3d.new 0,0,1
128
+ # vector2 = vector.normalize!
129
+ # model = Sketchup.active_model
130
+ # entities = model.entities
131
+ # edgearray = entities.add_circle centerpoint, vector2, 10
132
+ # edge = edgearray[0]
133
+ # arccurve = edge.curve
134
+ # radius = arccurve.radius
135
+ #
136
+ # @return radius - the radius of the arc if successful
137
+ #
138
+ # @version SketchUp 6.0
139
+ def radius
140
+ end
141
+
142
+ # The start_angle method is used to retrieve the angle of the start of the
143
+ # arc, measured from the X axis in radians.
144
+ #
145
+ # @example
146
+ # # Create a 1/4 circle, radius of 5, normal to the Z axis
147
+ # center = Geom::Point3d.new 0, 0, -1
148
+ # normal = Geom::Vector3d.new 0,0,1
149
+ # xaxis = Geom::Vector3d.new 1,0,0
150
+ # start_a = Math::PI/2
151
+ # end_a = Math::PI
152
+ # model = Sketchup.active_model
153
+ # entities = model.entities
154
+ # edgearray = entities.add_arc center, xaxis, normal, 5, start_a, end_a
155
+ # edge = edgearray[0]
156
+ # arccurve = edge.curve
157
+ # start_angle = arccurve.start_angle
158
+ #
159
+ # @return angle - the angle of the start of the arc if successful
160
+ #
161
+ # @version SketchUp 6.0
162
+ def start_angle
163
+ end
164
+
165
+ # The xaxis method is used to retrieve the X axis of the coordinate system for
166
+ # the curve. Note that the length of the returned vector is equal to the radius
167
+ # of the underlying curve.
168
+ #
169
+ # @example
170
+ # centerpoint = Geom::Point3d.new
171
+ # # Create a circle perpendicular to the normal or Z axis
172
+ # vector = Geom::Vector3d.new 0,0,1
173
+ # vector2 = vector.normalize!
174
+ # model = Sketchup.active_model
175
+ # entities = model.entities
176
+ # edgearray = entities.add_circle centerpoint, vector2, 10
177
+ # edge = edgearray[0]
178
+ # arccurve = edge.curve
179
+ # v = arccurve.xaxis
180
+ #
181
+ # @return vector - a Vector3d object if successful
182
+ #
183
+ # @version SketchUp 6.0
184
+ def xaxis
185
+ end
186
+
187
+ # The yaxis method is used to retrieve the Y axis of the coordinate system for
188
+ # the curve. Note that the length of the returned vector is equal to the radius
189
+ # of the underlying curve.
190
+ #
191
+ # @example
192
+ # centerpoint = Geom::Point3d.new
193
+ # # Create a circle perpendicular to the normal or Z axis
194
+ # vector = Geom::Vector3d.new 0,0,1
195
+ # vector2 = vector.normalize!
196
+ # model = Sketchup.active_model
197
+ # entities = model.entities
198
+ # edgearray = entities.add_circle centerpoint, vector2, 10
199
+ # edge = edgearray[0]
200
+ # arccurve = edge.curve
201
+ # v = arccurve.yaxis
202
+ #
203
+ # @return vector - a Vector3d object if successful
204
+ #
205
+ # @version SketchUp 6.0
206
+ def yaxis
207
+ end
208
+
209
+ end