sketchup-api-stubs 0.7.8 → 0.7.10

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 (153) hide show
  1. checksums.yaml +4 -4
  2. data/lib/sketchup-api-stubs/sketchup.rb +3 -0
  3. data/lib/sketchup-api-stubs/stubs/Array.rb +1 -1
  4. data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +1 -1
  5. data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +1 -1
  6. data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +1 -1
  7. data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +1 -1
  8. data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +1 -1
  9. data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +1 -1
  10. data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +4 -18
  11. data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +17 -19
  12. data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +1 -1
  13. data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +1 -1
  14. data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +1 -1
  15. data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +3 -3
  16. data/lib/sketchup-api-stubs/stubs/Geom.rb +1 -1
  17. data/lib/sketchup-api-stubs/stubs/LanguageHandler.rb +1 -1
  18. data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +1 -1
  19. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +50 -1
  20. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +1 -1
  21. data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +1 -1
  22. data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +56 -3
  23. data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +1 -1
  24. data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +1 -1
  25. data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +4 -1
  26. data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +1 -1
  27. data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +1 -1
  28. data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +1 -1
  29. data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +1 -1
  30. data/lib/sketchup-api-stubs/stubs/Layout/Label.rb +1 -1
  31. data/lib/sketchup-api-stubs/stubs/Layout/Layer.rb +1 -1
  32. data/lib/sketchup-api-stubs/stubs/Layout/LayerInstance.rb +1 -1
  33. data/lib/sketchup-api-stubs/stubs/Layout/Layers.rb +1 -1
  34. data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb +1 -1
  35. data/lib/sketchup-api-stubs/stubs/Layout/LockedEntityError.rb +1 -1
  36. data/lib/sketchup-api-stubs/stubs/Layout/LockedLayerError.rb +1 -1
  37. data/lib/sketchup-api-stubs/stubs/Layout/Page.rb +1 -1
  38. data/lib/sketchup-api-stubs/stubs/Layout/PageInfo.rb +73 -1
  39. data/lib/sketchup-api-stubs/stubs/Layout/Pages.rb +1 -1
  40. data/lib/sketchup-api-stubs/stubs/Layout/Path.rb +7 -7
  41. data/lib/sketchup-api-stubs/stubs/Layout/Rectangle.rb +1 -1
  42. data/lib/sketchup-api-stubs/stubs/Layout/ReferenceEntity.rb +82 -0
  43. data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +24 -2
  44. data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +1 -1
  45. data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +1 -1
  46. data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb +1 -1
  47. data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb +1 -1
  48. data/lib/sketchup-api-stubs/stubs/Layout/TableRow.rb +1 -1
  49. data/lib/sketchup-api-stubs/stubs/Layout.rb +1 -1
  50. data/lib/sketchup-api-stubs/stubs/Length.rb +1 -1
  51. data/lib/sketchup-api-stubs/stubs/Numeric.rb +1 -1
  52. data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +1 -1
  53. data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +1 -1
  54. data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +18 -1
  55. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +3 -5
  56. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +4 -9
  57. data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +1 -1
  58. data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +1 -1
  59. data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +1 -1
  60. data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +1 -1
  61. data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +4 -5
  62. data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +1 -1
  63. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +44 -4
  64. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +2 -2
  65. data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +1 -1
  66. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +1 -1
  67. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +1 -1
  68. data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +1 -1
  69. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +25 -2
  70. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +1 -1
  71. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +1 -1
  72. data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +1 -1
  73. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +1 -1
  74. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +1 -1
  75. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +1 -1
  76. data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +13 -3
  77. data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +62 -167
  78. data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +1 -1
  79. data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +246 -209
  80. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesBuilder.rb +3 -14
  81. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +1 -1
  82. data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +10 -36
  83. data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +1 -1
  84. data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +4 -5
  85. data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +1 -1
  86. data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +1 -3
  87. data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +1 -1
  88. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +16 -26
  89. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +2 -2
  90. data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +1 -1
  91. data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +1 -1
  92. data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +1 -1
  93. data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +1 -1
  94. data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +29 -30
  95. data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +1 -1
  96. data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +2 -2
  97. data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +1 -1
  98. data/lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb +1 -1
  99. data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +1 -1
  100. data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +1 -1
  101. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +1 -1
  102. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +2 -2
  103. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +1 -1
  104. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +9 -7
  105. data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +1 -1
  106. data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +1 -1
  107. data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +2 -3
  108. data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +1 -1
  109. data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +1 -1
  110. data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +28 -23
  111. data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +1 -1
  112. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +4 -5
  113. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +5 -18
  114. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +1 -1
  115. data/lib/sketchup-api-stubs/stubs/Sketchup/Overlay.rb +490 -0
  116. data/lib/sketchup-api-stubs/stubs/Sketchup/OverlaysManager.rb +116 -0
  117. data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +1 -1
  118. data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +15 -17
  119. data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +1 -1
  120. data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +21 -18
  121. data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +1 -1
  122. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +18 -9
  123. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +1 -1
  124. data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +1 -1
  125. data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +4 -5
  126. data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +1 -1
  127. data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +1 -1
  128. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +15 -20
  129. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +1 -1
  130. data/lib/sketchup-api-stubs/stubs/Sketchup/Skp.rb +1 -1
  131. data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +1 -1
  132. data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +1 -1
  133. data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +1 -1
  134. data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +1 -1
  135. data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +1 -1
  136. data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +17 -20
  137. data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +1 -1
  138. data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +1 -1
  139. data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +1 -1
  140. data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +1 -1
  141. data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +30 -18
  142. data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +1 -1
  143. data/lib/sketchup-api-stubs/stubs/Sketchup.rb +48 -14
  144. data/lib/sketchup-api-stubs/stubs/SketchupExtension.rb +2 -2
  145. data/lib/sketchup-api-stubs/stubs/String.rb +1 -1
  146. data/lib/sketchup-api-stubs/stubs/UI/Command.rb +29 -31
  147. data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +18 -9
  148. data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +3 -3
  149. data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +5 -4
  150. data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +16 -18
  151. data/lib/sketchup-api-stubs/stubs/UI.rb +71 -26
  152. data/lib/sketchup-api-stubs/stubs/_top_level.rb +1 -9
  153. metadata +10 -7
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5ad52c5b1253285ccee275db5e8be23285f4da4f742d1cfd9a1e672146d43837
4
- data.tar.gz: a7ec17af28eee8481634d12cc7d93534ef2a6690b45132f3b049cd4ce293802f
3
+ metadata.gz: e21be664656202509a24f77478a6d8473e9bfe373096b38ccc3c7638da8af639
4
+ data.tar.gz: f22ccc1dbdc608c0fa2f6a3574877fde54091702a0615ee183286f1c61ac366a
5
5
  SHA512:
