sketchup-api-stubs 0.7.4 → 0.7.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (151) hide show
  1. checksums.yaml +4 -4
  2. data/lib/sketchup-api-stubs/sketchup.rb +148 -145
  3. data/lib/sketchup-api-stubs/stubs/{array.rb → Array.rb} +741 -741
  4. data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +322 -318
  5. data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +172 -172
  6. data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +126 -126
  7. data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +102 -102
  8. data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +400 -400
  9. data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +661 -661
  10. data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +523 -492
  11. data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +478 -478
  12. data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +263 -263
  13. data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +141 -141
  14. data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +522 -522
  15. data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +693 -691
  16. data/lib/sketchup-api-stubs/stubs/{geom.rb → Geom.rb} +351 -348
  17. data/lib/sketchup-api-stubs/stubs/{languagehandler.rb → LanguageHandler.rb} +93 -92
  18. data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +595 -573
  19. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +698 -411
  20. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +183 -174
  21. data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
  22. data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +516 -514
  23. data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
  24. data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +148 -143
  25. data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -353
  26. data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +354 -349
  27. data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +311 -311
  28. data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +261 -261
  29. data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +91 -91
  30. data/lib/sketchup-api-stubs/stubs/Layout/Label.rb +370 -371
  31. data/lib/sketchup-api-stubs/stubs/Layout/Layer.rb +218 -218
  32. data/lib/sketchup-api-stubs/stubs/Layout/LayerInstance.rb +128 -128
  33. data/lib/sketchup-api-stubs/stubs/Layout/Layers.rb +225 -220
  34. data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb +567 -567
  35. data/lib/sketchup-api-stubs/stubs/Layout/LockedEntityError.rb +10 -10
  36. data/lib/sketchup-api-stubs/stubs/Layout/LockedLayerError.rb +11 -11
  37. data/lib/sketchup-api-stubs/stubs/Layout/Page.rb +183 -183
  38. data/lib/sketchup-api-stubs/stubs/Layout/PageInfo.rb +387 -387
  39. data/lib/sketchup-api-stubs/stubs/Layout/Pages.rb +209 -204
  40. data/lib/sketchup-api-stubs/stubs/Layout/Path.rb +344 -344
  41. data/lib/sketchup-api-stubs/stubs/Layout/Rectangle.rb +174 -174
  42. data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +692 -694
  43. data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +1519 -1519
  44. data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +290 -290
  45. data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb +149 -149
  46. data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb +139 -139
  47. data/lib/sketchup-api-stubs/stubs/Layout/TableRow.rb +135 -135
  48. data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
  49. data/lib/sketchup-api-stubs/stubs/{length.rb → Length.rb} +278 -278
  50. data/lib/sketchup-api-stubs/stubs/{numeric.rb → Numeric.rb} +249 -249
  51. data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +144 -140
  52. data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +169 -157
  53. data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +209 -209
  54. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +152 -152
  55. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +286 -281
  56. data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
  57. data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +302 -328
  58. data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +478 -577
  59. data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
  60. data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +122 -122
  61. data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +294 -281
  62. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +619 -562
  63. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +593 -593
  64. data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
  65. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +257 -257
  66. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
  67. data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +201 -194
  68. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +426 -329
  69. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +74 -72
  70. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +104 -102
  71. data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
  72. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +306 -312
  73. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +42 -38
  74. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
  75. data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +396 -390
  76. data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +502 -508
  77. data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
  78. data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1205 -1119
  79. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesBuilder.rb +272 -0
  80. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +127 -125
  81. data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +545 -544
  82. data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +60 -59
  83. data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +126 -125
  84. data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +937 -750
  85. data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +104 -104
  86. data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +750 -697
  87. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +292 -285
  88. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
  89. data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
  90. data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +468 -409
  91. data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +266 -226
  92. data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +189 -190
  93. data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +407 -393
  94. data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +84 -82
  95. data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +306 -303
  96. data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +326 -285
  97. data/lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb +422 -0
  98. data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +427 -244
  99. data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +249 -136
  100. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
  101. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +48 -48
  102. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
  103. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +112 -112
  104. data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
  105. data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +414 -416
  106. data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +318 -311
  107. data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +142 -141
  108. data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +93 -95
  109. data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1651 -1638
  110. data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +357 -356
  111. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +131 -132
  112. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +284 -284
  113. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
  114. data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +797 -770
  115. data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +363 -353
  116. data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +77 -76
  117. data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +477 -456
  118. data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
  119. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +364 -364
  120. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +45 -44
  121. data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
  122. data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +459 -454
  123. data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +115 -115
  124. data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +212 -212
  125. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +260 -257
  126. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +59 -57
  127. data/lib/sketchup-api-stubs/stubs/Sketchup/Skp.rb +40 -0
  128. data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
  129. data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +217 -211
  130. data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
  131. data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +217 -225
  132. data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
  133. data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +837 -829
  134. data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
  135. data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +156 -154
  136. data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +75 -61
  137. data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
  138. data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1317 -1301
  139. data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +45 -43
  140. data/lib/sketchup-api-stubs/stubs/{sketchup.rb → Sketchup.rb} +1360 -1310
  141. data/lib/sketchup-api-stubs/stubs/{sketchupextension.rb → SketchupExtension.rb} +353 -353
  142. data/lib/sketchup-api-stubs/stubs/{string.rb → String.rb} +24 -24
  143. data/lib/sketchup-api-stubs/stubs/UI/Command.rb +389 -310
  144. data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +496 -356
  145. data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +269 -229
  146. data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +240 -240
  147. data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +635 -633
  148. data/lib/sketchup-api-stubs/stubs/{ui.rb → UI.rb} +683 -667
  149. data/lib/sketchup-api-stubs/stubs/_top_level.rb +311 -311
  150. data/lib/sketchup-api-stubs.rb +1 -1
  151. metadata +15 -12
