scriptup 2026.0.0 → 2026.0.1

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 (133) hide show
  1. checksums.yaml +4 -4
  2. data/ext/entity.c +3 -0
  3. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Frameworks/libCommonGeometry.dylib +0 -0
  4. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/{Libraries → Frameworks}/libCommonGeoutils.dylib +0 -0
  5. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/{Libraries → Frameworks}/libCommonImage.dylib +0 -0
  6. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Frameworks/libCommonPreferences.dylib +0 -0
  7. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Frameworks/libCommonUnits.dylib +0 -0
  8. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Frameworks/libCommonUtils.dylib +0 -0
  9. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Frameworks/libCommonZip.dylib +0 -0
  10. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/application/model.h +4 -4
  11. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/application/overlay.h +20 -6
  12. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/common.h +9 -9
  13. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/extension_license.h +9 -1
  14. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/geometry/point2d.h +2 -2
  15. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/geometry/point3d.h +2 -2
  16. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/geometry/transformation2d.h +3 -3
  17. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/geometry/vector2d.h +5 -5
  18. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/geometry/vector3d.h +4 -4
  19. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/geometry.h +9 -7
  20. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/import_export/modelimporterplugin.h +8 -4
  21. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/attribute_dictionary.h +4 -4
  22. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/component_definition.h +74 -33
  23. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/component_definition_snap_to_behavior_private.h +46 -0
  24. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/component_instance.h +11 -11
  25. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/curve.h +4 -4
  26. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/defs.h +7 -2
  27. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/dimension.h +2 -0
  28. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/drawing_element.h +11 -11
  29. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/edge.h +7 -7
  30. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/entities.h +106 -61
  31. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/entity.h +7 -4
  32. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/environment.h +382 -0
  33. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/environments.h +133 -0
  34. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/face.h +43 -27
  35. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/geometry_input.h +126 -116
  36. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/group.h +9 -8
  37. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/image.h +6 -5
  38. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/layer.h +3 -3
  39. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/material.h +432 -25
  40. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/model.h +263 -100
  41. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/model_entity_type_private.h +44 -0
  42. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/rendering_options.h +82 -81
  43. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/scene.h +222 -42
  44. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/snap.h +183 -0
  45. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/space.h +26 -0
  46. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/styles.h +29 -27
  47. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/text.h +14 -6
  48. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/texture.h +23 -1
  49. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/typed_value.h +26 -26
  50. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/vertex.h +2 -2
  51. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/sketchup.h +4 -1
  52. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/unicodestring.h +7 -7
  53. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Resources/Info.plist +8 -8
  54. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/SketchUpAPI +0 -0
  55. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/_CodeSignature/CodeResources +144 -88
  56. data/sketchup-sdk-win/binaries/layout/x64/LayOutAPI.dll +0 -0
  57. data/sketchup-sdk-win/binaries/layout/x64/LayOutAPI.lib +0 -0
  58. data/sketchup-sdk-win/binaries/layout/x64/LayOutControllers.dll +0 -0
  59. data/sketchup-sdk-win/binaries/layout/x64/LayOutModel.dll +0 -0
  60. data/sketchup-sdk-win/binaries/layout/x64/LayOutRTF.dll +0 -0
  61. data/sketchup-sdk-win/binaries/layout/x64/LayOutUtils.dll +0 -0
  62. data/sketchup-sdk-win/binaries/layout/x64/LayOutView.dll +0 -0
  63. data/sketchup-sdk-win/binaries/layout/x64/SketchUpCommonPreferences.dll +0 -0
  64. data/sketchup-sdk-win/binaries/layout/x64/SketchUpViewerAPI.dll +0 -0
  65. data/sketchup-sdk-win/binaries/layout/x64/SketchUpViewerAPI.lib +0 -0
  66. data/sketchup-sdk-win/binaries/layout/x64/pdflib.dll +0 -0
  67. data/sketchup-sdk-win/binaries/sketchup/x64/SketchUpAPI.dll +0 -0
  68. data/sketchup-sdk-win/binaries/sketchup/x64/SketchUpAPI.lib +0 -0
  69. data/sketchup-sdk-win/binaries/sketchup/x64/SketchUpCommonPreferences.dll +0 -0
  70. data/sketchup-sdk-win/binaries/sketchup/x64/sketchup.lib +0 -0
  71. data/sketchup-sdk-win/headers/LayOutAPI/application/application.h +14 -14
  72. data/sketchup-sdk-win/headers/LayOutAPI/layout.h +1 -1
  73. data/sketchup-sdk-win/headers/LayOutAPI/model/dictionary.h +1 -1
  74. data/sketchup-sdk-win/headers/LayOutAPI/model/document.h +73 -0
  75. data/sketchup-sdk-win/headers/LayOutAPI/model/documentexportoptions.h +21 -2
  76. data/sketchup-sdk-win/headers/LayOutAPI/model/entity.h +72 -0
  77. data/sketchup-sdk-win/headers/LayOutAPI/model/group.h +2 -1
  78. data/sketchup-sdk-win/headers/LayOutAPI/model/lineardimension.h +54 -2
  79. data/sketchup-sdk-win/headers/LayOutAPI/model/page.h +70 -0
  80. data/sketchup-sdk-win/headers/LayOutAPI/model/sketchupmodel.h +58 -1
  81. data/sketchup-sdk-win/headers/LayOutAPI/model/style.h +39 -3
  82. data/sketchup-sdk-win/headers/LayOutAPI/model/table.h +2 -0
  83. data/sketchup-sdk-win/headers/LayOutAPI/model/typed_value.h +25 -1
  84. data/sketchup-sdk-win/headers/SketchUpAPI/application/model.h +4 -4
  85. data/sketchup-sdk-win/headers/SketchUpAPI/application/overlay.h +20 -6
  86. data/sketchup-sdk-win/headers/SketchUpAPI/common.h +9 -9
  87. data/sketchup-sdk-win/headers/SketchUpAPI/extension_license.h +9 -1
  88. data/sketchup-sdk-win/headers/SketchUpAPI/geometry/point2d.h +2 -2
  89. data/sketchup-sdk-win/headers/SketchUpAPI/geometry/point3d.h +2 -2
  90. data/sketchup-sdk-win/headers/SketchUpAPI/geometry/transformation2d.h +3 -3
  91. data/sketchup-sdk-win/headers/SketchUpAPI/geometry/vector2d.h +5 -5
  92. data/sketchup-sdk-win/headers/SketchUpAPI/geometry/vector3d.h +4 -4
  93. data/sketchup-sdk-win/headers/SketchUpAPI/geometry.h +9 -7
  94. data/sketchup-sdk-win/headers/SketchUpAPI/import_export/modelimporterplugin.h +8 -4
  95. data/sketchup-sdk-win/headers/SketchUpAPI/model/attribute_dictionary.h +4 -4
  96. data/sketchup-sdk-win/headers/SketchUpAPI/model/component_definition.h +74 -33
  97. data/sketchup-sdk-win/headers/SketchUpAPI/model/component_definition_snap_to_behavior_private.h +46 -0
  98. data/sketchup-sdk-win/headers/SketchUpAPI/model/component_instance.h +11 -11
  99. data/sketchup-sdk-win/headers/SketchUpAPI/model/curve.h +4 -4
  100. data/sketchup-sdk-win/headers/SketchUpAPI/model/defs.h +7 -2
  101. data/sketchup-sdk-win/headers/SketchUpAPI/model/dimension.h +2 -0
  102. data/sketchup-sdk-win/headers/SketchUpAPI/model/drawing_element.h +11 -11
  103. data/sketchup-sdk-win/headers/SketchUpAPI/model/edge.h +7 -7
  104. data/sketchup-sdk-win/headers/SketchUpAPI/model/entities.h +106 -61
  105. data/sketchup-sdk-win/headers/SketchUpAPI/model/entity.h +7 -4
  106. data/sketchup-sdk-win/headers/SketchUpAPI/model/environment.h +382 -0
  107. data/sketchup-sdk-win/headers/SketchUpAPI/model/environments.h +133 -0
  108. data/sketchup-sdk-win/headers/SketchUpAPI/model/face.h +43 -27
  109. data/sketchup-sdk-win/headers/SketchUpAPI/model/geometry_input.h +126 -116
  110. data/sketchup-sdk-win/headers/SketchUpAPI/model/group.h +9 -8
  111. data/sketchup-sdk-win/headers/SketchUpAPI/model/image.h +6 -5
  112. data/sketchup-sdk-win/headers/SketchUpAPI/model/layer.h +3 -3
  113. data/sketchup-sdk-win/headers/SketchUpAPI/model/material.h +432 -25
  114. data/sketchup-sdk-win/headers/SketchUpAPI/model/model.h +263 -100
  115. data/sketchup-sdk-win/headers/SketchUpAPI/model/model_entity_type_private.h +44 -0
  116. data/sketchup-sdk-win/headers/SketchUpAPI/model/rendering_options.h +82 -81
  117. data/sketchup-sdk-win/headers/SketchUpAPI/model/scene.h +222 -42
  118. data/sketchup-sdk-win/headers/SketchUpAPI/model/snap.h +183 -0
  119. data/sketchup-sdk-win/headers/SketchUpAPI/model/space.h +26 -0
  120. data/sketchup-sdk-win/headers/SketchUpAPI/model/styles.h +29 -27
  121. data/sketchup-sdk-win/headers/SketchUpAPI/model/text.h +14 -6
  122. data/sketchup-sdk-win/headers/SketchUpAPI/model/texture.h +23 -1
  123. data/sketchup-sdk-win/headers/SketchUpAPI/model/typed_value.h +26 -26
  124. data/sketchup-sdk-win/headers/SketchUpAPI/model/vertex.h +2 -2
  125. data/sketchup-sdk-win/headers/SketchUpAPI/sketchup.h +4 -1
  126. data/sketchup-sdk-win/headers/SketchUpAPI/unicodestring.h +7 -7
  127. metadata +22 -10
  128. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Libraries/libCommonGeometry.dylib +0 -0
  129. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Libraries/libCommonPreferences.dylib +0 -0
  130. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Libraries/libCommonUnits.dylib +0 -0
  131. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Libraries/libCommonUtils.dylib +0 -0
  132. data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Libraries/libCommonZip.dylib +0 -0
  133. data/sketchup-sdk-win/headers/LayOutAPI/model/skpfilereference.h +0 -94