6
- metadata.gz: 3e678787da248d05eea3e3ed4868eb5a4e3642e886311d708d1cffcd9bab19f323dbf1e68537a437c66f245dfd2b37cd0abd4d69c0fca217675432fb6f1300bf
7
- data.tar.gz: f0e84d2aa1841311f9bcde3b1049314f2009ee16446df9d4d93b542928117bce1bd8a388056db05b437d143ea2ae4eb48f28f43cff6163f8d1d019ddea5b686e
6
+ metadata.gz: 39c0c18cfee2f04e82e8db0830df1c49d752d5b09a5cdcd020159e983537d23c9223a19a9676dfdc8f7fee5d371f7626fbe5e347a7c0065faf3f0c7090419c57
7
+ data.tar.gz: da7367e9bd3a35a9775de1ab2fb47e280f62c3186309f5667a8ae58798ba19b23bfe05039f7a799f02e9674f967fafff12f02e71d87e34f59d9bb30e2157a3b6
@@ -40,6 +40,7 @@ require 'sketchup-api-stubs/stubs/Layout/PageInfo.rb'
40
40
  require 'sketchup-api-stubs/stubs/Layout/Pages.rb'
41
41
  require 'sketchup-api-stubs/stubs/Layout/Path.rb'
42
42
  require 'sketchup-api-stubs/stubs/Layout/Rectangle.rb'
43
+ require 'sketchup-api-stubs/stubs/Layout/ReferenceEntity.rb'
43
44
  require 'sketchup-api-stubs/stubs/Layout/SketchUpModel.rb'
44
45
  require 'sketchup-api-stubs/stubs/Layout/Style.rb'
45
46
  require 'sketchup-api-stubs/stubs/Layout/Table.rb'
@@ -112,6 +113,8 @@ require 'sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb'
112
113
  require 'sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb'
113
114
  require 'sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb'
114
115
  require 'sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb'
