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,61 +1,75 @@
1
- # Copyright:: Copyright 2020 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # The UV Helper class contains methods allowing you to determine the location
5
- # (UV coordinates) of a texture on a face. This class is particularly useful
6
- # in determining how textures that have been manipulated using the Texture
7
- # Tweaker should appear when exported to another file type
8
- #
9
- # Use the Face.get_UVHelper method to create a UVHelper for a given face.
10
- # See the TextureWriter class as well.
11
- #
12
- # @version SketchUp 6.0
13
- class Sketchup::UVHelper
14
-
15
- # Instance Methods
16
-
17
- # The get_back_UVQ method is used to get the UV coordinates for the back of a
18
- # face.
19
- #
20
- # @example
21
- # uv_helper = face.get_UVHelper true, true, my_texture_writer
22
- # face.outer_loop.vertices.each do |vert|
23
- # uvq = uv_help.get_back_UVQ(vert.position)
24
- # puts "u=" + uvq.x.to_s + " v=" + uvq.y.to_s
25
- # end
26
- #
27
- # @param point
28
- # A Point3d object containing one of the 3D vertexes of
29
- # the face.
30
- #
31
- # @return point - a Point3d containing the UV coordinates where
32
- # the X value is the U value, the Y value is the V value
33
- # and the Z value is a Q value (which is not used).
34
- #
35
- # @version SketchUp 6.0
36
- def get_back_UVQ(point)
37
- end
38
-
39
- # The get_front_UVQ method is used to get the UV coordinates for a front of a
40
- # face.
41
- #
42
- # @example
43
- # uv_helper = face.get_UVHelper true, true, my_texture_writer
44
- # face.outer_loop.vertices.each do |vert|
45
- # uvq = uv_helper.get_front_UVQ(vert.position)
46
- # puts "u=" + uvq.x.to_s + " v=" + uvq.y.to_s
47
- # end
48
- #
49
- # @param point
50
- # A Point3d object containing one of the 3D vertexes of
51
- # the face.
52
- #
53
- # @return point - a Point3d containing the UV coordinates where
54
- # the X value is the U value, the Y value is the V value
55
- # and the Z value is a Q value (which is not used).
56
- #
57
- # @version SketchUp 6.0
58
- def get_front_UVQ(point)
59
- end
60
-
61
- end
1
+ # Copyright:: Copyright 2022 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # The UV Helper class contains methods allowing you to determine the location
5
+ # (UV coordinates) of a texture on a face. This class is particularly useful
6
+ # in determining how textures that have been manipulated using the Texture
7
+ # Tweaker should appear when exported to another file type
8
+ #
9
+ # Use the Face.get_UVHelper method to create a UVHelper for a given face.
10
+ # See the TextureWriter class as well.
11
+ #
12
+ # @version SketchUp 6.0
13
+ class Sketchup::UVHelper
14
+
15
+ # Instance Methods
16
+
17
+ # The {#get_back_UVQ} method is used to get the UV texture coordinates on the
18
+ # back of a face.
19
+ #
20
+ # @example
21
+ # uv_helper = face.get_UVHelper(true, true, my_texture_writer)
22
+ # face.outer_loop.vertices.each do |vert|
23
+ # uvq = uv_helper.get_back_UVQ(vert.position)
24
+ # # "Normalize" UVQ to UV.
25
+ # # #x, #y and #z corresponds to U, V and Q respectively,
26
+ # # as SketchUp re-uses the normal Point3d objects for UVQs
27
+ # u = uvq.x / uvq.z
28
+ # v = uvq.y / uvq.z
29
+ # puts "u=#{u} v=#{v}""
30
+ # end
31
+ #
32
+ # @note To convert UVQ coordinates to UV,
33
+ # divide U and V by Q.
34
+ # u = uvq.u / uvq.q
35
+ # v = uvq.v / uvq.q
36
+ #
37
+ # @param [Geom::Point3d] point
38
+ # A point on the face.
39
+ #
40
+ # @return [Geom::Point3d] Point where X represents U, Y represents V and Z represents Q.
41
+ #
42
+ # @version SketchUp 6.0
43
+ def get_back_UVQ(point)
44
+ end
45
+
46
+ # The {#get_front_UVQ} method is used to get the UV texture coordinates on the
47
+ # front of a face.
48
+ #
49
+ # @example
50
+ # uv_helper = face.get_UVHelper(true, true, my_texture_writer)
51
+ # face.outer_loop.vertices.each do |vert|
52
+ # uvq = uv_helper.get_front_UVQ(vert.position)
53
+ # # "Normalize" UVQ to UV.
54
+ # # #x, #y and #z corresponds to U, V and Q respectively,
55
+ # # as SketchUp re-uses the normal Point3d objects for UVQs
56
+ # u = uvq.x / uvq.z
57
+ # v = uvq.y / uvq.z
58
+ # puts "u=#{u} v=#{v}""
59
+ # end
60
+ #
61
+ # @note To convert UVQ coordinates to UV,
62
+ # divide U and V by Q.
63
+ # u = uvq.u / uvq.q
64
+ # v = uvq.v / uvq.q
65
+ #
66
+ # @param [Geom::Point3d] point
67
+ # A point on the face.
68
+ #
69
+ # @return [Geom::Point3d] Point where X represents U, Y represents V and Z represents Q.
70
+ #
71
+ # @version SketchUp 6.0
72
+ def get_front_UVQ(point)
73
+ end
74
+
75
+ end
@@ -1,142 +1,142 @@
1
- # Copyright:: Copyright 2020 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # A Vertex. A Vertex represents the end of an Edge or a point inside a Face.
5
- #
6
- # @version SketchUp 6.0
7
- class Sketchup::Vertex < Sketchup::Entity
8
-
9
- # Instance Methods
10
-
11
- # The common_edge method is used to find a common edge that is defined by this
12
- # vertex and another vertex
13
- #
14
- # @example
15
- # edge = entities[0]
16
- # # returns array of vertices that make up the line
17
- # verticies = edge.vertices
18
- # vertex1 = verticies[0]
19
- # vertex2 = verticies[1]
20
- # edge = vertex1.common_edge vertex2
21
- # if (edge)
22
- # UI.messagebox edge
23
- # else
24
- # UI.messagebox "Failure"
25
- # end
26
- #
27
- # @param [Sketchup::Vertex] vertex2
28
- # A Vertex object.
29
- #
30
- # @return [Sketchup::Edge, nil] an Edge object common to both vertices if
31
- # successful. Returns nil if there is no edge between the
32
- # two vertices.
33
- #
34
- # @version SketchUp 6.0
35
- def common_edge(vertex2)
36
- end
37
-
38
- # The {#curve_interior?} method is used to determine if this vertex is on the
39
- # interior of a Curve.
40
- #
41
- # @example
42
- # edge = entities[0]
43
- # # returns array of vertices that make up the line
44
- # verticies = edge.vertices
45
- # vertex1 = verticies[0]
46
- # status = vertex1.curve_interior?
47
- # if (status)
48
- # UI.messagebox status
49
- # else
50
- # #returns nil if vertex is not on interior of a Curve
51
- # UI.messagebox "Failure"
52
- # end
53
- #
54
- # @note This method doesn't actually return a boolean as the question mark
55
- # post-fix would normally indicate. But the result still evaluates to
56
- # truthy or falsy.
57
- #
58
- # @return [Boolean]
59
- #
60
- # @version SketchUp 6.0
61
- def curve_interior?
62
- end
63
-
64
- # The edges method is used to retrieve an Array of edges that use the Vertex.
65
- #
66
- # @example
67
- # edge = entities[0]
68
- # # Returns array of vertices that make up the line.
69
- # verticies = edge.vertices
70
- # vertex1 = verticies[0]
71
- # edges = vertex1.edges
72
- #
73
- # @return [Array<Sketchup::Edge>] an Array of edge objects if successful
74
- #
75
- # @version SketchUp 6.0
76
- def edges
77
- end
78
-
79
- # The faces method is used to retrieve an Array of faces that use the vertex.
80
- #
81
- # @example
82
- # edge = entities[0]
83
- # # Returns array of vertices that make up the line.
84
- # verticies = edge.vertices
85
- # vertex1 = verticies[0]
86
- # faces = vertex1.faces
87
- #
88
- # @return [Array<Sketchup::Face>] an Array of faces that use the vertex if
89
- # successful
90
- #
91
- # @version SketchUp 6.0
92
- def faces
93
- end
94
-
95
- # The loops method is used to retrieve an Array of loops that use the vertex.
96
- #
97
- # @example
98
- # edge = entities[0]
99
- # # Returns array of vertices that make up the line.
100
- # verticies = edge.vertices
101
- # vertex1 = verticies[0]
102
- # loops = vertex1.loops
103
- #
104
- # @return [Array<Sketchup::Loop>] an Array of loops that use the vertex if
105
- # successful
106
- #
107
- # @version SketchUp 6.0
108
- def loops
109
- end
110
-
111
- # The position method is used to retrieve the Point3d position of a vertex.
112
- #
113
- # @example
114
- # edge = entities[0]
115
- # # Returns array of vertices that make up the line.
116
- # verticies = edge.vertices
117
- # vertex1 = verticies[0]
118
- # position = vertex1.position
119
- #
120
- # @return [Geom::Point3d] a Point3d object representing the position of
121
- # the vertex if successful
122
- #
123
- # @version SketchUp 6.0
124
- def position
125
- end
126
-
127
- # The used_by? method is used to determine if the Vertex is used by a given
128
- # Edge or Face.
129
- #
130
- # @example
131
- # used = vertex1.used_by? my_face
132
- #
133
- # @param [Sketchup::Edge, Sketchup::Face] face_or_edge
134
- # A Face or Edge ot test against.
135
- #
136
- # @return [Boolean]
137
- #
138
- # @version SketchUp 6.0
139
- def used_by?(face_or_edge)
140
- end
141
-
142
- end
1
+ # Copyright:: Copyright 2022 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # A Vertex. A Vertex represents the end of an Edge or a point inside a Face.
5
+ #
6
+ # @version SketchUp 6.0
7
+ class Sketchup::Vertex < Sketchup::Entity
8
+
9
+ # Instance Methods
10
+
11
+ # The common_edge method is used to find a common edge that is defined by this
12
+ # vertex and another vertex
13
+ #
14
+ # @example
15
+ # edge = entities[0]
16
+ # # returns array of vertices that make up the line
17
+ # verticies = edge.vertices
18
+ # vertex1 = verticies[0]
19
+ # vertex2 = verticies[1]
20
+ # edge = vertex1.common_edge vertex2
21
+ # if (edge)
22
+ # UI.messagebox edge
23
+ # else
24
+ # UI.messagebox "Failure"
25
+ # end
26
+ #
27
+ # @param [Sketchup::Vertex] vertex2
28
+ # A Vertex object.
29
+ #
30
+ # @return [Sketchup::Edge, nil] an Edge object common to both vertices if
31
+ # successful. Returns nil if there is no edge between the
32
+ # two vertices.
33
+ #
34
+ # @version SketchUp 6.0
35
+ def common_edge(vertex2)
36
+ end
37
+
38
+ # The {#curve_interior?} method is used to determine if this vertex is on the
39
+ # interior of a Curve.
40
+ #
41
+ # @example
42
+ # edge = entities[0]
43
+ # # returns array of vertices that make up the line
44
+ # verticies = edge.vertices
45
+ # vertex1 = verticies[0]
46
+ # status = vertex1.curve_interior?
47
+ # if (status)
48
+ # UI.messagebox status
49
+ # else
50
+ # #returns nil if vertex is not on interior of a Curve
51
+ # UI.messagebox "Failure"
52
+ # end
53
+ #
54
+ # @note This method doesn't actually return a boolean as the question mark
55
+ # post-fix would normally indicate. But the result still evaluates to
56
+ # truthy or falsy.
57
+ #
58
+ # @return [Boolean]
59
+ #
60
+ # @version SketchUp 6.0
61
+ def curve_interior?
62
+ end
63
+
64
+ # The edges method is used to retrieve an Array of edges that use the Vertex.
65
+ #
66
+ # @example
67
+ # edge = entities[0]
68
+ # # Returns array of vertices that make up the line.
69
+ # verticies = edge.vertices
70
+ # vertex1 = verticies[0]
71
+ # edges = vertex1.edges
72
+ #
73
+ # @return [Array<Sketchup::Edge>] an Array of edge objects if successful
74
+ #
75
+ # @version SketchUp 6.0
76
+ def edges
77
+ end
78
+
79
+ # The faces method is used to retrieve an Array of faces that use the vertex.
80
+ #
81
+ # @example
82
+ # edge = entities[0]
83
+ # # Returns array of vertices that make up the line.
84
+ # verticies = edge.vertices
85
+ # vertex1 = verticies[0]
86
+ # faces = vertex1.faces
87
+ #
88
+ # @return [Array<Sketchup::Face>] an Array of faces that use the vertex if
89
+ # successful
90
+ #
91
+ # @version SketchUp 6.0
92
+ def faces
93
+ end
94
+
95
+ # The loops method is used to retrieve an Array of loops that use the vertex.
96
+ #
97
+ # @example
98
+ # edge = entities[0]
99
+ # # Returns array of vertices that make up the line.
100
+ # verticies = edge.vertices
101
+ # vertex1 = verticies[0]
102
+ # loops = vertex1.loops
103
+ #
104
+ # @return [Array<Sketchup::Loop>] an Array of loops that use the vertex if
105
+ # successful
106
+ #
107
+ # @version SketchUp 6.0
108
+ def loops
109
+ end
110
+
111
+ # The position method is used to retrieve the Point3d position of a vertex.
112
+ #
113
+ # @example
114
+ # edge = entities[0]
115
+ # # Returns array of vertices that make up the line.
116
+ # verticies = edge.vertices
117
+ # vertex1 = verticies[0]
118
+ # position = vertex1.position
119
+ #
120
+ # @return [Geom::Point3d] a Point3d object representing the position of
121
+ # the vertex if successful
122
+ #
123
+ # @version SketchUp 6.0
124
+ def position
125
+ end
126
+
127
+ # The used_by? method is used to determine if the Vertex is used by a given
128
+ # Edge or Face.
129
+ #
130
+ # @example
131
+ # used = vertex1.used_by? my_face
132
+ #
133
+ # @param [Sketchup::Edge, Sketchup::Face] face_or_edge
134
+ # A Face or Edge ot test against.
135
+ #
136
+ # @return [Boolean]
137
+ #
138
+ # @version SketchUp 6.0
139
+ def used_by?(face_or_edge)
140
+ end
141
+
142
+ end