@@ -102,7 +102,7 @@ SU_RESULT SUGeometryInputCreate(SUGeometryInputRef* geom_input);
102
102
 
103
103
  /**
104
104
  @brief Deallocates a geometry input object.
105
- @param[in] geom_input The object to deallocate.
105
+ @param[in,out] geom_input The object to deallocate.
106
106
  @related SUGeometryInputRef
107
107
  @return
108
108
  - \ref SU_ERROR_NONE on success
@@ -113,8 +113,8 @@ SU_RESULT SUGeometryInputRelease(SUGeometryInputRef* geom_input);
113
113
 
114
114
  /**
115
115
  @brief Adds a vertex to a geometry input object.
116
- @param[in] geom_input The geometry input object.
117
- @param[in] point The location of the vertex to be added.
116
+ @param[in,out] geom_input The geometry input object.
117
+ @param[in] point The location of the vertex to be added.
118
118
  @related SUGeometryInputRef
119
119
  @return
120
120
  - \ref SU_ERROR_NONE on success
@@ -126,9 +126,9 @@ SU_RESULT SUGeometryInputAddVertex(SUGeometryInputRef geom_input, const struct S
126
126
  /**
127
127
  @brief Sets all vertices of a geometry input object. Any existing vertices will
128
128
  be overridden.
129
- @param[in] geom_input The geometry input object.
130
- @param[in] num_vertices The number of vertices in the given point array.
131
- @param[in] points The points array containing the location of vertices.
129
+ @param[in,out] geom_input The geometry input object.
130
+ @param[in] num_vertices The number of vertices in the given point array.
131
+ @param[in] points The points array containing the location of vertices.
132
132
  @related SUGeometryInputRef
133
133
  @return
134
134
  - \ref SU_ERROR_NONE on success
@@ -143,11 +143,11 @@ SU_RESULT SUGeometryInputSetVertices(
143
143
  specifying edges which are not associated with loop inputs. For
144
144
  specifying edge properties on a face use the SULoopInput interface.
145
145
  @since SketchUp 2017, API 5.0
146
- @param[in] geom_input The geometry input object.
147
- @param[in] vertex0_index The vertex index of the edge's first vertex.
148
- @param[in] vertex1_index The vertex index of the edge's last vertex.
149
- @param[out] added_edge_index (optional) If not NULL, returns the index of the
150
- added edge.
146
+ @param[in,out] geom_input The geometry input object.
147
+ @param[in] vertex0_index The vertex index of the edge's first vertex.
148
+ @param[in] vertex1_index The vertex index of the edge's last vertex.
149
+ @param[out] added_edge_index (optional) If not NULL, returns the index of the
150
+ added edge.
151
151
  @related SUGeometryInputRef
152
152
  @return
153
153
  - \ref SU_ERROR_NONE on success
@@ -164,10 +164,10 @@ SU_RESULT SUGeometryInputAddEdge(
164
164
  @brief Sets the hidden flag of an edge in a geometry input object which is not
165
165
  associated with a loop input.
166
166
  @since SketchUp 2017, API 5.0
167
- @param[in] geom_input The geometry input object.
168
- @param[in] edge_index The zero-based index of the edge which is not associated
169
- with a loop input.
170
- @param[in] hidden The flag to set.
167
+ @param[in,out] geom_input The geometry input object.
168
+ @param[in] edge_index The zero-based index of the edge which is not associated
169
+ with a loop input.
170
+ @param[in] hidden The flag to set.
171
171
  @related SUGeometryInputRef
172
172
  @return
173
173
  - \ref SU_ERROR_NONE on success
@@ -182,10 +182,10 @@ SU_RESULT SUGeometryInputEdgeSetHidden(
182
182
  @brief Sets the soft flag of an edge in a geometry input object which is not
183
183
  associated with a loop input.
184
184
  @since SketchUp 2017, API 5.0
185
- @param[in] geom_input The geometry input object.
186
- @param[in] edge_index The zero-based index of the edge which is not associated
187
- with a loop input.
188
- @param[in] soft The flag to set.
185
+ @param[in,out] geom_input The geometry input object.
186
+ @param[in] edge_index The zero-based index of the edge which is not associated
187
+ with a loop input.
188
+ @param[in] soft The flag to set.
189
189
  @related SUGeometryInputRef
190
190
  @return
191
191
  - \ref SU_ERROR_NONE on success
@@ -199,10 +199,10 @@ SU_RESULT SUGeometryInputEdgeSetSoft(SUGeometryInputRef geom_input, size_t edge_
199
199
  @brief Sets the smooth flag of an edge in a geometry input object which is not
200
200
  associated with a loop input.
201
201
  @since SketchUp 2017, API 5.0
202
- @param[in] geom_input The geometry input object.
203
- @param[in] edge_index The zero-based index of the edge which is not associated
204
- with a loop input.
205
- @param[in] smooth The flag to set.
202
+ @param[in,out] geom_input The geometry input object.
203
+ @param[in] edge_index The zero-based index of the edge which is not associated
204
+ with a loop input.
205
+ @param[in] smooth The flag to set.
206
206
  @related SUGeometryInputRef
207
207
  @return
208
208
  - \ref SU_ERROR_NONE on success
@@ -216,9 +216,9 @@ SU_RESULT SUGeometryInputEdgeSetSmooth(
216
216
  /**
217
217
  @brief Sets the material of an edge in the geometry input.
218
218
  @since SketchUp 2017, API 5.0
219
- @param[in] geom_input The geometry input object.
220
- @param[in] edge_index Index of the edge to set the material.
221
- @param[in] material The material to be set.
219
+ @param[in,out] geom_input The geometry input object.
220
+ @param[in] edge_index Index of the edge to set the material.
221
+ @param[in] material The material to be set.
222
222
  @related SUGeometryInputRef
223
223
  @return
224
224
  - \ref SU_ERROR_NONE on success
@@ -233,9 +233,9 @@ SU_RESULT SUGeometryInputEdgeSetMaterial(
233
233
  /**
234
234
  @brief Sets the layer of an edge in the geometry input.
235
235
  @since SketchUp 2017, API 5.0
236
- @param[in] geom_input The geometry input object.
237
- @param[in] edge_index Index of the edge to set the layer.
238
- @param[in] layer The layer to be set.
236
+ @param[in,out] geom_input The geometry input object.
237
+ @param[in] edge_index Index of the edge to set the layer.
238
+ @param[in] layer The layer to be set.
239
239
  @related SUGeometryInputRef
240
240
  @return
241
241
  - \ref SU_ERROR_NONE on success
@@ -251,11 +251,11 @@ SU_RESULT SUGeometryInputEdgeSetLayer(
251
251
  specifying curves which are not associated with loop inputs. For
252
252
  specifying curves on faces use the SULoopInput interface.
253
253
  @since SketchUp 2017, API 5.0
254
- @param[in] geom_input The geometry input object.
255
- @param[in] num_edges The number of edges to be used in the curve.
256
- @param[in] edge_indices The edge indices to be used in defining the curve.
257
- @param[out] added_curve_index (optional) If not NULL, returns the index of the
258
- added curve.
254
+ @param[in,out] geom_input The geometry input object.
255
+ @param[in] num_edges The number of edges to be used in the curve.
256
+ @param[in] edge_indices The edge indices to be used in defining the curve.
257
+ @param[out] added_curve_index (optional) If not NULL, returns the index of the
258
+ added curve.
259
259
  @related SUGeometryInputRef
260
260
  @return
261
261
  - \ref SU_ERROR_NONE on success
@@ -275,19 +275,19 @@ SU_RESULT SUGeometryInputAddCurve(
275
275
  of the first new edge. Also, num_segments-1 vertices along the arc will
276
276
  be appended to the geometry's collection of verttices. In order to
277
277
  include an arccurve in a loop the user only needs add the arccurve's
278
- points to a loop using \ref SULoopInputAddVertexIndex().
278
+ points to a loop using SULoopInputAddVertexIndex().
279
279
  @since SketchUp 2017 M2, API 5.2
280
- @param[in] geom_input The geometry input object.
281
- @param[in] start_point The index of the vertex at the start of the arc.
282
- @param[in] end_point The index of the vertex at the end of the arc.
283
- @param[in] center The center point of the arc's circle.
284
- @param[in] normal The normal vector of the arc plane.
285
- @param[in] num_segments The number of edges for the arc.
286
- @param[out] added_curve_index (optional) If not NULL, returns the index of the
287
- added curve.
288
- @param[out] control_edge_index (optional) If not NULL, returns the index of the
289
- the arc's control edge which can be used to set
290
- the arc's edge properties.
280
+ @param[in,out] geom_input The geometry input object.
281
+ @param[in] start_point The index of the vertex at the start of the arc.
282
+ @param[in] end_point The index of the vertex at the end of the arc.
283
+ @param[in] center The center point of the arc's circle.
284
+ @param[in] normal The normal vector of the arc plane.
285
+ @param[in] num_segments The number of edges for the arc.
286
+ @param[out] added_curve_index (optional) If not NULL, returns the index of the
287
+ added curve.
288
+ @param[out] control_edge_index (optional) If not NULL, returns the index of the
289
+ the arc's control edge which can be used to set
290
+ the arc's edge properties.
291
291
  @related SUGeometryInputRef
292
292
  @return
293
293
  - \ref SU_ERROR_NONE on success
@@ -305,7 +305,8 @@ SU_RESULT SUGeometryInputAddArcCurve(
305
305
  /**
306
306
  @brief Creates a loop input object.
307
307
  @param[out] loop_input The object created.
308
- @related SUGeometryInputRef
308
+ @related SULoopInputRef
309
+ @see SUGeometryInputRef
309
310
  @return
310
311
  - \ref SU_ERROR_NONE on success
311
312
  - \ref SU_ERROR_NULL_POINTER_OUTPUT if loop_input is NULL
@@ -315,8 +316,9 @@ SU_RESULT SULoopInputCreate(SULoopInputRef* loop_input);
315
316
 
316
317
  /**
317
318
  @brief Deallocates a loop input object.
318
- @param[in] loop_input The object to deallocate.
319
- @related SUGeometryInputRef
319
+ @param[in,out] loop_input The object to deallocate.
320
+ @related SULoopInputRef
321
+ @see SUGeometryInputRef
320
322
  @return
321
323
  - \ref SU_ERROR_NONE on success
322
324
  - \ref SU_ERROR_NULL_POINTER_INPUT if loop_input is NULL
@@ -334,19 +336,20 @@ SU_RESULT SULoopInputRelease(SULoopInputRef* loop_input);
334
336
  loop was introduced. A loop can be explicitly closed by either using
335
337
  this method to insert an index which is already at the beginning of the
336
338
  loop, or by adding a curve to the loop which connects the loop's start
337
- and end points using \ref SULoopInputAddCurve(). If a loop was not
338
- previously closed and \ref SULoopInputAddVertexIndex() is used to add
339
+ and end points using SULoopInputAddCurve(). If a loop was not
340
+ previously closed and SULoopInputAddVertexIndex() is used to add
339
341
  the loop's start vertex, the loop will be closed and \ref SU_ERROR_NONE
340
342
  will be returned. If attempts are made to add vertices after a loop has
341
343
  been explicitly closed \ref SU_ERROR_UNSUPPORTED will be returned. If
342
344
  an attempt is made to add a vertex that already existed in an open loop
343
345
  not at the front \ref SU_ERROR_INVALID_ARGUMENT will be returned.
344
346
 
345
- @param[in] loop_input The loop input object.
346
- @param[in] vertex_index The vertex index to add. This references a vertex within
347
- the parent geometry input's vertex collection (as a
348
- zero- based index).
349
- @related SUGeometryInputRef
347
+ @param[in,out] loop_input The loop input object.
348
+ @param[in] vertex_index The vertex index to add. This references a vertex within
349
+ the parent geometry input's vertex collection (as a
350
+ zero- based index).
351
+ @related SULoopInputRef
352
+ @see SUGeometryInputRef
350
353
  @return
351
354
  - \ref SU_ERROR_NONE on success
352
355
  - \ref SU_ERROR_INVALID_INPUT if loop_input is not valid
@@ -358,10 +361,11 @@ SU_RESULT SULoopInputAddVertexIndex(SULoopInputRef loop_input, size_t vertex_ind
358
361
 
359
362
  /**
360
363
  @brief Sets the hidden flag of an edge in a loop input object.
361
- @param[in] loop_input The loop input object.
362
- @param[in] edge_index The zero-based index of the edge within the loop.
363
- @param[in] hidden The flag to set.
364
- @related SUGeometryInputRef
364
+ @param[in,out] loop_input The loop input object.
365
+ @param[in] edge_index The zero-based index of the edge within the loop.
366
+ @param[in] hidden The flag to set.
367
+ @related SULoopInputRef
368
+ @see SUGeometryInputRef
365
369
  @return
366
370
  - \ref SU_ERROR_NONE on success
367
371
  - \ref SU_ERROR_INVALID_INPUT if loop_input is not valid
@@ -372,10 +376,11 @@ SU_RESULT SULoopInputEdgeSetHidden(SULoopInputRef loop_input, size_t edge_index,
372
376
 
373
377
  /**
374
378
  @brief Sets the soft flag of an edge in a loop input object.
375
- @param[in] loop_input The loop input object.
376
- @param[in] edge_index The zero-based index of the edge within the loop.
377
- @param[in] soft The flag to set.
378
- @related SUGeometryInputRef
379
+ @param[in,out] loop_input The loop input object.
380
+ @param[in] edge_index The zero-based index of the edge within the loop.
381
+ @param[in] soft The flag to set.
382
+ @related SULoopInputRef
383
+ @see SUGeometryInputRef
379
384
  @return
380
385
  - \ref SU_ERROR_NONE on success
381
386
  - \ref SU_ERROR_INVALID_INPUT if loop_input is not valid
@@ -386,10 +391,11 @@ SU_RESULT SULoopInputEdgeSetSoft(SULoopInputRef loop_input, size_t edge_index, b
386
391
 
387
392
  /**
388
393
  @brief Sets the smooth flag of an edge in a loop input object.
389
- @param[in] loop_input The loop input object.
390
- @param[in] edge_index The zero-based index of the edge within the loop.
391
- @param[in] smooth The flag to set.
392
- @related SUGeometryInputRef
394
+ @param[in,out] loop_input The loop input object.
395
+ @param[in] edge_index The zero-based index of the edge within the loop.
396
+ @param[in] smooth The flag to set.
397
+ @related SULoopInputRef
398
+ @see SUGeometryInputRef
393
399
  @return
394
400
  - \ref SU_ERROR_NONE on success
395
401
  - \ref SU_ERROR_INVALID_INPUT if loop_input is not valid
@@ -401,10 +407,11 @@ SU_RESULT SULoopInputEdgeSetSmooth(SULoopInputRef loop_input, size_t edge_index,
401
407
  /**
402
408
  @brief Sets the material of an edge in the loop input.
403
409
  @since SketchUp 2017, API 5.0
404
- @param[in] loop_input The loop input object.
405
- @param[in] edge_index Index of the edge to set the material.
406
- @param[in] material The material to be set.
407
- @related SUGeometryInputRef
410
+ @param[in,out] loop_input The loop input object.
411
+ @param[in] edge_index Index of the edge to set the material.
412
+ @param[in] material The material to be set.
413
+ @related SULoopInputRef
414
+ @see SUGeometryInputRef
408
415
  @return
409
416
  - \ref SU_ERROR_NONE on success
410
417
  - \ref SU_ERROR_INVALID_INPUT if loop_input or material is not valid
@@ -418,10 +425,11 @@ SU_RESULT SULoopInputEdgeSetMaterial(
418
425
  /**
419
426
  @brief Sets the layer of an edge in the loop input.
420
427
  @since SketchUp 2017, API 5.0
421
- @param[in] loop_input The loop input object.
422
- @param[in] edge_index Index of the edge to set the layer.
423
- @param[in] layer The layer to be set.
424
- @related SUGeometryInputRef
428
+ @param[in,out] loop_input The loop input object.
429
+ @param[in] edge_index Index of the edge to set the layer.
430
+ @param[in] layer The layer to be set.
431
+ @related SULoopInputRef
432
+ @see SUGeometryInputRef
425
433
  @return
426
434
  - \ref SU_ERROR_NONE on success
427
435
  - \ref SU_ERROR_INVALID_INPUT if loop_input or layer is not valid
@@ -432,10 +440,11 @@ SU_RESULT SULoopInputEdgeSetLayer(SULoopInputRef loop_input, size_t edge_index,
432
440
 
433
441
  /**
434
442
  @brief Adds a simple curve to a loop input object.
435
- @param[in] loop_input The loop input object.
436
- @param[in] first_edge_index First edge index to be associated with the curve.
437
- @param[in] last_edge_index Last edge index to be associated with the curve.
438
- @related SUGeometryInputRef
443
+ @param[in,out] loop_input The loop input object.
444
+ @param[in] first_edge_index First edge index to be associated with the curve.
445
+ @param[in] last_edge_index Last edge index to be associated with the curve.
446
+ @related SULoopInputRef
447
+ @see SUGeometryInputRef
439
448
  @return
440
449
  - \ref SU_ERROR_NONE on success
441
450
  - \ref SU_ERROR_INVALID_INPUT if loop_input is not valid
@@ -447,13 +456,14 @@ SU_RESULT SULoopInputAddCurve(
447
456
 
448
457
  /**
449
458
  @brief Retrieves whether the loop input is closed. A loop input can be closed
450
- either by re-adding the start vertex to the end of the loop using \ref
451
- SULoopInputAddVertexIndex or by adding a curve to the loop input which
452
- connects the loop's start and end points using \ref SULoopInputAddCurve().
459
+ either by re-adding the start vertex to the end of the loop using
460
+ SULoopInputAddVertexIndex() or by adding a curve to the loop input which
461
+ connects the loop's start and end points using SULoopInputAddCurve().
453
462
  @since SketchUp 2017 M2, API 5.2
454
463
  @param[in] loop_input The loop input object.
455
464
  @param[out] is_closed The flag retrieved (true if the loop is closed).
456
- @related SUGeometryInputRef
465
+ @related SULoopInputRef
466
+ @see SUGeometryInputRef
457
467
  @return
458
468
  - \ref SU_ERROR_NONE on success
459
469
  - \ref SU_ERROR_INVALID_INPUT if loop_input is not valid
@@ -471,12 +481,12 @@ SU_RESULT SULoopInputIsClosed(SULoopInputRef loop_input, bool* is_closed);
471
481
  SU_ERROR_INVALID_ARGUMENT) to indicate to users when the loop contains
472
482
  invalid data.
473
483
 
474
- @param[in] geom_input The geometry input object.
475
- @param[in] outer_loop The outer loop to be set for the face. If the
476
- function succeeds (i.e. returns SU_ERROR_NONE),
477
- this loop will be deallocated.
478
- @param[out] added_face_index (optional) If not NULL, returns the index of the
479
- added face.
484
+ @param[in,out] geom_input The geometry input object.
485
+ @param[in,out] outer_loop The outer loop to be set for the face. If the
486
+ function succeeds (i.e. returns \ref SU_ERROR_NONE),
487
+ this loop will be deallocated.
488
+ @param[out] added_face_index (optional) If not NULL, returns the index of the
489
+ added face.
480
490
  @related SUGeometryInputRef
481
491
  @return
482
492
  - \ref SU_ERROR_NONE on success
@@ -490,9 +500,9 @@ SU_RESULT SUGeometryInputAddFace(
490
500
  /**
491
501
  @brief Sets a flag in the geometry input that, when true, will create a face by
492
502
  reversing the orientations of all of its loops.
493
- @param[in] geom_input The geometry input object.
494
- @param[in] face_index Index of the face to be reversed.
495
- @param[in] reverse The given reverse flag.
503
+ @param[in,out] geom_input The geometry input object.
504
+ @param[in] face_index Index of the face to be reversed.
505
+ @param[in] reverse The given reverse flag.
496
506
  @related SUGeometryInputRef
497
507
  @return
498
508
  - \ref SU_ERROR_NONE on success
@@ -505,9 +515,9 @@ SU_RESULT SUGeometryInputFaceSetReverse(
505
515
 
506
516
  /**
507
517
  @brief Sets the layer of a face in the geometry input.
508
- @param[in] geom_input The geometry input object.
509
- @param[in] face_index Index of the face to be reversed.
510
- @param[in] layer The layer to be set.
518
+ @param[in,out] geom_input The geometry input object.
519
+ @param[in] face_index Index of the face to be reversed.
520
+ @param[in] layer The layer to be set.
511
521
  @related SUGeometryInputRef
512
522
  @return
513
523
  - \ref SU_ERROR_NONE on success
@@ -526,11 +536,11 @@ SU_RESULT SUGeometryInputFaceSetLayer(
526
536
  SU_ERROR_INVALID_ARGUMENT) to indicate to users when the loop contains
527
537
  invalid data.
528
538
 
529
- @param[in] geom_input The geometry input object.
530
- @param[in] face_index Index of the face to receive the inner loop.
531
- @param[in] loop_input The inner loop to be added. If the function succeeds
532
- (i.e. returns SU_ERROR_NONE), this loop will be
533
- deallocated.
539
+ @param[in,out] geom_input The geometry input object.
540
+ @param[in] face_index Index of the face to receive the inner loop.
541
+ @param[in,out] loop_input The inner loop to be added. If the function succeeds
542
+ (i.e. returns \ref SU_ERROR_NONE), this loop will be
543
+ deallocated.
534
544
  @related SUGeometryInputRef
535
545
  @return
536
546
  - \ref SU_ERROR_NONE on success
@@ -552,9 +562,9 @@ SU_RESULT SUGeometryInputFaceAddInnerLoop(
552
562
 
553
563
  @see SUGeometryInputFaceSetFrontMaterialPosition
554
564
 
555
- @param[in] geom_input The geometry input object.
556
- @param[in] face_index Index of the face to receive the material.
557
- @param[in] material_input The material input to set.
565
+ @param[in,out] geom_input The geometry input object.
566
+ @param[in] face_index Index of the face to receive the material.
567
+ @param[in] material_input The material input to set.
558
568
 
559
569
  @related SUGeometryInputRef
560
570
 
@@ -578,9 +588,9 @@ SU_RESULT SUGeometryInputFaceSetFrontMaterial(
578
588
 
579
589
  @see SUGeometryInputFaceSetBackMaterialPosition
580
590
 
581
- @param[in] geom_input The geometry input object.
582
- @param[in] face_index Index of the face to receive the material.
583
- @param[in] material_input The material input to set.
591
+ @param[in,out] geom_input The geometry input object.
592
+ @param[in] face_index Index of the face to receive the material.
593
+ @param[in] material_input The material input to set.
584
594
 
585
595
  @related SUGeometryInputRef
586
596
 
@@ -598,9 +608,9 @@ SU_RESULT SUGeometryInputFaceSetBackMaterial(
598
608
  /**
599
609
  @brief Sets the front material of a face in the geometry input.
600
610
 
601
- @param[in] geom_input The geometry input object.
602
- @param[in] face_index Index of the face to receive the material.
603
- @param[in] material_input The material input to set.
611
+ @param[in,out] geom_input The geometry input object.
612
+ @param[in] face_index Index of the face to receive the material.
613
+ @param[in] material_input The material input to set.
604
614
 
605
615
  @related SUGeometryInputRef
606
616
 
@@ -621,9 +631,9 @@ SU_RESULT SUGeometryInputFaceSetFrontMaterialByPosition(
621
631
  /**
622
632
  @brief Sets the back material of a face in the geometry input.
623
633
 
624
- @param[in] geom_input The geometry input object.
625
- @param[in] face_index Index of the face to receive the material.
626
- @param[in] material_input The material input to set.
634
+ @param[in,out] geom_input The geometry input object.
635
+ @param[in] face_index Index of the face to receive the material.
636
+ @param[in] material_input The material input to set.
627
637
 
628
638
  @related SUGeometryInputRef
629
639
 
@@ -645,9 +655,9 @@ SU_RESULT SUGeometryInputFaceSetBackMaterialByPosition(
645
655
  @brief Sets a flag in the geometry input that, when true, will create a hidden
646
656
  face.
647
657
  @since SketchUp 2017, API 5.0
648
- @param[in] geom_input The geometry input object.
649
- @param[in] face_index Index of the face to be hidden.
650
- @param[in] hidden The given hidden flag.
658
+ @param[in,out] geom_input The geometry input object.
659
+ @param[in] face_index Index of the face to be hidden.
660
+ @param[in] hidden The given hidden flag.
651
661
  @related SUGeometryInputRef
652
662
  @return
653
663
  - \ref SU_ERROR_NONE on success
@@ -109,9 +109,9 @@ SU_RESULT SUGroupCreate(SUGroupRef* group);
109
109
 
110
110
  /**
111
111
  @brief Sets the name of a group object.
112
- @param[in] group The group object.
113
- @param[in] name The name string to set the group object.
114
- Assumed to be UTF-8 encoded.
112
+ @param[in,out] group The group object.
113
+ @param[in] name The name string to set the group object.
114
+ Assumed to be UTF-8 encoded.
115
115
  @related SUGroupRef
116
116
  @return
117
117
  - \ref SU_ERROR_NONE on success
@@ -152,8 +152,8 @@ SU_RESULT SUGroupGetGuid(SUGroupRef group, SUStringRef* guid);
152
152
  /**
153
153
  @brief Sets the globally unique identifier (guid) string of a group object.
154
154
  @since SketchUp 2015, API 3.0
155
- @param[in] group The group object.
156
- @param[in] guid_str The utf-8 formatted guid string.
155
+ @param[in,out] group The group object.
156
+ @param[in] guid_str The utf-8 formatted guid string.
157
157
  @related SUGroupRef
158
158
  @return
159
159
  - \ref SU_ERROR_NONE on success
@@ -168,12 +168,13 @@ SU_RESULT SUGroupSetGuid(SUGroupRef group, const char* guid_str);
168
168
  The transform is relative to the parent component. If the parent component is
169
169
  the root component of a model, then the transform is relative to absolute
170
170
  coordinates.
171
- @param[in] group The group object.
172
- @param[in] transform The affine transform to set.
171
+ @param[in,out] group The group object.
172
+ @param[in] transform The affine transform to set.
173
173
  @related SUGroupRef
174
174
  @return
175
175
  - \ref SU_ERROR_NONE on success
176
- - \ref SU_ERROR_INVALID_INPUT if group is not a valid object.
176
+ - \ref SU_ERROR_INVALID_INPUT if group is not a valid object or if the transform is not
177
+ invertible
177
178
  - \ref SU_ERROR_NULL_POINTER_INPUT if transform is NULL.
178
179
  */
