sketchup-api-stubs 0.7.3 → 0.7.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.yardopts +9 -9
- 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 -400
- 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 -522
- 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 -573
- 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 -514
- 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 -353
- data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +349 -349
- data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +311 -311
- data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +261 -261
- data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +91 -91
- 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 -567
- 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 -694
- 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 -562
- 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 -1119
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +125 -125
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +544 -544
- 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 -280
- 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 -1601
- 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 -284
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
- data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +770 -770
- 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 -364
- 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 -1301
- 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 -311
- data/lib/sketchup-api-stubs/stubs/array.rb +741 -741
- data/lib/sketchup-api-stubs/stubs/geom.rb +348 -348
- data/lib/sketchup-api-stubs/stubs/languagehandler.rb +92 -92
- data/lib/sketchup-api-stubs/stubs/length.rb +278 -278
- 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 -667
- metadata +3 -4
@@ -1,72 +1,72 @@
|
|
1
|
-
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# This observer interface is implemented to react to component definition
|
5
|
-
# events. To implement this observer, create a Ruby class of this type,
|
6
|
-
# override the desired methods, and add an instance of the observer to the
|
7
|
-
# definitions of interests.
|
8
|
-
#
|
9
|
-
# @example
|
10
|
-
# # This is an example of an observer that watches a specific definition
|
11
|
-
# # for new component insertions.
|
12
|
-
# class MyDefObserver < Sketchup::DefinitionObserver
|
13
|
-
# def onComponentInstanceAdded(definition, instance)
|
14
|
-
# puts "onComponentInstanceAdded(#{definition}, #{instance})"
|
15
|
-
# end
|
16
|
-
# end
|
17
|
-
#
|
18
|
-
# # Attach the observer
|
19
|
-
# Sketchup.active_model.definitions[0].add_observer(MyDefObserver.new)
|
20
|
-
#
|
21
|
-
# @version SketchUp 6.0
|
22
|
-
class Sketchup::DefinitionObserver < Sketchup::EntityObserver
|
23
|
-
|
24
|
-
# Instance Methods
|
25
|
-
|
26
|
-
# The {#onComponentInstanceAdded} method is called when a new component
|
27
|
-
# instance is added to a model.
|
28
|
-
#
|
29
|
-
# @example
|
30
|
-
# def onComponentInstanceAdded(definition, instance)
|
31
|
-
# puts "onComponentInstanceAdded(#{definition}, #{instance})"
|
32
|
-
# end
|
33
|
-
#
|
34
|
-
# @param [Sketchup::ComponentDefinition] definition
|
35
|
-
# The definition of the
|
36
|
-
# added instance
|
37
|
-
#
|
38
|
-
# @param [Sketchup::ComponentInstance] instance
|
39
|
-
# The added instance
|
40
|
-
#
|
41
|
-
# @return [nil]
|
42
|
-
#
|
43
|
-
# @version SketchUp 6.0
|
44
|
-
def onComponentInstanceAdded(definition, instance)
|
45
|
-
end
|
46
|
-
|
47
|
-
# The {#onComponentInstanceRemoved} method is called when a component
|
48
|
-
# instance is removed from a model.
|
49
|
-
#
|
50
|
-
# @example
|
51
|
-
# def onComponentInstanceRemoved(definition, instance)
|
52
|
-
# puts "onComponentInstanceRemoved(#{definition}, #{instance})"
|
53
|
-
# end
|
54
|
-
#
|
55
|
-
# @note Due to the underlying way that the SketchUp Move Tool is
|
56
|
-
# implemented, this method is fired on a Move + Copy operation even
|
57
|
-
# though no {Sketchup::ComponentInstance} is apparently removed.
|
58
|
-
#
|
59
|
-
# @param [Sketchup::ComponentDefinition] definition
|
60
|
-
# The definition of the
|
61
|
-
# instance removed
|
62
|
-
#
|
63
|
-
# @param [Sketchup::ComponentInstance] instance
|
64
|
-
# The removed instance
|
65
|
-
#
|
66
|
-
# @return [nil]
|
67
|
-
#
|
68
|
-
# @version SketchUp 6.0
|
69
|
-
def onComponentInstanceRemoved(definition, instance)
|
70
|
-
end
|
71
|
-
|
72
|
-
end
|
1
|
+
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# This observer interface is implemented to react to component definition
|
5
|
+
# events. To implement this observer, create a Ruby class of this type,
|
6
|
+
# override the desired methods, and add an instance of the observer to the
|
7
|
+
# definitions of interests.
|
8
|
+
#
|
9
|
+
# @example
|
10
|
+
# # This is an example of an observer that watches a specific definition
|
11
|
+
# # for new component insertions.
|
12
|
+
# class MyDefObserver < Sketchup::DefinitionObserver
|
13
|
+
# def onComponentInstanceAdded(definition, instance)
|
14
|
+
# puts "onComponentInstanceAdded(#{definition}, #{instance})"
|
15
|
+
# end
|
16
|
+
# end
|
17
|
+
#
|
18
|
+
# # Attach the observer
|
19
|
+
# Sketchup.active_model.definitions[0].add_observer(MyDefObserver.new)
|
20
|
+
#
|
21
|
+
# @version SketchUp 6.0
|
22
|
+
class Sketchup::DefinitionObserver < Sketchup::EntityObserver
|
23
|
+
|
24
|
+
# Instance Methods
|
25
|
+
|
26
|
+
# The {#onComponentInstanceAdded} method is called when a new component
|
27
|
+
# instance is added to a model.
|
28
|
+
#
|
29
|
+
# @example
|
30
|
+
# def onComponentInstanceAdded(definition, instance)
|
31
|
+
# puts "onComponentInstanceAdded(#{definition}, #{instance})"
|
32
|
+
# end
|
33
|
+
#
|
34
|
+
# @param [Sketchup::ComponentDefinition] definition
|
35
|
+
# The definition of the
|
36
|
+
# added instance
|
37
|
+
#
|
38
|
+
# @param [Sketchup::ComponentInstance] instance
|
39
|
+
# The added instance
|
40
|
+
#
|
41
|
+
# @return [nil]
|
42
|
+
#
|
43
|
+
# @version SketchUp 6.0
|
44
|
+
def onComponentInstanceAdded(definition, instance)
|
45
|
+
end
|
46
|
+
|
47
|
+
# The {#onComponentInstanceRemoved} method is called when a component
|
48
|
+
# instance is removed from a model.
|
49
|
+
#
|
50
|
+
# @example
|
51
|
+
# def onComponentInstanceRemoved(definition, instance)
|
52
|
+
# puts "onComponentInstanceRemoved(#{definition}, #{instance})"
|
53
|
+
# end
|
54
|
+
#
|
55
|
+
# @note Due to the underlying way that the SketchUp Move Tool is
|
56
|
+
# implemented, this method is fired on a Move + Copy operation even
|
57
|
+
# though no {Sketchup::ComponentInstance} is apparently removed.
|
58
|
+
#
|
59
|
+
# @param [Sketchup::ComponentDefinition] definition
|
60
|
+
# The definition of the
|
61
|
+
# instance removed
|
62
|
+
#
|
63
|
+
# @param [Sketchup::ComponentInstance] instance
|
64
|
+
# The removed instance
|
65
|
+
#
|
66
|
+
# @return [nil]
|
67
|
+
#
|
68
|
+
# @version SketchUp 6.0
|
69
|
+
def onComponentInstanceRemoved(definition, instance)
|
70
|
+
end
|
71
|
+
|
72
|
+
end
|
@@ -1,102 +1,102 @@
|
|
1
|
-
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# This observer interface is implemented to react to events on a definitions
|
5
|
-
# collection. To implement this observer, create a Ruby class of this type,
|
6
|
-
# override the desired methods, and add an instance of the observer to the
|
7
|
-
# collection of interest.
|
8
|
-
#
|
9
|
-
# @example
|
10
|
-
# class MyDefinitionsObserver < Sketchup::DefinitionsObserver
|
11
|
-
# def onComponentAdded(definitions, definition)
|
12
|
-
# puts "onComponentAdded: #{definition.name}"
|
13
|
-
# end
|
14
|
-
# end
|
15
|
-
#
|
16
|
-
# Sketchup.active_model.definitions.add_observer(MyDefinitionsObserver.new)
|
17
|
-
#
|
18
|
-
# @version SketchUp 6.0
|
19
|
-
class Sketchup::DefinitionsObserver
|
20
|
-
|
21
|
-
# Instance Methods
|
22
|
-
|
23
|
-
# The {#onComponentAdded} method is called whenever a definition is added to
|
24
|
-
# the definitions collection.
|
25
|
-
#
|
26
|
-
# @example
|
27
|
-
# def onComponentAdded(definitions, definition)
|
28
|
-
# puts "onComponentAdded: #{definition}"
|
29
|
-
# end
|
30
|
-
#
|
31
|
-
# @param [Sketchup::DefinitionList] definitions
|
32
|
-
#
|
33
|
-
# @param [Sketchup::ComponentDefinition] definition
|
34
|
-
#
|
35
|
-
# @return [nil]
|
36
|
-
#
|
37
|
-
# @version SketchUp 6.0
|
38
|
-
def onComponentAdded(definitions, definition)
|
39
|
-
end
|
40
|
-
|
41
|
-
# The {#onComponentPropertiesChanged} method is called whenever a definition's
|
42
|
-
# name or description are changed.
|
43
|
-
#
|
44
|
-
# This does not fire when "Glue To", "Cuts Opening", or "Face Camera" settings
|
45
|
-
# are changed.
|
46
|
-
#
|
47
|
-
# @example
|
48
|
-
# def onComponentPropertiesChanged(definitions, definition)
|
49
|
-
# puts "onComponentPropertiesChanged: #{definition}"
|
50
|
-
# end
|
51
|
-
#
|
52
|
-
# @param [Sketchup::DefinitionList] definitions
|
53
|
-
#
|
54
|
-
# @param [Sketchup::ComponentDefinition] definition
|
55
|
-
#
|
56
|
-
# @return [nil]
|
57
|
-
#
|
58
|
-
# @version SketchUp 6.0
|
59
|
-
def onComponentPropertiesChanged(definitions, definition)
|
60
|
-
end
|
61
|
-
|
62
|
-
# The {#onComponentAdded} method is called whenever a definition is removed
|
63
|
-
# from the definitions collection.
|
64
|
-
#
|
65
|
-
# @example
|
66
|
-
# def onComponentRemoved(definitions, definition)
|
67
|
-
# puts "onComponentRemoved: #{definition}"
|
68
|
-
# end
|
69
|
-
#
|
70
|
-
# @note This methods fires twice for each Component/Group erased.
|
71
|
-
#
|
72
|
-
# @param [Sketchup::DefinitionList] definitions
|
73
|
-
#
|
74
|
-
# @param [Sketchup::ComponentDefinition] definition
|
75
|
-
#
|
76
|
-
# @return [nil]
|
77
|
-
#
|
78
|
-
# @version SketchUp 6.0
|
79
|
-
def onComponentRemoved(definitions, definition)
|
80
|
-
end
|
81
|
-
|
82
|
-
# The {#onComponentTypeChanged} event is fired when a component is converted to
|
83
|
-
# a group or vice versa. (In the underlying implementation, {Sketchup::Group}s
|
84
|
-
# are just a special kind of definition that is allowed to only have a single
|
85
|
-
# instance.)
|
86
|
-
#
|
87
|
-
# @example
|
88
|
-
# def onComponentTypeChanged(definitions, definition)
|
89
|
-
# puts "onComponentTypeChanged: #{definition}"
|
90
|
-
# end
|
91
|
-
#
|
92
|
-
# @param [Sketchup::DefinitionList] definitions
|
93
|
-
#
|
94
|
-
# @param [Sketchup::ComponentDefinition] definition
|
95
|
-
#
|
96
|
-
# @return [nil]
|
97
|
-
#
|
98
|
-
# @version SketchUp 6.0
|
99
|
-
def onComponentTypeChanged(definitions, definition)
|
100
|
-
end
|
101
|
-
|
102
|
-
end
|
1
|
+
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# This observer interface is implemented to react to events on a definitions
|
5
|
+
# collection. To implement this observer, create a Ruby class of this type,
|
6
|
+
# override the desired methods, and add an instance of the observer to the
|
7
|
+
# collection of interest.
|
8
|
+
#
|
9
|
+
# @example
|
10
|
+
# class MyDefinitionsObserver < Sketchup::DefinitionsObserver
|
11
|
+
# def onComponentAdded(definitions, definition)
|
12
|
+
# puts "onComponentAdded: #{definition.name}"
|
13
|
+
# end
|
14
|
+
# end
|
15
|
+
#
|
16
|
+
# Sketchup.active_model.definitions.add_observer(MyDefinitionsObserver.new)
|
17
|
+
#
|
18
|
+
# @version SketchUp 6.0
|
19
|
+
class Sketchup::DefinitionsObserver
|
20
|
+
|
21
|
+
# Instance Methods
|
22
|
+
|
23
|
+
# The {#onComponentAdded} method is called whenever a definition is added to
|
24
|
+
# the definitions collection.
|
25
|
+
#
|
26
|
+
# @example
|
27
|
+
# def onComponentAdded(definitions, definition)
|
28
|
+
# puts "onComponentAdded: #{definition}"
|
29
|
+
# end
|
30
|
+
#
|
31
|
+
# @param [Sketchup::DefinitionList] definitions
|
32
|
+
#
|
33
|
+
# @param [Sketchup::ComponentDefinition] definition
|
34
|
+
#
|
35
|
+
# @return [nil]
|
36
|
+
#
|
37
|
+
# @version SketchUp 6.0
|
38
|
+
def onComponentAdded(definitions, definition)
|
39
|
+
end
|
40
|
+
|
41
|
+
# The {#onComponentPropertiesChanged} method is called whenever a definition's
|
42
|
+
# name or description are changed.
|
43
|
+
#
|
44
|
+
# This does not fire when "Glue To", "Cuts Opening", or "Face Camera" settings
|
45
|
+
# are changed.
|
46
|
+
#
|
47
|
+
# @example
|
48
|
+
# def onComponentPropertiesChanged(definitions, definition)
|
49
|
+
# puts "onComponentPropertiesChanged: #{definition}"
|
50
|
+
# end
|
51
|
+
#
|
52
|
+
# @param [Sketchup::DefinitionList] definitions
|
53
|
+
#
|
54
|
+
# @param [Sketchup::ComponentDefinition] definition
|
55
|
+
#
|
56
|
+
# @return [nil]
|
57
|
+
#
|
58
|
+
# @version SketchUp 6.0
|
59
|
+
def onComponentPropertiesChanged(definitions, definition)
|
60
|
+
end
|
61
|
+
|
62
|
+
# The {#onComponentAdded} method is called whenever a definition is removed
|
63
|
+
# from the definitions collection.
|
64
|
+
#
|
65
|
+
# @example
|
66
|
+
# def onComponentRemoved(definitions, definition)
|
67
|
+
# puts "onComponentRemoved: #{definition}"
|
68
|
+
# end
|
69
|
+
#
|
70
|
+
# @note This methods fires twice for each Component/Group erased.
|
71
|
+
#
|
72
|
+
# @param [Sketchup::DefinitionList] definitions
|
73
|
+
#
|
74
|
+
# @param [Sketchup::ComponentDefinition] definition
|
75
|
+
#
|
76
|
+
# @return [nil]
|
77
|
+
#
|
78
|
+
# @version SketchUp 6.0
|
79
|
+
def onComponentRemoved(definitions, definition)
|
80
|
+
end
|
81
|
+
|
82
|
+
# The {#onComponentTypeChanged} event is fired when a component is converted to
|
83
|
+
# a group or vice versa. (In the underlying implementation, {Sketchup::Group}s
|
84
|
+
# are just a special kind of definition that is allowed to only have a single
|
85
|
+
# instance.)
|
86
|
+
#
|
87
|
+
# @example
|
88
|
+
# def onComponentTypeChanged(definitions, definition)
|
89
|
+
# puts "onComponentTypeChanged: #{definition}"
|
90
|
+
# end
|
91
|
+
#
|
92
|
+
# @param [Sketchup::DefinitionList] definitions
|
93
|
+
#
|
94
|
+
# @param [Sketchup::ComponentDefinition] definition
|
95
|
+
#
|
96
|
+
# @return [nil]
|
97
|
+
#
|
98
|
+
# @version SketchUp 6.0
|
99
|
+
def onComponentTypeChanged(definitions, definition)
|
100
|
+
end
|
101
|
+
|
102
|
+
end
|
@@ -1,165 +1,165 @@
|
|
1
|
-
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# The Dimension class provides base functionality for classes DimensionLinear
|
5
|
-
# and DimensionRadial. It's not instantiable.
|
6
|
-
#
|
7
|
-
# @version SketchUp 2014
|
8
|
-
class Sketchup::Dimension < Sketchup::Drawingelement
|
9
|
-
|
10
|
-
# Constants
|
11
|
-
|
12
|
-
ARROW_CLOSED = nil # Stub value.
|
13
|
-
ARROW_DOT = nil # Stub value.
|
14
|
-
ARROW_NONE = nil # Stub value.
|
15
|
-
ARROW_OPEN = nil # Stub value.
|
16
|
-
ARROW_SLASH = nil # Stub value.
|
17
|
-
|
18
|
-
# Instance Methods
|
19
|
-
|
20
|
-
# The add_observer method is used to add a DimensionObserver to the dimension.
|
21
|
-
#
|
22
|
-
# @example
|
23
|
-
# observer = MyDimObserver.new
|
24
|
-
# dim = Sketchup.active_model.entities.add_dimension_linear([50, 10, 0],
|
25
|
-
# [100, 10, 0], [0, 20, 0])
|
26
|
-
# status = dim.add_observer(observer)
|
27
|
-
#
|
28
|
-
# @note If the given observer responds to +onTextChanged+, it will be
|
29
|
-
# added as a {Sketchup::DimensionObserver}. If not, the base
|
30
|
-
# {Sketchup::Entity#add_observer} will be called.
|
31
|
-
#
|
32
|
-
# @param observer
|
33
|
-
# A DimensionObserver.
|
34
|
-
#
|
35
|
-
# @return true if successful, false if unsuccessful.
|
36
|
-
#
|
37
|
-
# @version SketchUp 2014
|
38
|
-
def add_observer(observer)
|
39
|
-
end
|
40
|
-
|
41
|
-
# The arrow_type method retrieves the current arrow type of the dimension.
|
42
|
-
# Valid arrow types are class constants:
|
43
|
-
# - +Dimension::ARROW_NONE,+
|
44
|
-
# - +Dimension::ARROW_SLASH+
|
45
|
-
# - +Dimension::ARROW_DOT+
|
46
|
-
# - +Dimension::ARROW_CLOSED+
|
47
|
-
# - +Dimension::ARROW_OPEN+
|
48
|
-
#
|
49
|
-
# @example
|
50
|
-
# type = dim.arrow_type
|
51
|
-
# if type == Sketchup::Dimension::ARROW_CLOSED
|
52
|
-
# puts "Arrow type is closed"
|
53
|
-
# end
|
54
|
-
#
|
55
|
-
# @return a numerical representation of the arrow type
|
56
|
-
#
|
57
|
-
# @version SketchUp 2014
|
58
|
-
def arrow_type
|
59
|
-
end
|
60
|
-
|
61
|
-
# The arrow_type= method sets the arrow type of the dimension.
|
62
|
-
# Valid arrow types are class constants:
|
63
|
-
# - +Dimension::ARROW_NONE,+
|
64
|
-
# - +Dimension::ARROW_SLASH+
|
65
|
-
# - +Dimension::ARROW_DOT+
|
66
|
-
# - +Dimension::ARROW_CLOSED+
|
67
|
-
# - +Dimension::ARROW_OPEN+
|
68
|
-
#
|
69
|
-
# @example
|
70
|
-
# dim.arrow_type = Sketchup::Dimension::ARROW_CLOSED
|
71
|
-
#
|
72
|
-
# @param type
|
73
|
-
# a numerical representation of the arrow type.
|
74
|
-
#
|
75
|
-
# @return the arrow type that was set.
|
76
|
-
#
|
77
|
-
# @version SketchUp 2014
|
78
|
-
def arrow_type=(type)
|
79
|
-
end
|
80
|
-
|
81
|
-
# The has_aligned_text= method accepts true or false indicating whether the
|
82
|
-
# dimension's text is aligned to the dimension or to the screen.
|
83
|
-
#
|
84
|
-
# @example
|
85
|
-
# dim.has_aligned_text = true
|
86
|
-
#
|
87
|
-
# @param [Boolean] value
|
88
|
-
#
|
89
|
-
# @return the alignment flag that was set
|
90
|
-
#
|
91
|
-
# @version SketchUp 2014
|
92
|
-
def has_aligned_text=(value)
|
93
|
-
end
|
94
|
-
|
95
|
-
# The has_aligned_text method is used to determine whether the dimension's text
|
96
|
-
# is aligned to the dimension or to the screen.
|
97
|
-
#
|
98
|
-
# @example
|
99
|
-
# aligned = dim.has_aligned_text?
|
100
|
-
#
|
101
|
-
# @return [Boolean] status - true if text is aligned to the dimension.
|
102
|
-
# False if dimension text is aligned to the screen.
|
103
|
-
#
|
104
|
-
# @version SketchUp 2014
|
105
|
-
def has_aligned_text?
|
106
|
-
end
|
107
|
-
|
108
|
-
# The plane method is used to retrieve the plane of the dimension. Refer to the
|
109
|
-
# Geom module for information on how planes are represented.
|
110
|
-
#
|
111
|
-
# @example
|
112
|
-
# plane = dim.plane
|
113
|
-
#
|
114
|
-
# @return the plane of the dimension
|
115
|
-
#
|
116
|
-
# @version SketchUp 2014
|
117
|
-
def plane
|
118
|
-
end
|
119
|
-
|
120
|
-
# The remove_observer method is used to remove a DimensionObserver from the
|
121
|
-
# dimension. Note that, if the given observer responds to 'onTextChanged', it
|
122
|
-
# will be removed as a DimensionObserver. If not, the base
|
123
|
-
# Entity.remove_observer will be called.
|
124
|
-
#
|
125
|
-
# @example
|
126
|
-
# observer = MyDimObserver.new
|
127
|
-
# dim = Sketchup.active_model.entities.add_dimension_linear([50, 10, 0],
|
128
|
-
# [100, 10, 0], [0, 20, 0])
|
129
|
-
# status = dim.add_observer(observer)
|
130
|
-
# status = dim.remove_observer(observer)
|
131
|
-
#
|
132
|
-
# @param observer
|
133
|
-
# A DimensionObserver.
|
134
|
-
#
|
135
|
-
# @return true if successful, false if unsuccessful.
|
136
|
-
#
|
137
|
-
# @version SketchUp 2014
|
138
|
-
def remove_observer(observer)
|
139
|
-
end
|
140
|
-
|
141
|
-
# The text method is used to retrieve the dimension text.
|
142
|
-
#
|
143
|
-
# @example
|
144
|
-
# dimtext = dim.text
|
145
|
-
#
|
146
|
-
# @return the dimension text
|
147
|
-
#
|
148
|
-
# @version SketchUp 2014
|
149
|
-
def text
|
150
|
-
end
|
151
|
-
|
152
|
-
# The text= method is used to set an override on the dimension text.
|
153
|
-
#
|
154
|
-
# @example
|
155
|
-
# dim.text= "text"
|
156
|
-
#
|
157
|
-
# @param [String] text
|
158
|
-
#
|
159
|
-
# @return the newly set text override
|
160
|
-
#
|
161
|
-
# @version SketchUp 2014
|
162
|
-
def text=(text)
|
163
|
-
end
|
164
|
-
|
165
|
-
end
|
1
|
+
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# The Dimension class provides base functionality for classes DimensionLinear
|
5
|
+
# and DimensionRadial. It's not instantiable.
|
6
|
+
#
|
7
|
+
# @version SketchUp 2014
|
8
|
+
class Sketchup::Dimension < Sketchup::Drawingelement
|
9
|
+
|
10
|
+
# Constants
|
11
|
+
|
12
|
+
ARROW_CLOSED = nil # Stub value.
|
13
|
+
ARROW_DOT = nil # Stub value.
|
14
|
+
ARROW_NONE = nil # Stub value.
|
15
|
+
ARROW_OPEN = nil # Stub value.
|
16
|
+
ARROW_SLASH = nil # Stub value.
|
17
|
+
|
18
|
+
# Instance Methods
|
19
|
+
|
20
|
+
# The add_observer method is used to add a DimensionObserver to the dimension.
|
21
|
+
#
|
22
|
+
# @example
|
23
|
+
# observer = MyDimObserver.new
|
24
|
+
# dim = Sketchup.active_model.entities.add_dimension_linear([50, 10, 0],
|
25
|
+
# [100, 10, 0], [0, 20, 0])
|
26
|
+
# status = dim.add_observer(observer)
|
27
|
+
#
|
28
|
+
# @note If the given observer responds to +onTextChanged+, it will be
|
29
|
+
# added as a {Sketchup::DimensionObserver}. If not, the base
|
30
|
+
# {Sketchup::Entity#add_observer} will be called.
|
31
|
+
#
|
32
|
+
# @param observer
|
33
|
+
# A DimensionObserver.
|
34
|
+
#
|
35
|
+
# @return true if successful, false if unsuccessful.
|
36
|
+
#
|
37
|
+
# @version SketchUp 2014
|
38
|
+
def add_observer(observer)
|
39
|
+
end
|
40
|
+
|
41
|
+
# The arrow_type method retrieves the current arrow type of the dimension.
|
42
|
+
# Valid arrow types are class constants:
|
43
|
+
# - +Dimension::ARROW_NONE,+
|
44
|
+
# - +Dimension::ARROW_SLASH+
|
45
|
+
# - +Dimension::ARROW_DOT+
|
46
|
+
# - +Dimension::ARROW_CLOSED+
|
47
|
+
# - +Dimension::ARROW_OPEN+
|
48
|
+
#
|
49
|
+
# @example
|
50
|
+
# type = dim.arrow_type
|
51
|
+
# if type == Sketchup::Dimension::ARROW_CLOSED
|
52
|
+
# puts "Arrow type is closed"
|
53
|
+
# end
|
54
|
+
#
|
55
|
+
# @return a numerical representation of the arrow type
|
56
|
+
#
|
57
|
+
# @version SketchUp 2014
|
58
|
+
def arrow_type
|
59
|
+
end
|
60
|
+
|
61
|
+
# The arrow_type= method sets the arrow type of the dimension.
|
62
|
+
# Valid arrow types are class constants:
|
63
|
+
# - +Dimension::ARROW_NONE,+
|
64
|
+
# - +Dimension::ARROW_SLASH+
|
65
|
+
# - +Dimension::ARROW_DOT+
|
66
|
+
# - +Dimension::ARROW_CLOSED+
|
67
|
+
# - +Dimension::ARROW_OPEN+
|
68
|
+
#
|
69
|
+
# @example
|
70
|
+
# dim.arrow_type = Sketchup::Dimension::ARROW_CLOSED
|
71
|
+
#
|
72
|
+
# @param type
|
73
|
+
# a numerical representation of the arrow type.
|
74
|
+
#
|
75
|
+
# @return the arrow type that was set.
|
76
|
+
#
|
77
|
+
# @version SketchUp 2014
|
78
|
+
def arrow_type=(type)
|
79
|
+
end
|
80
|
+
|
81
|
+
# The has_aligned_text= method accepts true or false indicating whether the
|
82
|
+
# dimension's text is aligned to the dimension or to the screen.
|
83
|
+
#
|
84
|
+
# @example
|
85
|
+
# dim.has_aligned_text = true
|
86
|
+
#
|
87
|
+
# @param [Boolean] value
|
88
|
+
#
|
89
|
+
# @return the alignment flag that was set
|
90
|
+
#
|
91
|
+
# @version SketchUp 2014
|
92
|
+
def has_aligned_text=(value)
|
93
|
+
end
|
94
|
+
|
95
|
+
# The has_aligned_text method is used to determine whether the dimension's text
|
96
|
+
# is aligned to the dimension or to the screen.
|
97
|
+
#
|
98
|
+
# @example
|
99
|
+
# aligned = dim.has_aligned_text?
|
100
|
+
#
|
101
|
+
# @return [Boolean] status - true if text is aligned to the dimension.
|
102
|
+
# False if dimension text is aligned to the screen.
|
103
|
+
#
|
104
|
+
# @version SketchUp 2014
|
105
|
+
def has_aligned_text?
|
106
|
+
end
|
107
|
+
|
108
|
+
# The plane method is used to retrieve the plane of the dimension. Refer to the
|
109
|
+
# Geom module for information on how planes are represented.
|
110
|
+
#
|
111
|
+
# @example
|
112
|
+
# plane = dim.plane
|
113
|
+
#
|
114
|
+
# @return the plane of the dimension
|
115
|
+
#
|
116
|
+
# @version SketchUp 2014
|
117
|
+
def plane
|
118
|
+
end
|
119
|
+
|
120
|
+
# The remove_observer method is used to remove a DimensionObserver from the
|
121
|
+
# dimension. Note that, if the given observer responds to 'onTextChanged', it
|
122
|
+
# will be removed as a DimensionObserver. If not, the base
|
123
|
+
# Entity.remove_observer will be called.
|
124
|
+
#
|
125
|
+
# @example
|
126
|
+
# observer = MyDimObserver.new
|
127
|
+
# dim = Sketchup.active_model.entities.add_dimension_linear([50, 10, 0],
|
128
|
+
# [100, 10, 0], [0, 20, 0])
|
129
|
+
# status = dim.add_observer(observer)
|
130
|
+
# status = dim.remove_observer(observer)
|
131
|
+
#
|
132
|
+
# @param observer
|
133
|
+
# A DimensionObserver.
|
134
|
+
#
|
135
|
+
# @return true if successful, false if unsuccessful.
|
136
|
+
#
|
137
|
+
# @version SketchUp 2014
|
138
|
+
def remove_observer(observer)
|
139
|
+
end
|
140
|
+
|
141
|
+
# The text method is used to retrieve the dimension text.
|
142
|
+
#
|
143
|
+
# @example
|
144
|
+
# dimtext = dim.text
|
145
|
+
#
|
146
|
+
# @return the dimension text
|
147
|
+
#
|
148
|
+
# @version SketchUp 2014
|
149
|
+
def text
|
150
|
+
end
|
151
|
+
|
152
|
+
# The text= method is used to set an override on the dimension text.
|
153
|
+
#
|
154
|
+
# @example
|
155
|
+
# dim.text= "text"
|
156
|
+
#
|
157
|
+
# @param [String] text
|
158
|
+
#
|
159
|
+
# @return the newly set text override
|
160
|
+
#
|
161
|
+
# @version SketchUp 2014
|
162
|
+
def text=(text)
|
163
|
+
end
|
164
|
+
|
165
|
+
end
|