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,44 +1,44 @@
|
|
1
|
-
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# This observer interface is implemented to react to rendering options events.
|
5
|
-
# To implement this observer, create a Ruby class of this type, implement the
|
6
|
-
# desired methods, and add an instance of the observer to the objects of
|
7
|
-
# interests.
|
8
|
-
#
|
9
|
-
# @example
|
10
|
-
# # This is an example of an observer that watches the rendering options
|
11
|
-
# # for changes.
|
12
|
-
# class MyRenderingOptionsObserver < Sketchup::RenderingOptionsObserver
|
13
|
-
# def onRenderingOptionsChanged(rendering_options, type)
|
14
|
-
# puts "onRenderingOptionsChanged(#{rendering_options}, #{type})"
|
15
|
-
# end
|
16
|
-
# end
|
17
|
-
#
|
18
|
-
# # Attach the observer.
|
19
|
-
# rendering_options = Sketchup.active_model.rendering_options
|
20
|
-
# rendering_options.add_observer(MyRenderingOptionsObserver.new)
|
21
|
-
class Sketchup::RenderingOptionsObserver
|
22
|
-
|
23
|
-
# Instance Methods
|
24
|
-
|
25
|
-
# The onRenderingOptionsChanged method is invoked whenever the user changes
|
26
|
-
# their rendering options.
|
27
|
-
#
|
28
|
-
# @example
|
29
|
-
# def onRenderingOptionsChanged(rendering_options, type)
|
30
|
-
# puts "onRenderingOptionsChanged(#{rendering_options}, #{type})"
|
31
|
-
# end
|
32
|
-
#
|
33
|
-
# @param [Sketchup::RenderingOptions] rendering_options
|
34
|
-
#
|
35
|
-
# @param [Integer] type
|
36
|
-
# A number indicating which option was changed
|
37
|
-
# represented by one of the constants defined in
|
38
|
-
# {Sketchup::RenderingOptions}.
|
39
|
-
#
|
40
|
-
# @version SketchUp 6.0
|
41
|
-
def onRenderingOptionsChanged(rendering_options, type)
|
42
|
-
end
|
43
|
-
|
44
|
-
end
|
1
|
+
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# This observer interface is implemented to react to rendering options events.
|
5
|
+
# To implement this observer, create a Ruby class of this type, implement the
|
6
|
+
# desired methods, and add an instance of the observer to the objects of
|
7
|
+
# interests.
|
8
|
+
#
|
9
|
+
# @example
|
10
|
+
# # This is an example of an observer that watches the rendering options
|
11
|
+
# # for changes.
|
12
|
+
# class MyRenderingOptionsObserver < Sketchup::RenderingOptionsObserver
|
13
|
+
# def onRenderingOptionsChanged(rendering_options, type)
|
14
|
+
# puts "onRenderingOptionsChanged(#{rendering_options}, #{type})"
|
15
|
+
# end
|
16
|
+
# end
|
17
|
+
#
|
18
|
+
# # Attach the observer.
|
19
|
+
# rendering_options = Sketchup.active_model.rendering_options
|
20
|
+
# rendering_options.add_observer(MyRenderingOptionsObserver.new)
|
21
|
+
class Sketchup::RenderingOptionsObserver
|
22
|
+
|
23
|
+
# Instance Methods
|
24
|
+
|
25
|
+
# The onRenderingOptionsChanged method is invoked whenever the user changes
|
26
|
+
# their rendering options.
|
27
|
+
#
|
28
|
+
# @example
|
29
|
+
# def onRenderingOptionsChanged(rendering_options, type)
|
30
|
+
# puts "onRenderingOptionsChanged(#{rendering_options}, #{type})"
|
31
|
+
# end
|
32
|
+
#
|
33
|
+
# @param [Sketchup::RenderingOptions] rendering_options
|
34
|
+
#
|
35
|
+
# @param [Integer] type
|
36
|
+
# A number indicating which option was changed
|
37
|
+
# represented by one of the constants defined in
|
38
|
+
# {Sketchup::RenderingOptions}.
|
39
|
+
#
|
40
|
+
# @version SketchUp 6.0
|
41
|
+
def onRenderingOptionsChanged(rendering_options, type)
|
42
|
+
end
|
43
|
+
|
44
|
+
end
|
@@ -1,150 +1,150 @@
|
|
1
|
-
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# The SectionPlane class represents a section plane in a SketchUp model. Note
|
5
|
-
# that prior to SketchUp 2014 there was no way to create a SectionPlane object
|
6
|
-
# using Ruby. For older versions of SketchUp, you must manually create a
|
7
|
-
# section plane with the Section Plane Tool in SketchUp and then query the
|
8
|
-
# entities array to find the SectionPlane object.
|
9
|
-
#
|
10
|
-
# @version SketchUp 6.0
|
11
|
-
class Sketchup::SectionPlane < Sketchup::Drawingelement
|
12
|
-
|
13
|
-
# Instance Methods
|
14
|
-
|
15
|
-
# The activate method is used to make the section plane the active one of its
|
16
|
-
# parent component/group.
|
17
|
-
#
|
18
|
-
# @example
|
19
|
-
# entities = Sketchup.active_model.entities
|
20
|
-
# sp = entities.add_section_plane([50, 50, 0], [1.0, 1.0, 0])
|
21
|
-
# sp.activate
|
22
|
-
#
|
23
|
-
# @return self if successful
|
24
|
-
#
|
25
|
-
# @version SketchUp 2014
|
26
|
-
def activate
|
27
|
-
end
|
28
|
-
|
29
|
-
# The active? method indicates whether the section plane is active or not.
|
30
|
-
#
|
31
|
-
# @example
|
32
|
-
# entities = Sketchup.active_model.entities
|
33
|
-
# sp = entities.add_section_plane([50, 50, 0], [1.0, 1.0, 0])
|
34
|
-
# sp.activate
|
35
|
-
# if sp.active?
|
36
|
-
# puts "Yes, it is active"
|
37
|
-
# end
|
38
|
-
#
|
39
|
-
# @return [Boolean] boolean - true if active
|
40
|
-
#
|
41
|
-
# @version SketchUp 2014
|
42
|
-
def active?
|
43
|
-
end
|
44
|
-
|
45
|
-
# The get_plane method is used to retrieve the plane that the section plane is
|
46
|
-
# on.
|
47
|
-
#
|
48
|
-
# @example
|
49
|
-
# model = Sketchup.active_model
|
50
|
-
# entities = model.active_entities
|
51
|
-
# # Grab the first section plane from the model.
|
52
|
-
# sp = entities.grep(Sketchup::SectionPlane).first
|
53
|
-
# plane = sp.get_plane
|
54
|
-
# if (plane)
|
55
|
-
# puts plane.to_s
|
56
|
-
# else
|
57
|
-
# puts 'Failure'
|
58
|
-
# end
|
59
|
-
#
|
60
|
-
# @return plane - a plane. See the Geom module and Array class
|
61
|
-
# for further information on planes.
|
62
|
-
#
|
63
|
-
# @version SketchUp 6.0
|
64
|
-
def get_plane
|
65
|
-
end
|
66
|
-
|
67
|
-
# The {#name} method is used to retrieve the name of the section plane.
|
68
|
-
#
|
69
|
-
# @example
|
70
|
-
# model = Sketchup.active_model
|
71
|
-
# entities = model.active_entities
|
72
|
-
# # Grab the first section plane from the model.
|
73
|
-
# section_plane = entities.grep(Sketchup::SectionPlane).first
|
74
|
-
# name = section_plane.name
|
75
|
-
#
|
76
|
-
# @return [String]
|
77
|
-
#
|
78
|
-
# @version SketchUp 2018
|
79
|
-
def name
|
80
|
-
end
|
81
|
-
|
82
|
-
# The {#name=} method is used to set the name of a section plane.
|
83
|
-
#
|
84
|
-
# @example
|
85
|
-
# model = Sketchup.active_model
|
86
|
-
# entities = Sketchup.active_model.entities
|
87
|
-
# # Grab the first section plane from the model.
|
88
|
-
# section_plane = entities.grep(Sketchup::SectionPlane).first
|
89
|
-
# section_plane.name = "my section plane"
|
90
|
-
#
|
91
|
-
# @param [String] name
|
92
|
-
# The new name for the section plane object.
|
93
|
-
#
|
94
|
-
# @version SketchUp 2018
|
95
|
-
def name=(name)
|
96
|
-
end
|
97
|
-
|
98
|
-
# The set_plane method is used to set the plane that the section plane is
|
99
|
-
# on.
|
100
|
-
#
|
101
|
-
# @example
|
102
|
-
# model = Sketchup.active_model
|
103
|
-
# entities = model.active_entities
|
104
|
-
# # Grab the first section plane from the model.
|
105
|
-
# sp = entities.grep(Sketchup::SectionPlane).first
|
106
|
-
# sp = sp.set_plane my_plane_array
|
107
|
-
#
|
108
|
-
# @param plane
|
109
|
-
# An array representing the new plane,
|
110
|
-
#
|
111
|
-
# @return section_plane - the updated SectionPlane.
|
112
|
-
#
|
113
|
-
# @version SketchUp 6.0
|
114
|
-
def set_plane(plane)
|
115
|
-
end
|
116
|
-
|
117
|
-
# The {#symbol} method is used to retrieve the symbol of the section plane.
|
118
|
-
#
|
119
|
-
# @example
|
120
|
-
# model = Sketchup.active_model
|
121
|
-
# entities = model.active_entities
|
122
|
-
# # Grab the first section plane from the model.
|
123
|
-
# section_plane = entities.grep(Sketchup::SectionPlane).first
|
124
|
-
# symbol = section_plane.symbol
|
125
|
-
#
|
126
|
-
# @return [String]
|
127
|
-
#
|
128
|
-
# @version SketchUp 2018
|
129
|
-
def symbol
|
130
|
-
end
|
131
|
-
|
132
|
-
# The {#symbol=} method is used to set the symbol of a section plane.
|
133
|
-
#
|
134
|
-
# @example
|
135
|
-
# model = Sketchup.active_model
|
136
|
-
# entities = Sketchup.active_model.entities
|
137
|
-
# # Grab the first section plane from the model.
|
138
|
-
# section_plane = entities.grep(Sketchup::SectionPlane).first
|
139
|
-
# section_plane.symbol = "AB1"
|
140
|
-
#
|
141
|
-
# @note The symbol must be three characters or less.
|
142
|
-
#
|
143
|
-
# @param [String] symbol
|
144
|
-
# The new symbol for the section plane object.
|
145
|
-
#
|
146
|
-
# @version SketchUp 2018
|
147
|
-
def symbol=(symbol)
|
148
|
-
end
|
149
|
-
|
150
|
-
end
|
1
|
+
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# The SectionPlane class represents a section plane in a SketchUp model. Note
|
5
|
+
# that prior to SketchUp 2014 there was no way to create a SectionPlane object
|
6
|
+
# using Ruby. For older versions of SketchUp, you must manually create a
|
7
|
+
# section plane with the Section Plane Tool in SketchUp and then query the
|
8
|
+
# entities array to find the SectionPlane object.
|
9
|
+
#
|
10
|
+
# @version SketchUp 6.0
|
11
|
+
class Sketchup::SectionPlane < Sketchup::Drawingelement
|
12
|
+
|
13
|
+
# Instance Methods
|
14
|
+
|
15
|
+
# The activate method is used to make the section plane the active one of its
|
16
|
+
# parent component/group.
|
17
|
+
#
|
18
|
+
# @example
|
19
|
+
# entities = Sketchup.active_model.entities
|
20
|
+
# sp = entities.add_section_plane([50, 50, 0], [1.0, 1.0, 0])
|
21
|
+
# sp.activate
|
22
|
+
#
|
23
|
+
# @return self if successful
|
24
|
+
#
|
25
|
+
# @version SketchUp 2014
|
26
|
+
def activate
|
27
|
+
end
|
28
|
+
|
29
|
+
# The active? method indicates whether the section plane is active or not.
|
30
|
+
#
|
31
|
+
# @example
|
32
|
+
# entities = Sketchup.active_model.entities
|
33
|
+
# sp = entities.add_section_plane([50, 50, 0], [1.0, 1.0, 0])
|
34
|
+
# sp.activate
|
35
|
+
# if sp.active?
|
36
|
+
# puts "Yes, it is active"
|
37
|
+
# end
|
38
|
+
#
|
39
|
+
# @return [Boolean] boolean - true if active
|
40
|
+
#
|
41
|
+
# @version SketchUp 2014
|
42
|
+
def active?
|
43
|
+
end
|
44
|
+
|
45
|
+
# The get_plane method is used to retrieve the plane that the section plane is
|
46
|
+
# on.
|
47
|
+
#
|
48
|
+
# @example
|
49
|
+
# model = Sketchup.active_model
|
50
|
+
# entities = model.active_entities
|
51
|
+
# # Grab the first section plane from the model.
|
52
|
+
# sp = entities.grep(Sketchup::SectionPlane).first
|
53
|
+
# plane = sp.get_plane
|
54
|
+
# if (plane)
|
55
|
+
# puts plane.to_s
|
56
|
+
# else
|
57
|
+
# puts 'Failure'
|
58
|
+
# end
|
59
|
+
#
|
60
|
+
# @return plane - a plane. See the Geom module and Array class
|
61
|
+
# for further information on planes.
|
62
|
+
#
|
63
|
+
# @version SketchUp 6.0
|
64
|
+
def get_plane
|
65
|
+
end
|
66
|
+
|
67
|
+
# The {#name} method is used to retrieve the name of the section plane.
|
68
|
+
#
|
69
|
+
# @example
|
70
|
+
# model = Sketchup.active_model
|
71
|
+
# entities = model.active_entities
|
72
|
+
# # Grab the first section plane from the model.
|
73
|
+
# section_plane = entities.grep(Sketchup::SectionPlane).first
|
74
|
+
# name = section_plane.name
|
75
|
+
#
|
76
|
+
# @return [String]
|
77
|
+
#
|
78
|
+
# @version SketchUp 2018
|
79
|
+
def name
|
80
|
+
end
|
81
|
+
|
82
|
+
# The {#name=} method is used to set the name of a section plane.
|
83
|
+
#
|
84
|
+
# @example
|
85
|
+
# model = Sketchup.active_model
|
86
|
+
# entities = Sketchup.active_model.entities
|
87
|
+
# # Grab the first section plane from the model.
|
88
|
+
# section_plane = entities.grep(Sketchup::SectionPlane).first
|
89
|
+
# section_plane.name = "my section plane"
|
90
|
+
#
|
91
|
+
# @param [String] name
|
92
|
+
# The new name for the section plane object.
|
93
|
+
#
|
94
|
+
# @version SketchUp 2018
|
95
|
+
def name=(name)
|
96
|
+
end
|
97
|
+
|
98
|
+
# The set_plane method is used to set the plane that the section plane is
|
99
|
+
# on.
|
100
|
+
#
|
101
|
+
# @example
|
102
|
+
# model = Sketchup.active_model
|
103
|
+
# entities = model.active_entities
|
104
|
+
# # Grab the first section plane from the model.
|
105
|
+
# sp = entities.grep(Sketchup::SectionPlane).first
|
106
|
+
# sp = sp.set_plane my_plane_array
|
107
|
+
#
|
108
|
+
# @param plane
|
109
|
+
# An array representing the new plane,
|
110
|
+
#
|
111
|
+
# @return section_plane - the updated SectionPlane.
|
112
|
+
#
|
113
|
+
# @version SketchUp 6.0
|
114
|
+
def set_plane(plane)
|
115
|
+
end
|
116
|
+
|
117
|
+
# The {#symbol} method is used to retrieve the symbol of the section plane.
|
118
|
+
#
|
119
|
+
# @example
|
120
|
+
# model = Sketchup.active_model
|
121
|
+
# entities = model.active_entities
|
122
|
+
# # Grab the first section plane from the model.
|
123
|
+
# section_plane = entities.grep(Sketchup::SectionPlane).first
|
124
|
+
# symbol = section_plane.symbol
|
125
|
+
#
|
126
|
+
# @return [String]
|
127
|
+
#
|
128
|
+
# @version SketchUp 2018
|
129
|
+
def symbol
|
130
|
+
end
|
131
|
+
|
132
|
+
# The {#symbol=} method is used to set the symbol of a section plane.
|
133
|
+
#
|
134
|
+
# @example
|
135
|
+
# model = Sketchup.active_model
|
136
|
+
# entities = Sketchup.active_model.entities
|
137
|
+
# # Grab the first section plane from the model.
|
138
|
+
# section_plane = entities.grep(Sketchup::SectionPlane).first
|
139
|
+
# section_plane.symbol = "AB1"
|
140
|
+
#
|
141
|
+
# @note The symbol must be three characters or less.
|
142
|
+
#
|
143
|
+
# @param [String] symbol
|
144
|
+
# The new symbol for the section plane object.
|
145
|
+
#
|
146
|
+
# @version SketchUp 2018
|
147
|
+
def symbol=(symbol)
|
148
|
+
end
|
149
|
+
|
150
|
+
end
|
@@ -1,454 +1,454 @@
|
|
1
|
-
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# A set of the currently selected entities. Use the Model.selection method
|
5
|
-
# to get a Selection object. Note that the order of entities
|
6
|
-
# (<code>selection[0]</code>, <code>selection[1]</code> and so on) in the set
|
7
|
-
# is in no particular order and should not be assumed to be in the same order
|
8
|
-
# as the user selected the entities.
|
9
|
-
#
|
10
|
-
# @example
|
11
|
-
# # Get a handle to the selection set.
|
12
|
-
# model = Sketchup.active_model
|
13
|
-
# selection = model.selection
|
14
|
-
#
|
15
|
-
# @version SketchUp 6.0
|
16
|
-
class Sketchup::Selection
|
17
|
-
|
18
|
-
# Includes
|
19
|
-
|
20
|
-
include Enumerable
|
21
|
-
|
22
|
-
# Instance Methods
|
23
|
-
|
24
|
-
# The {#[]} method is used to retrieve an {Sketchup::Entity} from the selection
|
25
|
-
# by index. Index 0 is the first entity in the selection.
|
26
|
-
#
|
27
|
-
# This method is not very efficient. If you need to look at every entity in
|
28
|
-
# the selection, consider using {#each} instead of using this method
|
29
|
-
# to manually grab each one.
|
30
|
-
#
|
31
|
-
# @example
|
32
|
-
# model = Sketchup.active_model
|
33
|
-
# entities = model.active_entities
|
34
|
-
# selection = model.selection
|
35
|
-
# selection.add(entities.to_a)
|
36
|
-
# p selection[0]
|
37
|
-
#
|
38
|
-
# @param [Integer] index
|
39
|
-
# The index of the Entity object to retrieve.
|
40
|
-
#
|
41
|
-
# @return [Sketchup::Entitiy, nil]
|
42
|
-
#
|
43
|
-
# @see #at
|
44
|
-
#
|
45
|
-
# @version SketchUp 6.0
|
46
|
-
def [](index)
|
47
|
-
end
|
48
|
-
|
49
|
-
# The add method is used to add entities to the selection. Entities that are
|
50
|
-
# added to the Selection are visually indicated by the selection bounding box.
|
51
|
-
#
|
52
|
-
# You can pass it individual Entities or an Array of Entities:
|
53
|
-
# Note that the add, remove, and toggle methods are all aliases for one
|
54
|
-
# another. So if you call remove on an entity that is not selected, it will
|
55
|
-
# be toggled to be selected, not removed! Be cautious when writing your code to
|
56
|
-
# not make the assumption about the currently selected state of a given entity.
|
57
|
-
#
|
58
|
-
# @example
|
59
|
-
# # Add by listing the entities...
|
60
|
-
# ss.add(e1, e2, e3)
|
61
|
-
#
|
62
|
-
# # ...or add by passing an Array of entities.
|
63
|
-
# ss.add([e1, e2, e3])
|
64
|
-
#
|
65
|
-
# @example
|
66
|
-
# entities = model.active_entities
|
67
|
-
# entity = entities[0]
|
68
|
-
# status = selection.add entity
|
69
|
-
#
|
70
|
-
# @overload add(entities)
|
71
|
-
#
|
72
|
-
# @param [Array<Sketchup::Entity>] entities
|
73
|
-
#
|
74
|
-
# @overload add(*entities)
|
75
|
-
#
|
76
|
-
# @param [Array<Sketchup::Entity>] entities
|
77
|
-
#
|
78
|
-
# @return [Integer] the number of Entity objects added
|
79
|
-
#
|
80
|
-
# @version SketchUp 6.0
|
81
|
-
def add(*args)
|
82
|
-
end
|
83
|
-
|
84
|
-
# The add_observer method is used to add an observer to the selection object.
|
85
|
-
#
|
86
|
-
# @example
|
87
|
-
# selection = Sketchup.active_model.selection
|
88
|
-
# status = selection.add_observer observer
|
89
|
-
#
|
90
|
-
# @param [Object] observer
|
91
|
-
# An observer.
|
92
|
-
#
|
93
|
-
# @return [Boolean] true if successful, false if unsuccessful.
|
94
|
-
#
|
95
|
-
# @version SketchUp 6.0
|
96
|
-
def add_observer(observer)
|
97
|
-
end
|
98
|
-
|
99
|
-
# The {#at} method is an alias for {#[]}.
|
100
|
-
#
|
101
|
-
# @example
|
102
|
-
# model = Sketchup.active_model
|
103
|
-
# entities = model.active_entities
|
104
|
-
# selection = model.selection
|
105
|
-
# selection.add(entities.to_a)
|
106
|
-
# p selection.at(0)
|
107
|
-
#
|
108
|
-
# @param [Integer] index
|
109
|
-
# The index of the Entity object to retrieve.
|
110
|
-
#
|
111
|
-
# @return [Sketchup::Entitiy, nil]
|
112
|
-
#
|
113
|
-
# @see #[]
|
114
|
-
#
|
115
|
-
# @version SketchUp 6.0
|
116
|
-
def at(index)
|
117
|
-
end
|
118
|
-
|
119
|
-
# The clear method is used to clear the selection.
|
120
|
-
#
|
121
|
-
# @example
|
122
|
-
# entity = entities[0]
|
123
|
-
# selection.add entity
|
124
|
-
# UI.messagebox "Ready to Clear"
|
125
|
-
# selection.clear
|
126
|
-
#
|
127
|
-
# @return [nil]
|
128
|
-
#
|
129
|
-
# @version SketchUp 6.0
|
130
|
-
def clear
|
131
|
-
end
|
132
|
-
|
133
|
-
# The {contains?} method is and alias of {#include?}.
|
134
|
-
#
|
135
|
-
# @example
|
136
|
-
# model = Sketchup.active_model
|
137
|
-
# entity = model.active_entities.first
|
138
|
-
# selection = model.selection
|
139
|
-
# selection.add(entity)
|
140
|
-
# p selection.contains?(entity)
|
141
|
-
#
|
142
|
-
# @param [Sketchup::Entity] entity
|
143
|
-
#
|
144
|
-
# @return [Boolean]
|
145
|
-
#
|
146
|
-
# @see #include?
|
147
|
-
#
|
148
|
-
# @version SketchUp 6.0
|
149
|
-
def contains?(entity)
|
150
|
-
end
|
151
|
-
|
152
|
-
#
|
153
|
-
# @example
|
154
|
-
# selection = Sketchup.active_model.selection
|
155
|
-
# number = selection.count
|
156
|
-
#
|
157
|
-
# @note Since SketchUp 2014 the count method is inherited from Ruby's
|
158
|
-
# +Enumable+ mix-in module. Prior to that the {#count} method is an alias
|
159
|
-
# for {#length}.
|
160
|
-
#
|
161
|
-
# @return [Integer]
|
162
|
-
#
|
163
|
-
# @see #length
|
164
|
-
#
|
165
|
-
# @version SketchUp 6.0
|
166
|
-
def count
|
167
|
-
end
|
168
|
-
|
169
|
-
# The each method is used to iterate through all of the selected entities.
|
170
|
-
#
|
171
|
-
# If you want to do something with all of the selected Entities, this is more
|
172
|
-
# efficient than using [].
|
173
|
-
#
|
174
|
-
# @example
|
175
|
-
# selection.each { |entity| UI.messagebox(entity) }
|
176
|
-
#
|
177
|
-
# @return [nil]
|
178
|
-
#
|
179
|
-
# @version SketchUp 6.0
|
180
|
-
#
|
181
|
-
# @yield [Sketchup::Entity] A variable that will hold each Entity object as they
|
182
|
-
# are found.
|
183
|
-
def each
|
184
|
-
end
|
185
|
-
|
186
|
-
# The empty? method is used to determine if there are entities in the
|
187
|
-
# selection.
|
188
|
-
#
|
189
|
-
# @example
|
190
|
-
# status = selection.add entity
|
191
|
-
# status = selection.empty
|
192
|
-
#
|
193
|
-
# @return [Boolean]
|
194
|
-
#
|
195
|
-
# @version SketchUp 6.0
|
196
|
-
def empty?
|
197
|
-
end
|
198
|
-
|
199
|
-
# The first method is used to retrieve the first selected entity
|
200
|
-
#
|
201
|
-
# Returns nil if nothing is selected. This method is useful when you know that
|
202
|
-
# only a single entity is selected, or you are only interested in the first
|
203
|
-
# selected entity.
|
204
|
-
#
|
205
|
-
# @example
|
206
|
-
# status = selection.add entity
|
207
|
-
# entity = selection.first
|
208
|
-
#
|
209
|
-
# @return [Sketchup::Entity] the first selected Entity object if successful
|
210
|
-
#
|
211
|
-
# @version SketchUp 6.0
|
212
|
-
def first
|
213
|
-
end
|
214
|
-
|
215
|
-
# The {include?} method is used to determine if a given {Sketchup::Entity} is
|
216
|
-
# in the selection.
|
217
|
-
#
|
218
|
-
# @example
|
219
|
-
# model = Sketchup.active_model
|
220
|
-
# entity = model.active_entities.first
|
221
|
-
# selection = model.selection
|
222
|
-
# selection.add(entity)
|
223
|
-
# p selection.include?(entity)
|
224
|
-
#
|
225
|
-
# @param [Sketchup::Entity] entity
|
226
|
-
#
|
227
|
-
# @return [Boolean]
|
228
|
-
#
|
229
|
-
# @see #contains?
|
230
|
-
#
|
231
|
-
# @version SketchUp 6.0
|
232
|
-
def include?(entity)
|
233
|
-
end
|
234
|
-
|
235
|
-
# The #{invert} method is used to invert the selection.
|
236
|
-
#
|
237
|
-
# @example
|
238
|
-
# model = Sketchup.active_model
|
239
|
-
# entities = model.active_entities
|
240
|
-
# selection = model.selection
|
241
|
-
# # Create a cube
|
242
|
-
# face = entities.add_face([0, 0, 0], [9, 0, 0], [9, 9, 0], [0, 9, 0])
|
243
|
-
# face.pushpull(-9)
|
244
|
-
# # Add the first two faces to the selection
|
245
|
-
# faces = entities.grep(Sketchup::Face).take(2)
|
246
|
-
# selection.add(faces)
|
247
|
-
# # Invert selection
|
248
|
-
# selection.invert
|
249
|
-
#
|
250
|
-
# @return [nil]
|
251
|
-
#
|
252
|
-
# @version SketchUp 2019.2
|
253
|
-
def invert
|
254
|
-
end
|
255
|
-
|
256
|
-
# The is_curve? method is used to determine if the selection contains all
|
257
|
-
# edges that belong to a single curve.
|
258
|
-
#
|
259
|
-
# @example
|
260
|
-
# selection.add entity
|
261
|
-
# status = selection.is_curve?
|
262
|
-
#
|
263
|
-
# @return [Boolean]
|
264
|
-
#
|
265
|
-
# @version SketchUp 6.0
|
266
|
-
def is_curve?
|
267
|
-
end
|
268
|
-
|
269
|
-
# The is_surface? method is used to determine if the selection contains only
|
270
|
-
# all of the faces that are part of a single curved surface.
|
271
|
-
#
|
272
|
-
# @example
|
273
|
-
# selection.add entity
|
274
|
-
# status = selection.is_surface
|
275
|
-
#
|
276
|
-
# @return [Boolean]
|
277
|
-
#
|
278
|
-
# @version SketchUp 6.0
|
279
|
-
def is_surface?
|
280
|
-
end
|
281
|
-
|
282
|
-
# The {#length} method is used to retrieve the number of selected entities.
|
283
|
-
#
|
284
|
-
# @example
|
285
|
-
# selection = Sketchup.active_model.selection
|
286
|
-
# number = selection.length
|
287
|
-
#
|
288
|
-
# @return [Integer]
|
289
|
-
#
|
290
|
-
# @see #size
|
291
|
-
#
|
292
|
-
# @see #nitems
|
293
|
-
#
|
294
|
-
# @version SketchUp 6.0
|
295
|
-
def length
|
296
|
-
end
|
297
|
-
|
298
|
-
# The model method retrieves the model for the selection.
|
299
|
-
#
|
300
|
-
# @example
|
301
|
-
# model = selection.model
|
302
|
-
#
|
303
|
-
# @return [Sketchup::Model] the model that includes the selection if
|
304
|
-
# successful
|
305
|
-
#
|
306
|
-
# @version SketchUp 6.0
|
307
|
-
def model
|
308
|
-
end
|
309
|
-
|
310
|
-
# The {#nitems} method is an alias for {#length}.
|
311
|
-
#
|
312
|
-
# @example
|
313
|
-
# selection = Sketchup.active_model.selection
|
314
|
-
# number = selection.nitems
|
315
|
-
#
|
316
|
-
# @return [Integer]
|
317
|
-
#
|
318
|
-
# @see #length
|
319
|
-
#
|
320
|
-
# @version SketchUp 6.0
|
321
|
-
def nitems
|
322
|
-
end
|
323
|
-
|
324
|
-
# The remove method is used to remove entities from the selection.
|
325
|
-
#
|
326
|
-
# You can pass it individual Entities or an Array of Entities:
|
327
|
-
# Note that the add, remove, and toggle methods are all aliases for one
|
328
|
-
# another. So if you call remove on an entity that is not selected, it will
|
329
|
-
# be toggled to be selected, not removed! Be cautious when writing your code to
|
330
|
-
# not make the assumption about the currently selected state of a given entity.
|
331
|
-
#
|
332
|
-
# @example
|
333
|
-
# # Remove by listing the entities...
|
334
|
-
# ss.remove(e1, e2, e3)
|
335
|
-
#
|
336
|
-
# # ...or remove by passing an Array of entities.
|
337
|
-
# ss.remove([e1, e2, e3])
|
338
|
-
#
|
339
|
-
# @example
|
340
|
-
# entities = model.active_entities
|
341
|
-
# entity = entities[0]
|
342
|
-
# status = selection.add entity
|
343
|
-
#
|
344
|
-
# @overload remove(entities)
|
345
|
-
#
|
346
|
-
# @param [Array<Sketchup::Entity>] entities
|
347
|
-
#
|
348
|
-
# @overload remove(*entities)
|
349
|
-
#
|
350
|
-
# @param [Array<Sketchup::Entity>] entities
|
351
|
-
#
|
352
|
-
# @return [Integer] the number of Entity objects removed
|
353
|
-
#
|
354
|
-
# @version SketchUp 6.0
|
355
|
-
def remove(*args)
|
356
|
-
end
|
357
|
-
|
358
|
-
# The remove_observer method is used to remove an observer from the selection
|
359
|
-
# object.
|
360
|
-
#
|
361
|
-
# @example
|
362
|
-
# selection = Sketchup.active_model.selection
|
363
|
-
# status = object.remove_observer observer
|
364
|
-
#
|
365
|
-
# @param [Object] observer
|
366
|
-
# An observer.
|
367
|
-
#
|
368
|
-
# @return [Boolean] true if successful, false if unsuccessful.
|
369
|
-
#
|
370
|
-
# @version SketchUp 6.0
|
371
|
-
def remove_observer(observer)
|
372
|
-
end
|
373
|
-
|
374
|
-
# The shift method is used to remove the first entity from the selection and
|
375
|
-
# returns it.
|
376
|
-
#
|
377
|
-
# @example
|
378
|
-
# status = selection.add entity
|
379
|
-
# UI.messagebox "Ready to remove item from selection set"
|
380
|
-
# entity = selection.shift
|
381
|
-
#
|
382
|
-
# @return [Sketchup::Entity] the first Entity object in the selection set
|
383
|
-
# if successful
|
384
|
-
#
|
385
|
-
# @version SketchUp 6.0
|
386
|
-
def shift
|
387
|
-
end
|
388
|
-
|
389
|
-
# The single_object? method is used to determine if the selection contains a
|
390
|
-
# single object.
|
391
|
-
#
|
392
|
-
# It can either be a single Entity or a group of Entities for which is_curve?
|
393
|
-
# or is_surface? will return true.
|
394
|
-
#
|
395
|
-
# @example
|
396
|
-
# status = selection.single_object
|
397
|
-
#
|
398
|
-
# @return [Boolean]
|
399
|
-
#
|
400
|
-
# @version SketchUp 6.0
|
401
|
-
def single_object?
|
402
|
-
end
|
403
|
-
|
404
|
-
# The {#size} method is an alias for {#length}.
|
405
|
-
#
|
406
|
-
# @example
|
407
|
-
# selection = Sketchup.active_model.selection
|
408
|
-
# number = selection.size
|
409
|
-
#
|
410
|
-
# @return [Integer]
|
411
|
-
#
|
412
|
-
# @see #length
|
413
|
-
#
|
414
|
-
# @version SketchUp 2014
|
415
|
-
def size
|
416
|
-
end
|
417
|
-
|
418
|
-
# The toggle method is used to change whether an entity is part of the
|
419
|
-
# selection. Entities that are not already selected
|
420
|
-
# are added. Entities that are already selected are removed.
|
421
|
-
#
|
422
|
-
# You can pass it individual Entities or an Array of Entities:
|
423
|
-
# Note that the add, remove, and toggle methods are all aliases for one
|
424
|
-
# another. So if you call remove on an entity that is not selected, it will
|
425
|
-
# be toggled to be selected, not removed! Be cautious when writing your code to
|
426
|
-
# not make the assumption about the currently selected state of a given entity.
|
427
|
-
#
|
428
|
-
# @example
|
429
|
-
# # Toggle by listing the entities...
|
430
|
-
# ss.toggle(e1, e2, e3)
|
431
|
-
#
|
432
|
-
# # ...or toggle by passing an Array of entities.
|
433
|
-
# ss.toggle([e1, e2, e3])
|
434
|
-
#
|
435
|
-
# @example
|
436
|
-
# entities = model.active_entities
|
437
|
-
# entity = entities[0]
|
438
|
-
# status = selection.add entity
|
439
|
-
#
|
440
|
-
# @overload toggle(entities)
|
441
|
-
#
|
442
|
-
# @param [Array<Sketchup::Entity>] entities
|
443
|
-
#
|
444
|
-
# @overload toggle(*entities)
|
445
|
-
#
|
446
|
-
# @param [Array<Sketchup::Entity>] entities
|
447
|
-
#
|
448
|
-
# @return [Integer] the number of Entity objects changed
|
449
|
-
#
|
450
|
-
# @version SketchUp 6.0
|
451
|
-
def toggle(*args)
|
452
|
-
end
|
453
|
-
|
454
|
-
end
|
1
|
+
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# A set of the currently selected entities. Use the Model.selection method
|
5
|
+
# to get a Selection object. Note that the order of entities
|
6
|
+
# (<code>selection[0]</code>, <code>selection[1]</code> and so on) in the set
|
7
|
+
# is in no particular order and should not be assumed to be in the same order
|
8
|
+
# as the user selected the entities.
|
9
|
+
#
|
10
|
+
# @example
|
11
|
+
# # Get a handle to the selection set.
|
12
|
+
# model = Sketchup.active_model
|
13
|
+
# selection = model.selection
|
14
|
+
#
|
15
|
+
# @version SketchUp 6.0
|
16
|
+
class Sketchup::Selection
|
17
|
+
|
18
|
+
# Includes
|
19
|
+
|
20
|
+
include Enumerable
|
21
|
+
|
22
|
+
# Instance Methods
|
23
|
+
|
24
|
+
# The {#[]} method is used to retrieve an {Sketchup::Entity} from the selection
|
25
|
+
# by index. Index 0 is the first entity in the selection.
|
26
|
+
#
|
27
|
+
# This method is not very efficient. If you need to look at every entity in
|
28
|
+
# the selection, consider using {#each} instead of using this method
|
29
|
+
# to manually grab each one.
|
30
|
+
#
|
31
|
+
# @example
|
32
|
+
# model = Sketchup.active_model
|
33
|
+
# entities = model.active_entities
|
34
|
+
# selection = model.selection
|
35
|
+
# selection.add(entities.to_a)
|
36
|
+
# p selection[0]
|
37
|
+
#
|
38
|
+
# @param [Integer] index
|
39
|
+
# The index of the Entity object to retrieve.
|
40
|
+
#
|
41
|
+
# @return [Sketchup::Entitiy, nil]
|
42
|
+
#
|
43
|
+
# @see #at
|
44
|
+
#
|
45
|
+
# @version SketchUp 6.0
|
46
|
+
def [](index)
|
47
|
+
end
|
48
|
+
|
49
|
+
# The add method is used to add entities to the selection. Entities that are
|
50
|
+
# added to the Selection are visually indicated by the selection bounding box.
|
51
|
+
#
|
52
|
+
# You can pass it individual Entities or an Array of Entities:
|
53
|
+
# Note that the add, remove, and toggle methods are all aliases for one
|
54
|
+
# another. So if you call remove on an entity that is not selected, it will
|
55
|
+
# be toggled to be selected, not removed! Be cautious when writing your code to
|
56
|
+
# not make the assumption about the currently selected state of a given entity.
|
57
|
+
#
|
58
|
+
# @example
|
59
|
+
# # Add by listing the entities...
|
60
|
+
# ss.add(e1, e2, e3)
|
61
|
+
#
|
62
|
+
# # ...or add by passing an Array of entities.
|
63
|
+
# ss.add([e1, e2, e3])
|
64
|
+
#
|
65
|
+
# @example
|
66
|
+
# entities = model.active_entities
|
67
|
+
# entity = entities[0]
|
68
|
+
# status = selection.add entity
|
69
|
+
#
|
70
|
+
# @overload add(entities)
|
71
|
+
#
|
72
|
+
# @param [Array<Sketchup::Entity>] entities
|
73
|
+
#
|
74
|
+
# @overload add(*entities)
|
75
|
+
#
|
76
|
+
# @param [Array<Sketchup::Entity>] entities
|
77
|
+
#
|
78
|
+
# @return [Integer] the number of Entity objects added
|
79
|
+
#
|
80
|
+
# @version SketchUp 6.0
|
81
|
+
def add(*args)
|
82
|
+
end
|
83
|
+
|
84
|
+
# The add_observer method is used to add an observer to the selection object.
|
85
|
+
#
|
86
|
+
# @example
|
87
|
+
# selection = Sketchup.active_model.selection
|
88
|
+
# status = selection.add_observer observer
|
89
|
+
#
|
90
|
+
# @param [Object] observer
|
91
|
+
# An observer.
|
92
|
+
#
|
93
|
+
# @return [Boolean] true if successful, false if unsuccessful.
|
94
|
+
#
|
95
|
+
# @version SketchUp 6.0
|
96
|
+
def add_observer(observer)
|
97
|
+
end
|
98
|
+
|
99
|
+
# The {#at} method is an alias for {#[]}.
|
100
|
+
#
|
101
|
+
# @example
|
102
|
+
# model = Sketchup.active_model
|
103
|
+
# entities = model.active_entities
|
104
|
+
# selection = model.selection
|
105
|
+
# selection.add(entities.to_a)
|
106
|
+
# p selection.at(0)
|
107
|
+
#
|
108
|
+
# @param [Integer] index
|
109
|
+
# The index of the Entity object to retrieve.
|
110
|
+
#
|
111
|
+
# @return [Sketchup::Entitiy, nil]
|
112
|
+
#
|
113
|
+
# @see #[]
|
114
|
+
#
|
115
|
+
# @version SketchUp 6.0
|
116
|
+
def at(index)
|
117
|
+
end
|
118
|
+
|
119
|
+
# The clear method is used to clear the selection.
|
120
|
+
#
|
121
|
+
# @example
|
122
|
+
# entity = entities[0]
|
123
|
+
# selection.add entity
|
124
|
+
# UI.messagebox "Ready to Clear"
|
125
|
+
# selection.clear
|
126
|
+
#
|
127
|
+
# @return [nil]
|
128
|
+
#
|
129
|
+
# @version SketchUp 6.0
|
130
|
+
def clear
|
131
|
+
end
|
132
|
+
|
133
|
+
# The {contains?} method is and alias of {#include?}.
|
134
|
+
#
|
135
|
+
# @example
|
136
|
+
# model = Sketchup.active_model
|
137
|
+
# entity = model.active_entities.first
|
138
|
+
# selection = model.selection
|
139
|
+
# selection.add(entity)
|
140
|
+
# p selection.contains?(entity)
|
141
|
+
#
|
142
|
+
# @param [Sketchup::Entity] entity
|
143
|
+
#
|
144
|
+
# @return [Boolean]
|
145
|
+
#
|
146
|
+
# @see #include?
|
147
|
+
#
|
148
|
+
# @version SketchUp 6.0
|
149
|
+
def contains?(entity)
|
150
|
+
end
|
151
|
+
|
152
|
+
#
|
153
|
+
# @example
|
154
|
+
# selection = Sketchup.active_model.selection
|
155
|
+
# number = selection.count
|
156
|
+
#
|
157
|
+
# @note Since SketchUp 2014 the count method is inherited from Ruby's
|
158
|
+
# +Enumable+ mix-in module. Prior to that the {#count} method is an alias
|
159
|
+
# for {#length}.
|
160
|
+
#
|
161
|
+
# @return [Integer]
|
162
|
+
#
|
163
|
+
# @see #length
|
164
|
+
#
|
165
|
+
# @version SketchUp 6.0
|
166
|
+
def count
|
167
|
+
end
|
168
|
+
|
169
|
+
# The each method is used to iterate through all of the selected entities.
|
170
|
+
#
|
171
|
+
# If you want to do something with all of the selected Entities, this is more
|
172
|
+
# efficient than using [].
|
173
|
+
#
|
174
|
+
# @example
|
175
|
+
# selection.each { |entity| UI.messagebox(entity) }
|
176
|
+
#
|
177
|
+
# @return [nil]
|
178
|
+
#
|
179
|
+
# @version SketchUp 6.0
|
180
|
+
#
|
181
|
+
# @yield [Sketchup::Entity] A variable that will hold each Entity object as they
|
182
|
+
# are found.
|
183
|
+
def each
|
184
|
+
end
|
185
|
+
|
186
|
+
# The empty? method is used to determine if there are entities in the
|
187
|
+
# selection.
|
188
|
+
#
|
189
|
+
# @example
|
190
|
+
# status = selection.add entity
|
191
|
+
# status = selection.empty
|
192
|
+
#
|
193
|
+
# @return [Boolean]
|
194
|
+
#
|
195
|
+
# @version SketchUp 6.0
|
196
|
+
def empty?
|
197
|
+
end
|
198
|
+
|
199
|
+
# The first method is used to retrieve the first selected entity
|
200
|
+
#
|
201
|
+
# Returns nil if nothing is selected. This method is useful when you know that
|
202
|
+
# only a single entity is selected, or you are only interested in the first
|
203
|
+
# selected entity.
|
204
|
+
#
|
205
|
+
# @example
|
206
|
+
# status = selection.add entity
|
207
|
+
# entity = selection.first
|
208
|
+
#
|
209
|
+
# @return [Sketchup::Entity] the first selected Entity object if successful
|
210
|
+
#
|
211
|
+
# @version SketchUp 6.0
|
212
|
+
def first
|
213
|
+
end
|
214
|
+
|
215
|
+
# The {include?} method is used to determine if a given {Sketchup::Entity} is
|
216
|
+
# in the selection.
|
217
|
+
#
|
218
|
+
# @example
|
219
|
+
# model = Sketchup.active_model
|
220
|
+
# entity = model.active_entities.first
|
221
|
+
# selection = model.selection
|
222
|
+
# selection.add(entity)
|
223
|
+
# p selection.include?(entity)
|
224
|
+
#
|
225
|
+
# @param [Sketchup::Entity] entity
|
226
|
+
#
|
227
|
+
# @return [Boolean]
|
228
|
+
#
|
229
|
+
# @see #contains?
|
230
|
+
#
|
231
|
+
# @version SketchUp 6.0
|
232
|
+
def include?(entity)
|
233
|
+
end
|
234
|
+
|
235
|
+
# The #{invert} method is used to invert the selection.
|
236
|
+
#
|
237
|
+
# @example
|
238
|
+
# model = Sketchup.active_model
|
239
|
+
# entities = model.active_entities
|
240
|
+
# selection = model.selection
|
241
|
+
# # Create a cube
|
242
|
+
# face = entities.add_face([0, 0, 0], [9, 0, 0], [9, 9, 0], [0, 9, 0])
|
243
|
+
# face.pushpull(-9)
|
244
|
+
# # Add the first two faces to the selection
|
245
|
+
# faces = entities.grep(Sketchup::Face).take(2)
|
246
|
+
# selection.add(faces)
|
247
|
+
# # Invert selection
|
248
|
+
# selection.invert
|
249
|
+
#
|
250
|
+
# @return [nil]
|
251
|
+
#
|
252
|
+
# @version SketchUp 2019.2
|
253
|
+
def invert
|
254
|
+
end
|
255
|
+
|
256
|
+
# The is_curve? method is used to determine if the selection contains all
|
257
|
+
# edges that belong to a single curve.
|
258
|
+
#
|
259
|
+
# @example
|
260
|
+
# selection.add entity
|
261
|
+
# status = selection.is_curve?
|
262
|
+
#
|
263
|
+
# @return [Boolean]
|
264
|
+
#
|
265
|
+
# @version SketchUp 6.0
|
266
|
+
def is_curve?
|
267
|
+
end
|
268
|
+
|
269
|
+
# The is_surface? method is used to determine if the selection contains only
|
270
|
+
# all of the faces that are part of a single curved surface.
|
271
|
+
#
|
272
|
+
# @example
|
273
|
+
# selection.add entity
|
274
|
+
# status = selection.is_surface
|
275
|
+
#
|
276
|
+
# @return [Boolean]
|
277
|
+
#
|
278
|
+
# @version SketchUp 6.0
|
279
|
+
def is_surface?
|
280
|
+
end
|
281
|
+
|
282
|
+
# The {#length} method is used to retrieve the number of selected entities.
|
283
|
+
#
|
284
|
+
# @example
|
285
|
+
# selection = Sketchup.active_model.selection
|
286
|
+
# number = selection.length
|
287
|
+
#
|
288
|
+
# @return [Integer]
|
289
|
+
#
|
290
|
+
# @see #size
|
291
|
+
#
|
292
|
+
# @see #nitems
|
293
|
+
#
|
294
|
+
# @version SketchUp 6.0
|
295
|
+
def length
|
296
|
+
end
|
297
|
+
|
298
|
+
# The model method retrieves the model for the selection.
|
299
|
+
#
|
300
|
+
# @example
|
301
|
+
# model = selection.model
|
302
|
+
#
|
303
|
+
# @return [Sketchup::Model] the model that includes the selection if
|
304
|
+
# successful
|
305
|
+
#
|
306
|
+
# @version SketchUp 6.0
|
307
|
+
def model
|
308
|
+
end
|
309
|
+
|
310
|
+
# The {#nitems} method is an alias for {#length}.
|
311
|
+
#
|
312
|
+
# @example
|
313
|
+
# selection = Sketchup.active_model.selection
|
314
|
+
# number = selection.nitems
|
315
|
+
#
|
316
|
+
# @return [Integer]
|
317
|
+
#
|
318
|
+
# @see #length
|
319
|
+
#
|
320
|
+
# @version SketchUp 6.0
|
321
|
+
def nitems
|
322
|
+
end
|
323
|
+
|
324
|
+
# The remove method is used to remove entities from the selection.
|
325
|
+
#
|
326
|
+
# You can pass it individual Entities or an Array of Entities:
|
327
|
+
# Note that the add, remove, and toggle methods are all aliases for one
|
328
|
+
# another. So if you call remove on an entity that is not selected, it will
|
329
|
+
# be toggled to be selected, not removed! Be cautious when writing your code to
|
330
|
+
# not make the assumption about the currently selected state of a given entity.
|
331
|
+
#
|
332
|
+
# @example
|
333
|
+
# # Remove by listing the entities...
|
334
|
+
# ss.remove(e1, e2, e3)
|
335
|
+
#
|
336
|
+
# # ...or remove by passing an Array of entities.
|
337
|
+
# ss.remove([e1, e2, e3])
|
338
|
+
#
|
339
|
+
# @example
|
340
|
+
# entities = model.active_entities
|
341
|
+
# entity = entities[0]
|
342
|
+
# status = selection.add entity
|
343
|
+
#
|
344
|
+
# @overload remove(entities)
|
345
|
+
#
|
346
|
+
# @param [Array<Sketchup::Entity>] entities
|
347
|
+
#
|
348
|
+
# @overload remove(*entities)
|
349
|
+
#
|
350
|
+
# @param [Array<Sketchup::Entity>] entities
|
351
|
+
#
|
352
|
+
# @return [Integer] the number of Entity objects removed
|
353
|
+
#
|
354
|
+
# @version SketchUp 6.0
|
355
|
+
def remove(*args)
|
356
|
+
end
|
357
|
+
|
358
|
+
# The remove_observer method is used to remove an observer from the selection
|
359
|
+
# object.
|
360
|
+
#
|
361
|
+
# @example
|
362
|
+
# selection = Sketchup.active_model.selection
|
363
|
+
# status = object.remove_observer observer
|
364
|
+
#
|
365
|
+
# @param [Object] observer
|
366
|
+
# An observer.
|
367
|
+
#
|
368
|
+
# @return [Boolean] true if successful, false if unsuccessful.
|
369
|
+
#
|
370
|
+
# @version SketchUp 6.0
|
371
|
+
def remove_observer(observer)
|
372
|
+
end
|
373
|
+
|
374
|
+
# The shift method is used to remove the first entity from the selection and
|
375
|
+
# returns it.
|
376
|
+
#
|
377
|
+
# @example
|
378
|
+
# status = selection.add entity
|
379
|
+
# UI.messagebox "Ready to remove item from selection set"
|
380
|
+
# entity = selection.shift
|
381
|
+
#
|
382
|
+
# @return [Sketchup::Entity] the first Entity object in the selection set
|
383
|
+
# if successful
|
384
|
+
#
|
385
|
+
# @version SketchUp 6.0
|
386
|
+
def shift
|
387
|
+
end
|
388
|
+
|
389
|
+
# The single_object? method is used to determine if the selection contains a
|
390
|
+
# single object.
|
391
|
+
#
|
392
|
+
# It can either be a single Entity or a group of Entities for which is_curve?
|
393
|
+
# or is_surface? will return true.
|
394
|
+
#
|
395
|
+
# @example
|
396
|
+
# status = selection.single_object
|
397
|
+
#
|
398
|
+
# @return [Boolean]
|
399
|
+
#
|
400
|
+
# @version SketchUp 6.0
|
401
|
+
def single_object?
|
402
|
+
end
|
403
|
+
|
404
|
+
# The {#size} method is an alias for {#length}.
|
405
|
+
#
|
406
|
+
# @example
|
407
|
+
# selection = Sketchup.active_model.selection
|
408
|
+
# number = selection.size
|
409
|
+
#
|
410
|
+
# @return [Integer]
|
411
|
+
#
|
412
|
+
# @see #length
|
413
|
+
#
|
414
|
+
# @version SketchUp 2014
|
415
|
+
def size
|
416
|
+
end
|
417
|
+
|
418
|
+
# The toggle method is used to change whether an entity is part of the
|
419
|
+
# selection. Entities that are not already selected
|
420
|
+
# are added. Entities that are already selected are removed.
|
421
|
+
#
|
422
|
+
# You can pass it individual Entities or an Array of Entities:
|
423
|
+
# Note that the add, remove, and toggle methods are all aliases for one
|
424
|
+
# another. So if you call remove on an entity that is not selected, it will
|
425
|
+
# be toggled to be selected, not removed! Be cautious when writing your code to
|
426
|
+
# not make the assumption about the currently selected state of a given entity.
|
427
|
+
#
|
428
|
+
# @example
|
429
|
+
# # Toggle by listing the entities...
|
430
|
+
# ss.toggle(e1, e2, e3)
|
431
|
+
#
|
432
|
+
# # ...or toggle by passing an Array of entities.
|
433
|
+
# ss.toggle([e1, e2, e3])
|
434
|
+
#
|
435
|
+
# @example
|
436
|
+
# entities = model.active_entities
|
437
|
+
# entity = entities[0]
|
438
|
+
# status = selection.add entity
|
439
|
+
#
|
440
|
+
# @overload toggle(entities)
|
441
|
+
#
|
442
|
+
# @param [Array<Sketchup::Entity>] entities
|
443
|
+
#
|
444
|
+
# @overload toggle(*entities)
|
445
|
+
#
|
446
|
+
# @param [Array<Sketchup::Entity>] entities
|
447
|
+
#
|
448
|
+
# @return [Integer] the number of Entity objects changed
|
449
|
+
#
|
450
|
+
# @version SketchUp 6.0
|
451
|
+
def toggle(*args)
|
452
|
+
end
|
453
|
+
|
454
|
+
end
|