179
180
  SU_RESULT SUGroupSetTransform(SUGroupRef group, const struct SUTransformation* transform);
@@ -143,8 +143,8 @@ SU_RESULT SUImageGetName(SUImageRef image, SUStringRef* name);
143
143
 
144
144
  /**
145
145
  @brief Sets the name of an image object.
146
- @param[in] image The image object.
147
- @param[in] name The name to set. Assumed to be UTF-8 encoded.
146
+ @param[in,out] image The image object.
147
+ @param[in] name The name to set. Assumed to be UTF-8 encoded.
148
148
  @related SUImageRef
149
149
  @deprecated This function sets a property that should not exist.
150
150
  Use SUImageGetDefinition() and SUComponentDefinitionSetName()
@@ -171,12 +171,13 @@ SU_RESULT SUImageGetTransform(SUImageRef image, struct SUTransformation* transfo
171
171
 
172
172
  /**
173
173
  @brief Sets the 3-dimensional homogeneous transform of an image object.
174
- @param[in] image The image object.
175
- @param[in] transform The affine transform to set.
174
+ @param[in,out] image The image object.
175
+ @param[in] transform The affine transform to set.
176
176
  @related SUImageRef
177
177
  @return
178
178
  - \ref SU_ERROR_NONE on success
179
- - \ref SU_ERROR_INVALID_INPUT if image is not a valid object
179
+ - \ref SU_ERROR_INVALID_INPUT if image is not a valid object or if the transform is not
180
+ invertible
180
181
  - \ref SU_ERROR_NULL_POINTER_OUTPUT if transform is NULL
181
182
  */