116
+ require 'sketchup-api-stubs/stubs/Sketchup/Overlay.rb'
117
+ require 'sketchup-api-stubs/stubs/Sketchup/OverlaysManager.rb'
115
118
  require 'sketchup-api-stubs/stubs/Sketchup/Page.rb'
116
119
  require 'sketchup-api-stubs/stubs/Sketchup/Pages.rb'
117
120
  require 'sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb'
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # The SketchUp Array class adds additional methods to the standard Ruby Array
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # Bounding boxes are three-dimensional boxes (eight corners), aligned with the
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # The bounds2d class represents an axis aligned bounding box represented by
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # The LatLong class contains various methods for creating and manipulating
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # The OrientedBounds2d class is a bounding box represented by four
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # The {Geom::Point2d} class allows you to work with a point in 2D space.
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # The Point3d class allows you to work with a point in 3D space.
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # The {#Geom::PolygonMesh} class contains methods to create polygon mesh
@@ -130,22 +130,8 @@ class Geom::PolygonMesh
130
130
  # polygon_index = mesh.add_polygon([point1, point2, point3])
131
131
  # @param [Array<Geom::Point3d>] point3d_array
132
132
  #
133
- # @overload add_polygon(array)
134
- #
135
- # Adds a polygon from an Array of 3-element Arrays.
136
- # @example
137
- # pts = [[0, 0, 0], [1, 0, 0], [1, 1, 0], [0.5, 2, 0], [0, 1, 0]]
138
- # mesh = Geom::PolygonMesh.new
139
- # polygon_index = mesh.add_polygon(pts)
140
- # Sketchup.active_model.entities.add_faces_from_mesh(mesh)
141
- # @param [Array<Array(3)>] array
142
- # An array of arrays of length 3, where the inner arrays are used as if
143
- # they were Point3d objects.
144
- #
145
- # @return [Integer] The index of the polygon in the mesh.
146
- #
147
- # @return [0] Invalid index. Returned if the method failed to create a
148
- # polygon.
133
+ # @return [Integer] The 1-based index of the polygon in the mesh. +0+
134
+ # is returned if the method failed to create a polygon.
149
135
  #
150
136
  # @version SketchUp 6.0
151
137
  def add_polygon(*args)
@@ -362,7 +348,7 @@ class Geom::PolygonMesh
362
348
  # @example
363
349
  # polygons = polygonmesh.polygons
364
350
  #
365
- # @return [Array<Array<Integer>>, Array<nil>]
351
+ # @return [Array<Array<Integer>>]
366
352
  #
367
353
  # @version SketchUp 6.0
368
354
  def polygons
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # Transformations are a standard construct in the 3D world for representing
@@ -9,14 +9,14 @@
9
9
  #
10
10
  # Use of the transformation class requires a knowledge of geometrical
11
11
  # transformations in 3 dimensions which is covered extensively on
12
- # the Internet.
12
+ # the internet.
13
13
  #
14
14
  # @version SketchUp 6.0
15
15
  class Geom::Transformation
16
16
 
17
17
  # Class Methods
18
18
 
19
- # The axes method creates a transformation that goes from world coordinates
19
+ # The {.axes} method creates a transformation that goes from world coordinates
20
20
  # to an arbitrary coordinate system defined by an origin and three axis
21
21
  # vectors.
22
22
  #
@@ -49,11 +49,11 @@ class Geom::Transformation
49
49
  def self.axes(*args)
50
50
  end
51
51
 
52
- # The interpolate method is used to create a new transformation that is the
52
+ # The {.interpolate} method is used to create a new transformation that is the
53
53
  # result of interpolating between two other transformations.
54
54
  #
55
- # Parameter is a weight (between 0.0 and 1.0) that identifies whether to favor
56
- # transformation1 or transformation2.
55
+ # Parameter is a weight (between `0.0` and `1.0`) that identifies whether to favor
56
+ # `transformation1` or `transformation2`.
57
57
  #
58
58
  # @example
59
59
  # origin = Geom::Point3d.new(0, 0, 0)
@@ -79,7 +79,7 @@ class Geom::Transformation
79
79
  def self.interpolate(transform1, transform2, weight)
80
80
  end
81
81
 
82
- # The rotation method is used to create a transformation that does rotation
82
+ # The {.rotation} method is used to create a transformation that does rotation
83
83
  # about an axis.
84
84
  #
85
85
  # The axis is defined by a point and a vector. The angle is given in radians.
