sketchup-api-stubs 0.7.8 → 0.7.9
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/sketchup-api-stubs/sketchup.rb +151 -148
- data/lib/sketchup-api-stubs/stubs/Array.rb +741 -741
- data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +322 -322
- 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 +509 -523
- data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +476 -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 +693 -693
- data/lib/sketchup-api-stubs/stubs/Geom.rb +351 -351
- data/lib/sketchup-api-stubs/stubs/LanguageHandler.rb +93 -93
- data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +595 -595
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +747 -698
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +183 -183
- data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
- data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +517 -516
- data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
- data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +148 -148
- data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +354 -354
- 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 +370 -370
- 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 +225 -225
- 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 +209 -209
- 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/ReferenceEntity.rb +82 -0
- data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +692 -692
- 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/Layout.rb +25 -25
- 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/Animation.rb +144 -144
- data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +169 -169
- data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +209 -209
- data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +150 -152
- data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +281 -286
- data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
- data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +302 -302
- data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +478 -478
- data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
- data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +121 -122
- data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +294 -294
- data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +659 -619
- 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 +201 -201
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +449 -426
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +74 -74
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +104 -104
- data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +306 -306
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +42 -42
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
- data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +406 -396
- data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +397 -502
- data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1239 -1205
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesBuilder.rb +261 -272
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +127 -127
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +545 -545
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +60 -60
- data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +125 -126
- data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +937 -937
- data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +102 -104
- data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +750 -750
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +282 -292
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
- data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +468 -468
- data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +266 -266
- data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +189 -189
- data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +406 -407
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +84 -84
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +306 -306
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +326 -326
- data/lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb +422 -422
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +427 -427
- data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +249 -249
- data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
- data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +48 -48
- data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
- data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +114 -112
- data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
- data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +414 -414
- data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +317 -318
- data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +142 -142
- data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +93 -93
- data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1652 -1651
- data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +357 -357
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +130 -131
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +271 -284
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
- data/lib/sketchup-api-stubs/stubs/Sketchup/Overlay.rb +490 -0
- data/lib/sketchup-api-stubs/stubs/Sketchup/OverlaysManager.rb +116 -0
- data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +797 -797
- data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +361 -363
- data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +77 -77
- data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +478 -477
- data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
- data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +361 -364
- data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +45 -45
- data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
- data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +458 -459
- 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 +255 -260
- data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +59 -59
- data/lib/sketchup-api-stubs/stubs/Sketchup/Skp.rb +40 -40
- data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
- data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +217 -217
- data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
- data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +217 -217
- data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +834 -837
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
- data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +156 -156
- data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +75 -75
- data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
- data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1311 -1317
- data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +45 -45
- data/lib/sketchup-api-stubs/stubs/Sketchup.rb +1377 -1360
- 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/Command.rb +389 -389
- data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +494 -496
- data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +269 -269
- data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +241 -240
- data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +635 -635
- data/lib/sketchup-api-stubs/stubs/UI.rb +683 -683
- data/lib/sketchup-api-stubs/stubs/_top_level.rb +303 -311
- data/lib/sketchup-api-stubs.rb +1 -1
- metadata +10 -7
@@ -1,29 +1,29 @@
|
|
1
|
-
# Copyright:: Copyright
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# A simple elliptical shape entity.
|
5
|
-
#
|
6
|
-
# @version LayOut 2018
|
7
|
-
class Layout::Ellipse < Layout::Entity
|
8
|
-
|
9
|
-
# Instance Methods
|
10
|
-
|
11
|
-
# The {#initialize} method creates a new {Layout::Ellipse}.
|
12
|
-
#
|
13
|
-
# @example
|
14
|
-
# upper_left = Geom::Point2d.new(1, 1)
|
15
|
-
# lower_right = Geom::Point2d.new(2, 2)
|
16
|
-
# bounds = Geom::Bounds2d.new(upper_left, lower_right)
|
17
|
-
# ellipse = Layout::Ellipse.new(bounds)
|
18
|
-
#
|
19
|
-
# @param [Geom::Bounds2d] bounds
|
20
|
-
#
|
21
|
-
# @raise ArgumentError if bounds is zero size
|
22
|
-
#
|
23
|
-
# @return [Layout::Ellipse]
|
24
|
-
#
|
25
|
-
# @version LayOut 2018
|
26
|
-
def initialize(bounds)
|
27
|
-
end
|
28
|
-
|
29
|
-
end
|
1
|
+
# Copyright:: Copyright 2023 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# A simple elliptical shape entity.
|
5
|
+
#
|
6
|
+
# @version LayOut 2018
|
7
|
+
class Layout::Ellipse < Layout::Entity
|
8
|
+
|
9
|
+
# Instance Methods
|
10
|
+
|
11
|
+
# The {#initialize} method creates a new {Layout::Ellipse}.
|
12
|
+
#
|
13
|
+
# @example
|
14
|
+
# upper_left = Geom::Point2d.new(1, 1)
|
15
|
+
# lower_right = Geom::Point2d.new(2, 2)
|
16
|
+
# bounds = Geom::Bounds2d.new(upper_left, lower_right)
|
17
|
+
# ellipse = Layout::Ellipse.new(bounds)
|
18
|
+
#
|
19
|
+
# @param [Geom::Bounds2d] bounds
|
20
|
+
#
|
21
|
+
# @raise ArgumentError if bounds is zero size
|
22
|
+
#
|
23
|
+
# @return [Layout::Ellipse]
|
24
|
+
#
|
25
|
+
# @version LayOut 2018
|
26
|
+
def initialize(bounds)
|
27
|
+
end
|
28
|
+
|
29
|
+
end
|
@@ -1,148 +1,148 @@
|
|
1
|
-
# Copyright:: Copyright
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# The Entities class is a container class for {Layout::Entity}s. A
|
5
|
-
# {Layout::Entities} object is different from a SketchUp::Entities object in
|
6
|
-
# that it is read-only. Adding or removing {Layout::Entity}s from a
|
7
|
-
# {Layout::Document} happens with the {Layout::Document#add_entity} and
|
8
|
-
# {Layout::Document#remove_entity} methods.
|
9
|
-
#
|
10
|
-
# The {Layout::Entities} from {Layout::AngularDimension#entities},
|
11
|
-
# {Layout::Label#entities}, {Layout::LinearDimension#entities}, or
|
12
|
-
# {Layout::Table#entities} contains the {Layout::Entity}s that represent the
|
13
|
-
# {Layout::Entity} in its exploded form.
|
14
|
-
#
|
15
|
-
# The {Layout::Entities} from {Layout::Group#entities} contains all the
|
16
|
-
# {Layout::Entity}s that belong to the {Layout::Group}.
|
17
|
-
#
|
18
|
-
# The {Layout::Entities} from {Layout::Page#entities} contains all of the
|
19
|
-
# {Layout::Entity}s on both shared and non-shared {Layout::Layer}s. This class
|
20
|
-
# is used to iterate through the {Layout::Entity}s in draw order or pick order
|
21
|
-
# (reverse draw order) using the {#each} and {#reverse_each} methods.
|
22
|
-
#
|
23
|
-
# The {Layout::Entities} from {Layout::Document#shared_entities} contains all
|
24
|
-
# of the {Layout::Entity}s that belong on all shared {Layout::Layer}s.
|
25
|
-
#
|
26
|
-
# The {Layout::Entities} from {Layout::Page#nonshared_entities} contains all of
|
27
|
-
# the {Layout::Entity}s that belong to that {Layout::Page}.
|
28
|
-
#
|
29
|
-
# The {Layout::Entities} from {Layout::LayerInstance#entities} contains all of
|
30
|
-
# the {Layout::Entity}s that belong on that {Layout::LayerInstance}.
|
31
|
-
#
|
32
|
-
# @example
|
33
|
-
# # Grab a handle to a pages entities
|
34
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
35
|
-
# entities = doc.pages.first.entities
|
36
|
-
#
|
37
|
-
# # From here, we can iterate over the entities in draw order or pick order
|
38
|
-
# entities.each { |entity|
|
39
|
-
# puts entity
|
40
|
-
# }
|
41
|
-
# entities.reverse_each(skip_locked: true) { |entity|
|
42
|
-
# puts entity
|
43
|
-
# }
|
44
|
-
#
|
45
|
-
# @version LayOut 2018
|
46
|
-
class Layout::Entities
|
47
|
-
|
48
|
-
# Includes
|
49
|
-
|
50
|
-
include Enumerable
|
51
|
-
|
52
|
-
# Instance Methods
|
53
|
-
|
54
|
-
# The {#[]} method returns the {Layout::Entity} at the given index. This method
|
55
|
-
# is not valid for use when the {Layout::Entities} object came from a
|
56
|
-
# {Layout::Page}.
|
57
|
-
#
|
58
|
-
# @example
|
59
|
-
# table = Layout::Table.new([1, 1, 4, 4], 4, 4)
|
60
|
-
# entities = table.entities
|
61
|
-
# entity = entities[10]
|
62
|
-
#
|
63
|
-
# @param [Integer] index
|
64
|
-
#
|
65
|
-
# @raise [ArgumentError] if this came from a {Layout::Page}
|
66
|
-
#
|
67
|
-
# @return [Layout::Entity]
|
68
|
-
#
|
69
|
-
# @version LayOut 2018
|
70
|
-
def [](index)
|
71
|
-
end
|
72
|
-
|
73
|
-
# The {#each} method iterates through all of the {Layout::Entity}s. When
|
74
|
-
# iterating over a {Layout::LayerInstance}'s {Layout::Entities}, it is not
|
75
|
-
# necessary to provide a flags Hash. When iterating over a {Layout::Page}'s
|
76
|
-
# {Layout::Entities}, the flags Hash is optional; providing no Hash will
|
77
|
-
# result in iterating over all {Layout::Entity}s, including those on hidden or
|
78
|
-
# locked {Layout::Layer}s. Valid symbols for the Hash are +:skip_hidden+ and
|
79
|
-
# +:skip_locked+.
|
80
|
-
#
|
81
|
-
# @example
|
82
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
83
|
-
# flags = { :skip_hidden => true }
|
84
|
-
# entities = doc.pages.first.entities
|
85
|
-
# entities.each(flags) { |entity|
|
86
|
-
# puts entity
|
87
|
-
# }
|
88
|
-
#
|
89
|
-
# @note Don't remove content from this collection while iterating over it with
|
90
|
-
# {#each}. This would change the size of the collection and cause elements to
|
91
|
-
# be skipped as the indices change. Instead copy the current collection to an
|
92
|
-
# array using +to_a+ and then use +each+ on the array, when removing content.
|
93
|
-
#
|
94
|
-
# @param [Hash{Symbol => Boolean}] flags
|
95
|
-
# A hash that allows skipping of
|
96
|
-
# {Layout::Entity}s on hidden or locked {Layout::Layers}
|
97
|
-
#
|
98
|
-
# @version LayOut 2018
|
99
|
-
#
|
100
|
-
# @yieldparam [Layout::Entity] entity
|
101
|
-
def each(flags = {})
|
102
|
-
end
|
103
|
-
|
104
|
-
# The {#length} method returns the number of {Layout::Entity}s.
|
105
|
-
#
|
106
|
-
# @example
|
107
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
108
|
-
# entities = doc.shared_entities
|
109
|
-
# num_entities = entities.length
|
110
|
-
#
|
111
|
-
# @return [Integer]
|
112
|
-
#
|
113
|
-
# @version LayOut 2018
|
114
|
-
def length
|
115
|
-
end
|
116
|
-
alias_method :size, :length
|
117
|
-
|
118
|
-
# The {#reverse_each} method iterates through all of the {Layout::Entity}s in
|
119
|
-
# reverse order. When iterating over a {Layout::LayerInstance}'s
|
120
|
-
# {Layout::Entities}, it is not necessary to provide a flags Hash. When
|
121
|
-
# iterating over a {Layout::Page}'s {Layout::Entities}, the flags Hash is
|
122
|
-
# optional; providing no Hash will result in iterating over all
|
123
|
-
# {Layout::Entity}s, including those on hidden or locked {Layout::Layer}s.
|
124
|
-
# Valid symbols for the Hash are +:skip_hidden+ and +:skip_locked+.
|
125
|
-
#
|
126
|
-
# @example
|
127
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
128
|
-
# flags = { :skip_hidden => true, :skip_locked => true }
|
129
|
-
# entities = doc.pages.first.entities
|
130
|
-
# entities.reverse_each(flags) { |entity|
|
131
|
-
# puts entity
|
132
|
-
# }
|
133
|
-
#
|
134
|
-
# @overload reverse_each
|
135
|
-
#
|
136
|
-
# @yieldparam [Layout::Entity] entity
|
137
|
-
#
|
138
|
-
# @overload reverse_each(flags)
|
139
|
-
#
|
140
|
-
# @param [Hash{Symbol => Boolean}] flags A hash that allows skipping of
|
141
|
-
# {Layout::Entity}s on hidden or locked {Layout::Layers}.
|
142
|
-
# @yieldparam [Layout::Entity] entity
|
143
|
-
#
|
144
|
-
# @version LayOut 2018
|
145
|
-
def reverse_each(*args)
|
146
|
-
end
|
147
|
-
|
148
|
-
end
|
1
|
+
# Copyright:: Copyright 2023 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# The Entities class is a container class for {Layout::Entity}s. A
|
5
|
+
# {Layout::Entities} object is different from a SketchUp::Entities object in
|
6
|
+
# that it is read-only. Adding or removing {Layout::Entity}s from a
|
7
|
+
# {Layout::Document} happens with the {Layout::Document#add_entity} and
|
8
|
+
# {Layout::Document#remove_entity} methods.
|
9
|
+
#
|
10
|
+
# The {Layout::Entities} from {Layout::AngularDimension#entities},
|
11
|
+
# {Layout::Label#entities}, {Layout::LinearDimension#entities}, or
|
12
|
+
# {Layout::Table#entities} contains the {Layout::Entity}s that represent the
|
13
|
+
# {Layout::Entity} in its exploded form.
|
14
|
+
#
|
15
|
+
# The {Layout::Entities} from {Layout::Group#entities} contains all the
|
16
|
+
# {Layout::Entity}s that belong to the {Layout::Group}.
|
17
|
+
#
|
18
|
+
# The {Layout::Entities} from {Layout::Page#entities} contains all of the
|
19
|
+
# {Layout::Entity}s on both shared and non-shared {Layout::Layer}s. This class
|
20
|
+
# is used to iterate through the {Layout::Entity}s in draw order or pick order
|
21
|
+
# (reverse draw order) using the {#each} and {#reverse_each} methods.
|
22
|
+
#
|
23
|
+
# The {Layout::Entities} from {Layout::Document#shared_entities} contains all
|
24
|
+
# of the {Layout::Entity}s that belong on all shared {Layout::Layer}s.
|
25
|
+
#
|
26
|
+
# The {Layout::Entities} from {Layout::Page#nonshared_entities} contains all of
|
27
|
+
# the {Layout::Entity}s that belong to that {Layout::Page}.
|
28
|
+
#
|
29
|
+
# The {Layout::Entities} from {Layout::LayerInstance#entities} contains all of
|
30
|
+
# the {Layout::Entity}s that belong on that {Layout::LayerInstance}.
|
31
|
+
#
|
32
|
+
# @example
|
33
|
+
# # Grab a handle to a pages entities
|
34
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
35
|
+
# entities = doc.pages.first.entities
|
36
|
+
#
|
37
|
+
# # From here, we can iterate over the entities in draw order or pick order
|
38
|
+
# entities.each { |entity|
|
39
|
+
# puts entity
|
40
|
+
# }
|
41
|
+
# entities.reverse_each(skip_locked: true) { |entity|
|
42
|
+
# puts entity
|
43
|
+
# }
|
44
|
+
#
|
45
|
+
# @version LayOut 2018
|
46
|
+
class Layout::Entities
|
47
|
+
|
48
|
+
# Includes
|
49
|
+
|
50
|
+
include Enumerable
|
51
|
+
|
52
|
+
# Instance Methods
|
53
|
+
|
54
|
+
# The {#[]} method returns the {Layout::Entity} at the given index. This method
|
55
|
+
# is not valid for use when the {Layout::Entities} object came from a
|
56
|
+
# {Layout::Page}.
|
57
|
+
#
|
58
|
+
# @example
|
59
|
+
# table = Layout::Table.new([1, 1, 4, 4], 4, 4)
|
60
|
+
# entities = table.entities
|
61
|
+
# entity = entities[10]
|
62
|
+
#
|
63
|
+
# @param [Integer] index
|
64
|
+
#
|
65
|
+
# @raise [ArgumentError] if this came from a {Layout::Page}
|
66
|
+
#
|
67
|
+
# @return [Layout::Entity]
|
68
|
+
#
|
69
|
+
# @version LayOut 2018
|
70
|
+
def [](index)
|
71
|
+
end
|
72
|
+
|
73
|
+
# The {#each} method iterates through all of the {Layout::Entity}s. When
|
74
|
+
# iterating over a {Layout::LayerInstance}'s {Layout::Entities}, it is not
|
75
|
+
# necessary to provide a flags Hash. When iterating over a {Layout::Page}'s
|
76
|
+
# {Layout::Entities}, the flags Hash is optional; providing no Hash will
|
77
|
+
# result in iterating over all {Layout::Entity}s, including those on hidden or
|
78
|
+
# locked {Layout::Layer}s. Valid symbols for the Hash are +:skip_hidden+ and
|
79
|
+
# +:skip_locked+.
|
80
|
+
#
|
81
|
+
# @example
|
82
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
83
|
+
# flags = { :skip_hidden => true }
|
84
|
+
# entities = doc.pages.first.entities
|
85
|
+
# entities.each(flags) { |entity|
|
86
|
+
# puts entity
|
87
|
+
# }
|
88
|
+
#
|
89
|
+
# @note Don't remove content from this collection while iterating over it with
|
90
|
+
# {#each}. This would change the size of the collection and cause elements to
|
91
|
+
# be skipped as the indices change. Instead copy the current collection to an
|
92
|
+
# array using +to_a+ and then use +each+ on the array, when removing content.
|
93
|
+
#
|
94
|
+
# @param [Hash{Symbol => Boolean}] flags
|
95
|
+
# A hash that allows skipping of
|
96
|
+
# {Layout::Entity}s on hidden or locked {Layout::Layers}
|
97
|
+
#
|
98
|
+
# @version LayOut 2018
|
99
|
+
#
|
100
|
+
# @yieldparam [Layout::Entity] entity
|
101
|
+
def each(flags = {})
|
102
|
+
end
|
103
|
+
|
104
|
+
# The {#length} method returns the number of {Layout::Entity}s.
|
105
|
+
#
|
106
|
+
# @example
|
107
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
108
|
+
# entities = doc.shared_entities
|
109
|
+
# num_entities = entities.length
|
110
|
+
#
|
111
|
+
# @return [Integer]
|
112
|
+
#
|
113
|
+
# @version LayOut 2018
|
114
|
+
def length
|
115
|
+
end
|
116
|
+
alias_method :size, :length
|
117
|
+
|
118
|
+
# The {#reverse_each} method iterates through all of the {Layout::Entity}s in
|
119
|
+
# reverse order. When iterating over a {Layout::LayerInstance}'s
|
120
|
+
# {Layout::Entities}, it is not necessary to provide a flags Hash. When
|
121
|
+
# iterating over a {Layout::Page}'s {Layout::Entities}, the flags Hash is
|
122
|
+
# optional; providing no Hash will result in iterating over all
|
123
|
+
# {Layout::Entity}s, including those on hidden or locked {Layout::Layer}s.
|
124
|
+
# Valid symbols for the Hash are +:skip_hidden+ and +:skip_locked+.
|
125
|
+
#
|
126
|
+
# @example
|
127
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
128
|
+
# flags = { :skip_hidden => true, :skip_locked => true }
|
129
|
+
# entities = doc.pages.first.entities
|
130
|
+
# entities.reverse_each(flags) { |entity|
|
131
|
+
# puts entity
|
132
|
+
# }
|
133
|
+
#
|
134
|
+
# @overload reverse_each
|
135
|
+
#
|
136
|
+
# @yieldparam [Layout::Entity] entity
|
137
|
+
#
|
138
|
+
# @overload reverse_each(flags)
|
139
|
+
#
|
140
|
+
# @param [Hash{Symbol => Boolean}] flags A hash that allows skipping of
|
141
|
+
# {Layout::Entity}s on hidden or locked {Layout::Layers}.
|
142
|
+
# @yieldparam [Layout::Entity] entity
|
143
|
+
#
|
144
|
+
# @version LayOut 2018
|
145
|
+
def reverse_each(*args)
|
146
|
+
end
|
147
|
+
|
148
|
+
end
|