182
183
  SU_RESULT SUImageSetTransform(SUImageRef image, const struct SUTransformation* transform);
@@ -25,7 +25,7 @@ extern "C" {
25
25
  /**
26
26
  @enum SULayerVisibilityDefaultType
27
27
  @brief Indicates whether to set the layer visible by default. Used for
28
- \ref SULayerGetSceneBehavior() and \ref SULayerSetSceneBehavior().
28
+ SULayerGetSceneBehavior() and SULayerSetSceneBehavior().
29
29
  */
30
30
  enum SULayerVisibilityDefaultType {
31
31
  SULayerVisibilityDefaultType_Visible = 0x0000,
@@ -35,7 +35,7 @@ enum SULayerVisibilityDefaultType {
35
35
  /**
36
36
  @enum SULayerVisibilityNewSceneType
37
37
  @brief Indicates whether to set the layer visible on new scenes. Used for
38
- \ref SULayerGetSceneBehavior() and \ref SULayerSetSceneBehavior().
38
+ SULayerGetSceneBehavior() and SULayerSetSceneBehavior().
39
39
  */
40
40
  enum SULayerVisibilityNewSceneType {
41
41
  SULayerVisibilityNewSceneType_LayerDefault = 0x0000,
@@ -84,7 +84,7 @@ SU_RESULT SULayerCreate(SULayerRef* layer);
84
84
  @brief Deallocates a layer object.
85
85
 
86
86
  The layer object to be deallocated must not be associated with a SketchUp model.
87
- @param[in] layer The layer object.
87
+ @param[in,out] layer The layer object.
88
88
  @related SULayerRef
89
89
  @return
90
90
  - \ref SU_ERROR_NONE on success