@@ -103,7 +103,7 @@ class Geom::Transformation
103
103
  def self.rotation(point, vector, angle)
104
104
  end
105
105
 
106
- # The scaling method is used to create a transformation that does scaling.
106
+ # The {.scaling} method is used to create a transformation that does scaling.
107
107
  #
108
108
  # @example
109
109
  # point = Geom::Point3d.new(20, 30, 0)
@@ -149,7 +149,7 @@ class Geom::Transformation
149
149
  def self.scaling(*args)
150
150
  end
151
151
 
152
- # The translation method is used to create a transformation that does
152
+ # The {.translation} method is used to create a transformation that does
153
153
  # translation.
154
154
  #
155
155
  # @example
@@ -198,18 +198,18 @@ class Geom::Transformation
198
198
  #
199
199
  # @overload *(point)
200
200
  #
201
- # @param [Array<Float, Float, Float>] point
202
- # @return [Array<Float, Float, Float>]
201
+ # @param [Array(Float, Float, Float)] point
202
+ # @return [Array(Float, Float, Float)]
203
203
  #
204
204
  # @overload *(plane)
205
205
  #
206
- # @param [Array<Geom::Point3d, Geom::Vector3d>] plane
207
- # @return [Array<Float, Float, Float, Float>] transformed plane
206
+ # @param [Array(Geom::Point3d, Geom::Vector3d)] plane
207
+ # @return [Array(Float, Float, Float, Float)] transformed plane
208
208
  #
209
209
  # @overload *(plane)
210
210
  #
211
- # @param [Array<Float, Float, Float, Float>] plane
212
- # @return [Array<Float, Float, Float, Float>] transformed plane
211
+ # @param [Array(Float, Float, Float, Float)] plane
212
+ # @return [Array(Float, Float, Float, Float)] transformed plane
213
213
  #
214
214
  # @version SketchUp 6.0
215
215
  def *(arg)
@@ -262,8 +262,6 @@ class Geom::Transformation
262
262
  def identity?
263
263
  end
264
264
 
265
- # The new method is used to create a new transformation.
266
- #
267
265
  # You can use this method or one of the more specific methods for creating
268
266
  # specific kinds of Transformations.
269
267
  #
@@ -273,7 +271,7 @@ class Geom::Transformation
273
271
  #
274
272
  # @overload initialize
275
273
  #
276
- # @return [Geom::Transformation] identity Transformation.
274
+ # @return [Geom::Transformation] identity transformation.
277
275
  #
278
276
  # @overload initialize(point)
279
277
  #
@@ -288,7 +286,7 @@ class Geom::Transformation
288
286
  #
289
287
  # @overload initialize(transform)
290
288
  #
291
- # Creates a Transformation that is a copy of another Transformation. This is
289
+ # Creates a transformation that is a copy of another transformation. This is
292
290
  # equivalent to {#clone}.
293
291
  # @param [Geom::Transformation] transform
294
292
  # @return [Geom::Transformation]
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  #
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # The UTM class lets you work with UTM map coordinates.
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # The {Geom::Vector2d} class represents vectors in a 2 dimensional space.
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # The Vector3d class is used to represent vectors in a 3 dimensional space.
@@ -58,7 +58,7 @@ class Geom::Vector3d
58
58
  # vector2 = Geom::Vector3d.new(0, 1, 0)
59
59
  # dot = vector1 % vector2
60
60
  #
61
- # @param [Geom::Vector] vector
61
+ # @param [Geom::Vector3d] vector
62
62
  #
63
63
  # @return [Float]
64
64
  #
@@ -291,7 +291,7 @@ class Geom::Vector3d
291
291
  # vector2 = Geom::Vector3d.new(0, 1, 0)
292
292
  # dot = vector1.dot(vector2)
293
293
  #
294
- # @param [Geom::Vector] vector
294
+ # @param [Geom::Vector3d] vector
295
295
  #
296
296
  # @return [Float]
297
297
  #
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # The Geom module defines a number of Module methods that let you perform
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # The LanguageHandler class contains methods used to help make SketchUp
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # References an angular dimension entity. An {Layout::AngularDimension} is
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # References an auto-text definition. Some auto-text definitions are mandatory.
@@ -40,6 +40,9 @@ class Layout::AutoTextDefinition
40
40
  NUMBER_STYLE_UC_ALPHA = nil # Stub value.
41
41
  NUMBER_STYLE_UC_ROMAN = nil # Stub value.
