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.
Files changed (149) hide show
  1. checksums.yaml +5 -5
  2. data/.yardopts +9 -9
  3. data/lib/sketchup-api-stubs.rb +1 -1
  4. data/lib/sketchup-api-stubs/sketchup.rb +145 -145
  5. data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +318 -318
  6. data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +172 -172
  7. data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +126 -126
  8. data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +102 -102
  9. data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +400 -400
  10. data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +661 -661
  11. data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +492 -492
  12. data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +478 -478
  13. data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +263 -263
  14. data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +141 -141
  15. data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +522 -522
  16. data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +691 -691
  17. data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
  18. data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +573 -573
  19. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +411 -411
  20. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +174 -186
  21. data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
  22. data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +514 -514
  23. data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
  24. data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +143 -155
  25. data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -353
  26. data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +349 -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 +371 -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 +220 -232
  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 +204 -216
  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 +694 -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/Sketchup/Animation.rb +140 -140
  49. data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +157 -157
  50. data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +209 -209
  51. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +152 -152
  52. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +281 -281
  53. data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
  54. data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +328 -328
  55. data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +577 -577
  56. data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
  57. data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +122 -122
  58. data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +281 -281
  59. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +562 -562
  60. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +593 -593
  61. data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
  62. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +257 -257
  63. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
  64. data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +194 -194
  65. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +329 -329
  66. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +72 -72
  67. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +102 -102
  68. data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
  69. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +312 -312
  70. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +38 -38
  71. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
  72. data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +390 -390
  73. data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +508 -508
  74. data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
  75. data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1119 -1119
  76. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +125 -125
  77. data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +544 -544
  78. data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +59 -59
  79. data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +125 -125
  80. data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +750 -750
  81. data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +104 -104
  82. data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +697 -697
  83. data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
  84. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +285 -285
  85. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
  86. data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +409 -409
  87. data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +226 -226
  88. data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +190 -190
  89. data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +393 -393
  90. data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +82 -82
  91. data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +303 -303
  92. data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +285 -280
  93. data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +244 -231
  94. data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +136 -136
  95. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +48 -48
  96. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
  97. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
  98. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +112 -123
  99. data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
  100. data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +416 -416
  101. data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +311 -311
  102. data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +141 -141
  103. data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +95 -95
  104. data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1638 -1601
  105. data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +356 -356
  106. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +132 -132
  107. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +284 -284
  108. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
  109. data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +770 -770
  110. data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +353 -353
  111. data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +76 -76
  112. data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +456 -456
  113. data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
  114. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +364 -364
  115. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +44 -44
  116. data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
  117. data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +454 -454
  118. data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +115 -115
  119. data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +212 -212
  120. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +257 -257
  121. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +57 -57
  122. data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
  123. data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +211 -211
  124. data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
  125. data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +225 -225
  126. data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
  127. data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +829 -829
  128. data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
  129. data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +154 -154
  130. data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +61 -61
  131. data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
  132. data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1301 -1301
  133. data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +43 -43
  134. data/lib/sketchup-api-stubs/stubs/UI/Command.rb +310 -310
  135. data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +356 -356
  136. data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +229 -229
  137. data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +240 -240
  138. data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +633 -633
  139. data/lib/sketchup-api-stubs/stubs/_top_level.rb +311 -311
  140. data/lib/sketchup-api-stubs/stubs/array.rb +741 -741
  141. data/lib/sketchup-api-stubs/stubs/geom.rb +348 -348
  142. data/lib/sketchup-api-stubs/stubs/languagehandler.rb +92 -92
  143. data/lib/sketchup-api-stubs/stubs/length.rb +278 -278
  144. data/lib/sketchup-api-stubs/stubs/numeric.rb +249 -249
  145. data/lib/sketchup-api-stubs/stubs/sketchup.rb +1310 -1310
  146. data/lib/sketchup-api-stubs/stubs/sketchupextension.rb +353 -353
  147. data/lib/sketchup-api-stubs/stubs/string.rb +24 -24
  148. data/lib/sketchup-api-stubs/stubs/ui.rb +667 -667
  149. metadata +3 -4
@@ -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 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,123 +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 {#size} method returns the number of line styles that SketchUp supports.
78
- #
79
- # @example
80
- # line_styles = Sketchup.active_model.line_styles
81
- # line_styles.size
82
- #
83
- # @return [Integer] The count of line styles.
84
- #
85
- # @version SketchUp 2019
86
- def length
87
- end
88
-
89
- # The {#names} method return the support line styles as strings.
90
- #
91
- # @example
92
- # Sketchup.active_model.line_styles.names
93
- #
94
- # @return [Array<String>]
95
- #
96
- # @version SketchUp 2019
97
- def names
98
- end
99
-
100
- # The {#size} method returns the number of line styles that SketchUp supports.
101
- #
102
- # @example
103
- # line_styles = Sketchup.active_model.line_styles
104
- # line_styles.size
105
- #
106
- # @return [Integer] The count of line styles.
107
- #
108
- # @version SketchUp 2019
109
- def size
110
- end
111
-
112
- # The {#to_a} method returns an array of all the line styles.
113
- #
114
- # @example
115
- # line_styles = Sketchup.active_active_model.line_styles.to_a
116
- #
117
- # @return [Array] Containing all the line style objects.
118
- #
119
- # @version SketchUp 2019
120
- def to_a
121
- end
122
-
123
- end
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,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 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