@@ -1,24 +1,24 @@
1
- # Copyright:: Copyright 2020 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # This provides a way for SketchUp to customize a line style and be set on a
5
- # layer.
6
- #
7
- # @version SketchUp 2019
8
- class Sketchup::LineStyle < Sketchup::Entity
9
-
10
- # Instance Methods
11
-
12
- # The {#name} method retrieves the name of the line style object.
13
- #
14
- # @example
15
- # line_style = Sketchup.active_model.line_styles["Solid Basic"]
16
- # line_style.name # returns "Solid Basic"
17
- #
18
- # @return [String] The name of the line style.
19
- #
20
- # @version SketchUp 2019
21
- def name
22
- end
23
-
24
- end
1
+ # Copyright:: Copyright 2022 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # This provides a way for SketchUp to customize a line style and be set on a
5
+ # layer.
6
+ #
7
+ # @version SketchUp 2019
8
+ class Sketchup::LineStyle < Sketchup::Entity
9
+
10
+ # Instance Methods
11
+
12
+ # The {#name} method retrieves the name of the line style object.
13
+ #
14
+ # @example
15
+ # line_style = Sketchup.active_model.line_styles["Solid Basic"]
16
+ # line_style.name # returns "Solid Basic"
17
+ #
18
+ # @return [String] The name of the line style.
19
+ #
20
+ # @version SketchUp 2019
21
+ def name
22
+ end
23
+
24
+ end
@@ -1,112 +1,112 @@
1
- # Copyright:: Copyright 2020 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # Provides access to the different line style objects in the model.
5
- #
6
- # @version SketchUp 2019
7
- class Sketchup::LineStyles < Sketchup::Entity
8
-
9
- # Includes
10
-
11
- include Enumerable
12
-
13
- # Instance Methods
14
-
15
- # The {#[]} method lets you retrieve a line style by name or index.
16
- #
17
- # The {#at} method is an alias of {#[]}.
18
- #
19
- # @example
20
- # solid_style = Sketchup.active_model.line_styles["Solid Basic"]
21
- # line_style = Sketchup.active_model.line_styles[1]
22
- #
23
- # @overload [](name)
24
- #
25
- # @param [String] name The name of the line style to retrieve.
26
- #
27
- # @overload [](index)
28
- #
29
- # @param [Index] index The index of the line style to retrieve.
30
- #
31
- # @raise [IndexError] If index is out of bounds.
32
- #
33
- # @return [Sketchup::LineStyle, nil] The line style retrieved. Nil if the name
34
- # couldn't be retrived.
35
- #
36
- # @version SketchUp 2019
37
- def [](arg)
38
- end
39
-
40
- # The {#[]} method lets you retrieve a line style by name or index.
41
- #
42
- # The {#at} method is an alias of {#[]}.
43
- #
44
- # @example
45
- # solid_style = Sketchup.active_model.line_styles["Solid Basic"]
46
- # line_style = Sketchup.active_model.line_styles[1]
47
- #
48
- # @overload [](name)
49
- #
50
- # @param [String] name The name of the line style to retrieve.
51
- #
52
- # @overload [](index)
53
- #
54
- # @param [Index] index The index of the line style to retrieve.
55
- #
56
- # @raise [IndexError] If index is out of bounds.
57
- #
58
- # @return [Sketchup::LineStyle, nil] The line style retrieved. Nil if the name
59
- # couldn't be retrived.
60
- #
61
- # @version SketchUp 2019
62
- def at(arg)
63
- end
64
-
65
- # The {#each} method is used to iterate through all the line styles.
66
- #
67
- # @example
68
- # line_styles = Sketchup.active_model.line_styles
69
- # line_styles.each{ |line_style| p line_style.name }
70
- #
71
- # @return [nil]
72
- #
73
- # @version SketchUp 2019
74
- def each
75
- end
76
-
77
- # The {#names} method return the support line styles as strings.
78
- #
79
- # @example
80
- # Sketchup.active_model.line_styles.names
81
- #
82
- # @return [Array<String>]
83
- #
84
- # @version SketchUp 2019
85
- def names
86
- end
87
-
88
- # The {#size} method returns the number of line styles that SketchUp supports.
89
- #
90
- # @example
91
- # line_styles = Sketchup.active_model.line_styles
92
- # line_styles.size
93
- #
94
- # @return [Integer] The count of line styles.
95
- #
96
- # @version SketchUp 2019
97
- def size
98
- end
99
- alias_method :length, :size
100
-
101
- # The {#to_a} method returns an array of all the line styles.
102
- #
103
- # @example
104
- # line_styles = Sketchup.active_active_model.line_styles.to_a
105
- #
106
- # @return [Array] Containing all the line style objects.
107
- #
108
- # @version SketchUp 2019
109
- def to_a
110
- end
111
-
112
- end
1
+ # Copyright:: Copyright 2022 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # Provides access to the different line style objects in the model.
5
+ #
6
+ # @version SketchUp 2019
7
+ class Sketchup::LineStyles < Sketchup::Entity
8
+
9
+ # Includes
10
+
11
+ include Enumerable
12
+
13
+ # Instance Methods
14
+
15
+ # The {#[]} method lets you retrieve a line style by name or index.
16
+ #
17
+ # The {#at} method is an alias of {#[]}.
18
+ #
19
+ # @example
20
+ # solid_style = Sketchup.active_model.line_styles["Solid Basic"]
21
+ # line_style = Sketchup.active_model.line_styles[1]
22
+ #
23
+ # @overload [](name)
24
+ #
25
+ # @param [String] name The name of the line style to retrieve.
26
+ #
27
+ # @overload [](index)
28
+ #
29
+ # @param [Index] index The index of the line style to retrieve.
30
+ #
31
+ # @raise [IndexError] If index is out of bounds.
32
+ #
33
+ # @return [Sketchup::LineStyle, nil] The line style retrieved. Nil if the name
34
+ # couldn't be retrived.
35
+ #
36
+ # @version SketchUp 2019
37
+ def [](arg)
38
+ end
39
+
40
+ # The {#[]} method lets you retrieve a line style by name or index.
41
+ #
42
+ # The {#at} method is an alias of {#[]}.
43
+ #
44
+ # @example
45
+ # solid_style = Sketchup.active_model.line_styles["Solid Basic"]
46
+ # line_style = Sketchup.active_model.line_styles[1]
47
+ #
48
+ # @overload [](name)
49
+ #
50
+ # @param [String] name The name of the line style to retrieve.
51
+ #
52
+ # @overload [](index)
53
+ #
54
+ # @param [Index] index The index of the line style to retrieve.
55
+ #
56
+ # @raise [IndexError] If index is out of bounds.
57
+ #
58
+ # @return [Sketchup::LineStyle, nil] The line style retrieved. Nil if the name
59
+ # couldn't be retrived.
60
+ #
61
+ # @version SketchUp 2019
62
+ def at(arg)
63
+ end
64
+
65
+ # The {#each} method is used to iterate through all the line styles.
66
+ #
67
+ # @example
68
+ # line_styles = Sketchup.active_model.line_styles
69
+ # line_styles.each{ |line_style| p line_style.name }
70
+ #
71
+ # @return [nil]
72
+ #
73
+ # @version SketchUp 2019
74
+ def each
75
+ end
76
+
77
+ # The {#names} method return the support line styles as strings.
78
+ #
79
+ # @example
80
+ # Sketchup.active_model.line_styles.names
81
+ #
82
+ # @return [Array<String>]
83
+ #
84
+ # @version SketchUp 2019
85
+ def names
86
+ end
87
+
88
+ # The {#size} method returns the number of line styles that SketchUp supports.
89
+ #
90
+ # @example
91
+ # line_styles = Sketchup.active_model.line_styles
92
+ # line_styles.size
93
+ #
94
+ # @return [Integer] The count of line styles.
95
+ #
96
+ # @version SketchUp 2019
97
+ def size
98
+ end
99
+ alias_method :length, :size
100
+
101
+ # The {#to_a} method returns an array of all the line styles.
102
+ #
103
+ # @example
104
+ # line_styles = Sketchup.active_active_model.line_styles.to_a
105
+ #
106
+ # @return [Array] Containing all the line style objects.
107
+ #
108
+ # @version SketchUp 2019
109
+ def to_a
110
+ end
111
+
112
+ end
@@ -1,137 +1,137 @@
1
- # Copyright:: Copyright 2020 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # Loop is a low level topology class that will not need to be used often. A
5
- # Loop is a chain of Edges that bound a Face.
6
- #
7
- # @version SketchUp 6.0
8
- class Sketchup::Loop < Sketchup::Entity
9
-
10
- # Instance Methods
11
-
12
- # Determine if the loop is convex.
13
- #
14
- # @example
15
- # entities = Sketchup.active_model.active_entities
16
- # points = []
17
- # points << Geom::Point3d.new(0, 0, 0)
18
- # points << Geom::Point3d.new(100, 0, 0)
19
- # points << Geom::Point3d.new(100, 200, 0)
20
- # points << Geom::Point3d.new(0, 200, 0)
21
- # face = entities.add_face(points)
22
- # loop = face.outer_loop
23
- # if loop.convex?
24
- # puts "Loop is convex."
25
- # else
26
- # puts "Loop is not convex."
27
- # end
28
- #
29
- # @return [Boolean] status - true if convex, false if not convex.
30
- #
31
- # @version SketchUp 6.0
32
- def convex?
33
- end
34
-
35
- # Get an array of the edges that define the loop in an ordered sequence.
36
- #
37
- # @example
38
- # entities = Sketchup.active_model.active_entities
39
- # points = []
40
- # points << Geom::Point3d.new(0, 0, 0)
41
- # points << Geom::Point3d.new(100, 0, 0)
42
- # points << Geom::Point3d.new(100, 200, 0)
43
- # points << Geom::Point3d.new(0, 200, 0)
44
- # face = entities.add_face(points)
45
- # loop = face.outer_loop
46
- # edges = loop.edges
47
- #
48
- # @return edges - an array of Edge objects if successful.
49
- #
50
- # @version SketchUp 6.0
51
- def edges
52
- end
53
-
54
- # Get an array of the EdgeUse objects that define this loop in an ordered
55
- # sequence.
56
- #
57
- # @example
58
- # entities = Sketchup.active_model.active_entities
59
- # points = []
60
- # points << Geom::Point3d.new(0, 0, 0)
61
- # points << Geom::Point3d.new(100, 0, 0)
62
- # points << Geom::Point3d.new(100, 200, 0)
63
- # points << Geom::Point3d.new(0, 200, 0)
64
- # face = entities.add_face(points)
65
- # loop = face.outer_loop
66
- # edgeuses = loop.edgeuses
67
- #
68
- # @return edgeuses - an array of EdgeUse objects if successful.
69
- #
70
- # @version SketchUp 6.0
71
- def edgeuses
72
- end
73
-
74
- # Get the Face object that is bounded by this loop.
75
- #
76
- # @example
77
- # entities = Sketchup.active_model.active_entities
78
- # points = []
79
- # points << Geom::Point3d.new(0, 0, 0)
80
- # points << Geom::Point3d.new(100, 0, 0)
81
- # points << Geom::Point3d.new(100, 200, 0)
82
- # points << Geom::Point3d.new(0, 200, 0)
83
- # face = entities.add_face(points)
84
- # loop = face.outer_loop
85
- # loop_face = loop.face
86
- #
87
- # @return face - a Face object if successful
88
- #
89
- # @version SketchUp 6.0
90
- def face
91
- end
92
-
93
- # Determine if this is an outer loop. Each face has one outer loop, and will
94
- # have one loop for each hole.
95
- #
96
- # @example
97
- # entities = Sketchup.active_model.active_entities
98
- # points = []
99
- # points << Geom::Point3d.new(0, 0, 0)
100
- # points << Geom::Point3d.new(100, 0, 0)
101
- # points << Geom::Point3d.new(100, 200, 0)
102
- # points << Geom::Point3d.new(0, 200, 0)
103
- # face = entities.add_face(points)
104
- # loop = face.outer_loop
105
- # if loop.outer?
106
- # puts "Loop is an outer loop."
107
- # else
108
- # puts "Loop is not an outer loop."
109
- # end
110
- #
111
- # @return [Boolean] status - true if the loop is an outer loop, false if it
112
- # is not an outer loop.
113
- #
114
- # @version SketchUp 6.0
115
- def outer?
116
- end
117
-
118
- # Get an array of the vertices that define the loop in an ordered sequence.
119
- #
120
- # @example
121
- # entities = Sketchup.active_model.active_entities
122
- # points = []
123
- # points << Geom::Point3d.new(0, 0, 0)
124
- # points << Geom::Point3d.new(100, 0, 0)
125
- # points << Geom::Point3d.new(100, 200, 0)
126
- # points << Geom::Point3d.new(0, 200, 0)
127
- # face = entities.add_face(points)
128
- # loop = face.outer_loop
129
- # vertices = loop.vertices
130
- #
131
- # @return vertices - an array of Vertex objects if successful.
132
- #
133
- # @version SketchUp 6.0
134
- def vertices
135
- end
136
-
137
- end
1
+ # Copyright:: Copyright 2022 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # Loop is a low level topology class that will not need to be used often. A
5
+ # Loop is a chain of Edges that bound a Face.
6
+ #
7
+ # @version SketchUp 6.0
8
+ class Sketchup::Loop < Sketchup::Entity
9
+
10
+ # Instance Methods
11
+
12
+ # Determine if the loop is convex.
13
+ #
14
+ # @example
15
+ # entities = Sketchup.active_model.active_entities
16
+ # points = []
17
+ # points << Geom::Point3d.new(0, 0, 0)
18
+ # points << Geom::Point3d.new(100, 0, 0)
19
+ # points << Geom::Point3d.new(100, 200, 0)
20
+ # points << Geom::Point3d.new(0, 200, 0)
21
+ # face = entities.add_face(points)
22
+ # loop = face.outer_loop
23
+ # if loop.convex?
24
+ # puts "Loop is convex."
25
+ # else
26
+ # puts "Loop is not convex."
27
+ # end
28
+ #
29
+ # @return [Boolean] status - true if convex, false if not convex.
30
+ #
31
+ # @version SketchUp 6.0
32
+ def convex?
33
+ end
34
+
35
+ # Get an array of the edges that define the loop in an ordered sequence.
36
+ #
37
+ # @example
38
+ # entities = Sketchup.active_model.active_entities
39
+ # points = []
40
+ # points << Geom::Point3d.new(0, 0, 0)
41
+ # points << Geom::Point3d.new(100, 0, 0)
42
+ # points << Geom::Point3d.new(100, 200, 0)
43
+ # points << Geom::Point3d.new(0, 200, 0)
44
+ # face = entities.add_face(points)
45
+ # loop = face.outer_loop
46
+ # edges = loop.edges
47
+ #
48
+ # @return edges - an array of Edge objects if successful.
49
+ #
50
+ # @version SketchUp 6.0
51
+ def edges
52
+ end
53
+
54
+ # Get an array of the EdgeUse objects that define this loop in an ordered
55
+ # sequence.
56
+ #
57
+ # @example
58
+ # entities = Sketchup.active_model.active_entities
59
+ # points = []
60
+ # points << Geom::Point3d.new(0, 0, 0)
61
+ # points << Geom::Point3d.new(100, 0, 0)
62
+ # points << Geom::Point3d.new(100, 200, 0)
63
+ # points << Geom::Point3d.new(0, 200, 0)
64
+ # face = entities.add_face(points)
65
+ # loop = face.outer_loop
66
+ # edgeuses = loop.edgeuses
67
+ #
68
+ # @return edgeuses - an array of EdgeUse objects if successful.
69
+ #
70
+ # @version SketchUp 6.0
71
+ def edgeuses
72
+ end
73
+
74
+ # Get the Face object that is bounded by this loop.
75
+ #
76
+ # @example
77
+ # entities = Sketchup.active_model.active_entities
78
+ # points = []
79
+ # points << Geom::Point3d.new(0, 0, 0)
80
+ # points << Geom::Point3d.new(100, 0, 0)
81
+ # points << Geom::Point3d.new(100, 200, 0)
82
+ # points << Geom::Point3d.new(0, 200, 0)
83
+ # face = entities.add_face(points)
84
+ # loop = face.outer_loop
85
+ # loop_face = loop.face
86
+ #
87
+ # @return face - a Face object if successful
88
+ #
89
+ # @version SketchUp 6.0
90
+ def face
91
+ end
92
+
93
+ # Determine if this is an outer loop. Each face has one outer loop, and will
94
+ # have one loop for each hole.
95
+ #
96
+ # @example
97
+ # entities = Sketchup.active_model.active_entities
98
+ # points = []
99
+ # points << Geom::Point3d.new(0, 0, 0)
100
+ # points << Geom::Point3d.new(100, 0, 0)
101
+ # points << Geom::Point3d.new(100, 200, 0)
102
+ # points << Geom::Point3d.new(0, 200, 0)
103
+ # face = entities.add_face(points)
104
+ # loop = face.outer_loop
105
+ # if loop.outer?
106
+ # puts "Loop is an outer loop."
107
+ # else
108
+ # puts "Loop is not an outer loop."
109
+ # end
110
+ #
111
+ # @return [Boolean] status - true if the loop is an outer loop, false if it
112
+ # is not an outer loop.
113
+ #
114
+ # @version SketchUp 6.0
115
+ def outer?
116
+ end
117
+
118
+ # Get an array of the vertices that define the loop in an ordered sequence.
119
+ #
120
+ # @example
121
+ # entities = Sketchup.active_model.active_entities
122
+ # points = []
123
+ # points << Geom::Point3d.new(0, 0, 0)
124
+ # points << Geom::Point3d.new(100, 0, 0)
125
+ # points << Geom::Point3d.new(100, 200, 0)
126
+ # points << Geom::Point3d.new(0, 200, 0)
127
+ # face = entities.add_face(points)
128
+ # loop = face.outer_loop
129
+ # vertices = loop.vertices
130
+ #
131
+ # @return vertices - an array of Vertex objects if successful.
132
+ #
133
+ # @version SketchUp 6.0
134
+ def vertices
135
+ end
136
+
137
+ end