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.
- checksums.yaml +4 -4
- data/.yardopts +2 -0
- data/lib/sketchup-api-stubs.rb +1 -1
- data/lib/sketchup-api-stubs/sketchup.rb +145 -145
- data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +318 -318
- data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +172 -172
- data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +126 -126
- data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +102 -102
- data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +400 -401
- data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +661 -661
- data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +492 -492
- data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +478 -478
- data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +263 -263
- data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +141 -141
- data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +522 -523
- data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +691 -691
- data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
- data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +573 -569
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +411 -411
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +174 -186
- data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
- data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +514 -455
- data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
- data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +143 -155
- data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -359
- data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +349 -349
- data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +311 -123
- data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +261 -261
- data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +91 -86
- data/lib/sketchup-api-stubs/stubs/Layout/Label.rb +371 -371
- data/lib/sketchup-api-stubs/stubs/Layout/Layer.rb +218 -218
- data/lib/sketchup-api-stubs/stubs/Layout/LayerInstance.rb +128 -128
- data/lib/sketchup-api-stubs/stubs/Layout/Layers.rb +220 -232
- data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb +567 -563
- data/lib/sketchup-api-stubs/stubs/Layout/LockedEntityError.rb +10 -10
- data/lib/sketchup-api-stubs/stubs/Layout/LockedLayerError.rb +11 -11
- data/lib/sketchup-api-stubs/stubs/Layout/Page.rb +183 -183
- data/lib/sketchup-api-stubs/stubs/Layout/PageInfo.rb +387 -387
- data/lib/sketchup-api-stubs/stubs/Layout/Pages.rb +204 -216
- data/lib/sketchup-api-stubs/stubs/Layout/Path.rb +344 -344
- data/lib/sketchup-api-stubs/stubs/Layout/Rectangle.rb +174 -174
- data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +694 -547
- data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +1519 -1519
- data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +290 -290
- data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb +149 -149
- data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb +139 -139
- data/lib/sketchup-api-stubs/stubs/Layout/TableRow.rb +135 -135
- data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +140 -140
- data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +157 -157
- data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +209 -209
- data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +152 -152
- data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +281 -281
- data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
- data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +328 -328
- data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +577 -577
- data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
- data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +122 -122
- data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +281 -281
- data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +562 -554
- data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +593 -593
- data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
- data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +257 -257
- data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
- data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +194 -194
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +329 -329
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +72 -72
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +102 -102
- data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +312 -312
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +38 -38
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
- data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +390 -390
- data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +508 -508
- data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1119 -1097
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +125 -125
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +544 -537
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +59 -59
- data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +125 -125
- data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +750 -750
- data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +104 -104
- data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +697 -697
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +285 -285
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
- data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +409 -409
- data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +226 -226
- data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +190 -190
- data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +393 -393
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +82 -82
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +303 -303
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +285 -262
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +244 -231
- data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +136 -136
- data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +48 -48
- data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
- data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
- data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +112 -123
- data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
- data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +416 -416
- data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +311 -311
- data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +141 -141
- data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +95 -95
- data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1638 -1483
- data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +356 -356
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +132 -132
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +284 -282
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
- data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +770 -650
- data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +76 -76
- data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +456 -456
- data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
- data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +364 -356
- data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +44 -44
- data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
- data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +454 -454
- data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +115 -115
- data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +212 -212
- data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +257 -257
- data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +57 -57
- data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
- data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +211 -211
- data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
- data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +225 -225
- data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +829 -829
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
- data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +154 -154
- data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +61 -61
- data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
- data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1301 -995
- data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +43 -43
- data/lib/sketchup-api-stubs/stubs/UI/Command.rb +310 -310
- data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +356 -356
- data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +229 -229
- data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +240 -240
- data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +633 -633
- data/lib/sketchup-api-stubs/stubs/_top_level.rb +311 -303
- data/lib/sketchup-api-stubs/stubs/array.rb +741 -741
- data/lib/sketchup-api-stubs/stubs/geom.rb +348 -233
- data/lib/sketchup-api-stubs/stubs/languagehandler.rb +92 -92
- data/lib/sketchup-api-stubs/stubs/length.rb +278 -262
- data/lib/sketchup-api-stubs/stubs/numeric.rb +249 -249
- data/lib/sketchup-api-stubs/stubs/sketchup.rb +1310 -1310
- data/lib/sketchup-api-stubs/stubs/sketchupextension.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/string.rb +24 -24
- data/lib/sketchup-api-stubs/stubs/ui.rb +667 -660
- metadata +2 -16
@@ -1,157 +1,157 @@
|
|
1
|
-
# Copyright:: Copyright
|
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
|
+
# 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
|
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
|