42
42
 
43
+ SEQUENCE_TYPE_PER_DOCUMENT = nil # Stub value.
44
+ SEQUENCE_TYPE_PER_PAGE = nil # Stub value.
45
+
43
46
  TYPE_CUSTOM_TEXT = nil # Stub value.
44
47
  TYPE_DATE_CREATED = nil # Stub value.
45
48
  TYPE_DATE_CURRENT = nil # Stub value.
@@ -553,6 +556,52 @@ class Layout::AutoTextDefinition
553
556
  def sequence_format=(sequence_format)
554
557
  end
555
558
 
559
+ # The {#sequence_type} method returns how the +Layout::AutoTextDefinition::TYPE_SEQUENCE+
560
+ # {Layout::AutoTextDefinition} operates over multiple pages in a document.
561
+ #
562
+ # The sequence type can be one of the following values:
563
+ # [+Layout::AutoTextDefinition::SEQUENCE_TYPE_PER_DOCUMENT+]
564
+ # [+Layout::AutoTextDefinition::SEQUENCE_TYPE_PER_PAGE+]
565
+ #
566
+ # @example
567
+ # doc = Layout::Document.open("C:/path/to/document.layout")
568
+ # sequence_def =
569
+ # doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
570
+ # type = sequence_def.sequence_type
571
+ #
572
+ # @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
573
+ # +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
574
+ #
575
+ # @return [Integer]
576
+ #
577
+ # @version LayOut 2023.0
578
+ def sequence_type
579
+ end
580
+
581
+ # The {#sequence_type=} method sets how the +Layout::AutoTextDefinition::TYPE_SEQUENCE+
582
+ # {Layout::AutoTextDefinition} operates over multiple pages in a document.
583
+ #
584
+ # The sequence type can be one of the following values:
585
+ # [+Layout::AutoTextDefinition::SEQUENCE_TYPE_PER_DOCUMENT+]
586
+ # [+Layout::AutoTextDefinition::SEQUENCE_TYPE_PER_PAGE+]
587
+ #
588
+ # @example
589
+ # doc = Layout::Document.open("C:/path/to/document.layout")
590
+ # sequence_def =
591
+ # doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
592
+ # sequence_def.sequence_type = Layout::AutoTextDefinition::SEQUENCE_TYPE_PER_PAGE
593
+ #
594
+ # @param [Integer] sequence_type
595
+ #
596
+ # @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
597
+ # +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
598
+ #
599
+ # @raise [ArgumentError] if sequence_type is not a valid sequence type
600
+ #
601
+ # @version LayOut 2023.0
602
+ def sequence_type=(sequence_type)
603
+ end
604
+
556
605
  # The {#start_index} method returns the start index for
557
606
  # +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
558
607
  # +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, and
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # The AutoTextDefinitions class is a container class for all
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # This is the interface to a LayOut Connection Point. A
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # This is the interface to a LayOut document. A {Layout::Document} is the 2D
@@ -48,6 +48,7 @@ class Layout::Document
48
48
  VERSION_2020 = nil # Stub value.
49
49
  VERSION_2021 = nil # Stub value.
50
50
  VERSION_2022 = nil # Stub value.
51
+ VERSION_2023 = nil # Stub value.
51
52
  VERSION_3 = nil # Stub value.
52
53
  VERSION_CURRENT = nil # Stub value.
53
54
 
@@ -163,7 +164,15 @@ class Layout::Document
163
164
  # # first page of a {Layout::Document} is index 0.
164
165
  # options = { start_page: 1,
165
166
  # end_page: 3,
166
- # output_resolution: Layout::PageInfo::RESOLUTION_HIGH,
167
+ # compress_images: TRUE,
168
+ # compress_quality: 0.75 }
169
+ #
170
+ # status = doc.export("c:/my_export.pdf", options)
171
+ #
172
+ # # Export pages one and three through five. Note that page_range starts at
173
+ # # index 1.
174
+ # # `page_range` support added in LayOut 2024.0.
175
+ # options = { page_range: "1,3-5",
167
176
  # compress_images: TRUE,
168
177
  # compress_quality: 0.75 }
169
178
  #
@@ -173,7 +182,7 @@ class Layout::Document
173
182
  # doc = Layout::Document.open("c:/path/to/document.layout")
174
183
  #
175
184
  # # Export png files on macOS, with default settings.
176
- # status = doc.export('/Users/username/Desktop/pngs/page.png')
185
+ # status = doc.export("/Users/<username>/Desktop/pngs/page.png")
177
186
  #
178
187
  # # Export pages one through three at 300 dpi as JPGs.
179
188
  # options = { start_page: 1,
@@ -181,6 +190,15 @@ class Layout::Document
181
190
  # dpi: 300 }
182
191
  # status = doc.export('c:/page.jpg', options)
183
192
  #
193
+ # # Export pages one and three through five. Note that page_range starts at
194
+ # # index 1.
195
+ # # `page_range` support added in LayOut 2024.0.
196
+ # options = { page_range: "1,3-5",
197
+ # compress_images: TRUE,
198
+ # compress_quality: 0.75 }
199
+ #
200
+ # status = doc.export("c:/my_export.png", options)
201
+ #
184
202
  # @param [String] file_path
185
203
  # The file or image set to create. The directory
186
204
  # path must already exist. The path must include the file extension.
@@ -397,6 +415,41 @@ class Layout::Document
397
415
  def remove_entity(entity)
398
416
  end
399
417
 
418
+ # The {#render_mode_override} method returns the override setting for output render modes
419
+ # of {Layout::SketchUpModel}s in the {Layout::Document}.
420
+ #
421
+ # @example
422
+ # doc = Layout::Document.open("C:/path/to/document.layout")
423
+ # render_mode = doc.render_mode_override
424
+ #
425
+ # @return [Integer]
426
+ #
427
+ # @version LayOut 2023.1
428
+ def render_mode_override
429
+ end
430
+
431
+ # The {#render_mode_override=} method sets the override setting for output render modes
432
+ # of {Layout::SketchUpModel}s in the {Layout::Document}. Setting this to +NO_OVERRIDE+
433
+ # will prevent overriding the individual {Layout::SketchUpModel} render mode setting during
434
+ # export. This override will only affect raster rendered {Layout::SketchUpModel}s, if a
435
+ # viewport is set to vector or hybrid, it will retain that render mode as its output render
436
+ # mode.
437
+ #
438
+ # @example
439
+ # doc = Layout::Document.open("C:/path/to/document.layout")
440
+ # doc.render_mode_override = Layout::SketchUpModel::VECTOR_RENDER
441
+ #
442
+ # @param [Integer] render_mode
443
+ # +NO_OVERRIDE+, +VECTOR_RENDER+, or +HYBRID_RENDER+
444
+ #
445
+ # @raise [ArgumentError] if render_mode is not a valid render mode
446
+ #
447
+ # @raise [ArgumentError] if render_mode is +RASTER_RENDER+
448
+ #
449
+ # @version LayOut 2023.1
450
+ def render_mode_override=(render_mode)
451
+ end
452
+
400
453
  # The {#save} method saves the {Layout::Document} to a file at the given path.
401
454
  # Passing an empty path string will save the {Layout::Document} at its current
402
455
  # path.
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # A simple elliptical shape entity.
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # The Entities class is a container class for {Layout::Entity}s. A
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # An entity is an object shown on a page of a LayOut document.
@@ -175,6 +175,9 @@ class Layout::Entity
175
175
  # {Layout::Entity} must belong to the same {Layout::Document} as the the
176
176
  # {Layout::Layer} and the {Layout::Page}s.
177
177
  #
178
+ # @bug In LayOut versions prior to LayOut 2024.0 this method would fail to move
179
+ # entities from non-shared layers.
180
+ #
178
181
  # @example
179
182
  # doc = Layout::Document.open("C:/path/to/document.layout")
180
183
  # entities = doc.pages.first.entities
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # A formatted text entity.
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # Class that references a {Layout::Document}'s grid settings.
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # A group is a special type of {Layout::Entity} that does not belong to a
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # A raster image entity.
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # This is an interface to a label entity. A {Layout::Label} consists of a
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # This is the interface to a LayOut Layer Definition. A layer definition
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # References an instance of a {Layout::Layer}. A {Layout::LayerInstance}
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # The Layers class is a container class for all layers in a {Layout::Document}.
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # References a linear dimension entity. A {Layout::LinearDimension} is composed
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # This is raised whenever a method attempts to modify any {Layout::Entity}
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # This is raised whenever a method attempts to modify any {Layout::Entity}
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2022 Trimble Inc.
1
+ # Copyright:: Copyright 2024 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # Class for a single page in a LayOut document.