scriptup 2024.0.7 → 2026.0.1

data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/component_definition.h

@@ -1,4 +1,4 @@
-// Copyright 2013-2020 Trimble Inc. All Rights Reserved.
+// Copyright 2013-2024 Trimble Inc. All Rights Reserved.
 
 /**
  * @file
@@ -34,24 +34,30 @@ extern "C" {
 @brief  References a component definition.
 */
 
+// The SUSnapToBehavior enum was originally defined incorrectly in this struct.
+// This is not valid C. To correct this we conditionally include it in here for
+// C compilers, while leaving the original definition inside the struct for C++
+// compilers.
+#ifndef __cplusplus
+  #include <SketchUpAPI/model/component_definition_snap_to_behavior_private.h>
+#endif
+
 /**
 @struct SUComponentBehavior
 @brief  Describes how the component behaves in a SketchUp model, e.g. how it glues to surfaces.
+
+@note See \ref SUSnapToBehavior for examples on how it is defined depending on
+  whether the code is compiled as C or C++. (Related to a bug in the original implementation).
+
+@see SUSnapToBehavior
+@see SUComponentDefinitionGetBehavior
+@see SUComponentDefinitionSetBehavior
 */
 struct SUComponentBehavior {
-  /**
-  @enum SUSnapToBehavior
-  @brief Describes how the component instance can be placed when a user adds
-         it to a model. For example a window component instance should snap
-         to a vertical plane.
-  */
-  enum SUSnapToBehavior {
-    SUSnapToBehavior_None = 0,
-    SUSnapToBehavior_Any,
-    SUSnapToBehavior_Horizontal,
-    SUSnapToBehavior_Vertical,
-    SUSnapToBehavior_Sloped
-  };
+#ifdef __cplusplus
+  // See the note above for why this is included here.
+  #include <SketchUpAPI/model/component_definition_snap_to_behavior_private.h>
+#endif
 
   /**
   How the component should snap to the surface where it's placed.
@@ -167,7 +173,7 @@ SU_RESULT SUComponentDefinitionCreate(SUComponentDefinitionRef* comp_def);
        the provided definition was contained by a model, use
        SUModelRemoveComponentDefinitions() to remove the definition and all
        instances.
-@param[in] comp_def The component definition object.
+@param[in,out] comp_def The component definition object.
 @related SUComponentDefinitionRef
 @return
 - \ref SU_ERROR_NONE on success
@@ -196,10 +202,10 @@ SU_RESULT SUComponentDefinitionGetName(SUComponentDefinitionRef comp_def, SUStri
 @bug Before SketchUp 2022.0.1 (API 10.0) this would not ensure the definition name was unique.
   As of SketchUp 2022.0.1 the component will be given a unique name automatically if needed.
 
-@param[in] comp_def The component definition object.
-@param[in] name The name of the component definition. Assumed to be UTF-8
-                encoded. If the requested name already belongs to another definition in the model,
-                a unique name will be generated based on this name.
+@param[in,out] comp_def The component definition object.
+@param[in]     name The name of the component definition. Assumed to be UTF-8
+                    encoded. If the requested name already belongs to another definition in the
+                    model, a unique name will be generated based on this name.
 @related SUComponentDefinitionRef
 @return
 - \ref SU_ERROR_NONE on success
@@ -231,8 +237,8 @@ SU_RESULT SUComponentDefinitionGetGuid(SUComponentDefinitionRef comp_def, SUStri
 
 /**
 @brief Retrieves the entities of the component definition.
-@param[in]  comp_def The component definition object.
-@param[out] entities The entities retrieved.
+@param[in,out]  comp_def The component definition object.
+@param[out]     entities The entities retrieved.
 @related SUComponentDefinitionRef
 @return
 - \ref SU_ERROR_NONE on success
@@ -258,8 +264,8 @@ SU_RESULT SUComponentDefinitionGetDescription(SUComponentDefinitionRef comp_def,
 
 /**
 @brief Sets the description of the component definition.
-@param[in] comp_def The component definition object.
-@param[in] desc     The description to be set. Assumed to be UTF-8 encoded.
+@param[in,out] comp_def The component definition object.
+@param[in]     desc     The description to be set. Assumed to be UTF-8 encoded.
 @related SUComponentDefinitionRef
 @return
 - \ref SU_ERROR_NONE on success
@@ -347,34 +353,52 @@ SU_RESULT SUComponentDefinitionGetInstances(
 
 /**
 @brief Retrieves the behavior of a component definition.
+
+@note See \ref SUSnapToBehavior for examples on how it is defined depending on
+  whether the code is compiled as C or C++. (Related to a bug in the original implementation).
+
 @param[in]  comp_def The component definition object.
 @param[out] behavior The behavior retrieved.
 @related SUComponentDefinitionRef
 @return
 - \ref SU_ERROR_NONE on success
 - \ref SU_ERROR_INVALID_INPUT if comp_def is invalid
+
+@see SUSnapToBehavior
+@see SUComponentBehavior
+@see SUComponentDefinitionGetBehavior
+@see SUComponentDefinitionSetBehavior
 */
 SU_RESULT SUComponentDefinitionGetBehavior(
     SUComponentDefinitionRef comp_def, struct SUComponentBehavior* behavior);
 
 /**
 @brief Sets the component behavior of a component definition.
-@param[in] comp_def The component definition object.
-@param[in] behavior The behavior to set.
+
+@note See \ref SUSnapToBehavior for examples on how it is defined depending on
+  whether the code is compiled as C or C++. (Related to a bug in the original implementation).
+
+@param[in,out] comp_def The component definition object.
+@param[in]     behavior The behavior to set.
 @related SUComponentDefinitionRef
 @return
 - \ref SU_ERROR_NONE on success
 - \ref SU_ERROR_INVALID_INPUT if comp_def is invalid
 - \ref SU_ERROR_NULL_POINTER_INPUT if behavior is NULL
+
+@see SUSnapToBehavior
+@see SUComponentBehavior
+@see SUComponentDefinitionGetBehavior
+@see SUComponentDefinitionSetBehavior
 */
 SU_RESULT SUComponentDefinitionSetBehavior(
     SUComponentDefinitionRef comp_def, const struct SUComponentBehavior* behavior);
 
 /**
 @brief Applies a schema type from a schema to a component definition.
-@param[in] comp_def The component definition object.
-@param[in] schema_ref The schema that owns the schema type to apply.
-@param[in] schema_type_ref The schema type to apply.
+@param[in,out] comp_def The component definition object.
+@param[in]     schema_ref The schema that owns the schema type to apply.
+@param[in]     schema_type_ref The schema type to apply.
 @related SUComponentDefinitionRef
 @return
 - \ref SU_ERROR_NONE on success
@@ -463,6 +487,10 @@ SU_RESULT SUComponentDefinitionGetOpenings(
 /**
 @brief Retrieves the insertion point from the component definition.
 @since SketchUp 2016, API 4.0
+
+@deprecated Starting with SketchUp 2020.0, this function returns the default origin `[0, 0, 0]`, as
+  the insertion point can no longer be changed.
+
 @param[in]  comp_def  The component definition object.
 @param[out] point     The insertion point retrieved.
 @related SUComponentDefinitionRef
@@ -493,7 +521,7 @@ SU_RESULT SUComponentDefinitionGetType(
 @brief Updates the faces in the component definition so that they are oriented
        consistently.
 @since SketchUp 2016, API 4.0
-@param[in] comp_def The component definition object.
+@param[in,out] comp_def The component definition object.
 @related SUComponentDefinitionRef
 @return
 - \ref SU_ERROR_NONE on success
@@ -514,8 +542,8 @@ SU_RESULT SUComponentDefinitionOrientFacesConsistently(SUComponentDefinitionRef
          was changed to \ref SU_ERROR_NULL_POINTER_INPUT for consistency with
          other API methods.
 
-@param[in] comp_def  The component definition object.
-@param[in] point     The \ref SUPoint3D to use.
+@param[in,out] comp_def  The component definition object.
+@param[in]     point     The \ref SUPoint3D to use.
 @related SUComponentDefinitionRef
 @return
 - \ref SU_ERROR_NONE
@@ -527,8 +555,8 @@ SU_RESULT SUComponentDefinitionSetInsertPoint(
 /**
 @brief Sets the axes of the component definition.
 @since SketchUp 2016, API 4.0
-@param[in] comp_def The component definition object.
-@param[in] axes     The \ref SUAxesRef to use.
+@param[in,out] comp_def The component definition object.
+@param[in]     axes     The \ref SUAxesRef to use.
 @related SUComponentDefinitionRef
 @return
 - \ref SU_ERROR_NONE on success
@@ -575,6 +603,19 @@ SU_RESULT SUComponentDefinitionIsLiveComponent(SUComponentDefinitionRef comp_def
 SU_RESULT SUComponentDefinitionSaveToFile(
     SUComponentDefinitionRef comp_def, const char* file_path, enum SUModelVersion version);
 
+/**
+ * @brief Retrieves the flag indicating whether the component definition is manifold.
+ * @since SketchUp 2025.0, API 13.0
+ * @param[in] comp_def The component definition object.
+ * @param[out] is_manifold The bool value retrieved.
+ * @related SUComponentDefinitionRef
+ * @return
+ * - \ref SU_ERROR_NONE on success
+ * - \ref SU_ERROR_INVALID_INPUT if \p comp_def is invalid
+ * - \ref SU_ERROR_NULL_POINTER_OUTPUT if \p is_manifold is NULL
+ */
+SU_RESULT SUComponentDefinitionIsManifold(SUComponentDefinitionRef comp_def, bool* is_manifold);
+
 #ifdef __cplusplus
 }  // extern "C"
 #endif

data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/component_definition_snap_to_behavior_private.h

@@ -0,0 +1,46 @@
+/**
+ * @file
+ * @brief Definition for \ref SUSnapToBehavior. Don't include directly.
+ *
+ * @warning Do not include this header directly. This file is part of a
+ *   compatibility shim. Instead include `SketchUpAPI/model/component_definition.h`.
+ */
+
+/**
+@enum SUSnapToBehavior
+@headerfile <SketchUpAPI/model/component_definition.h>
+@brief Describes how the component instance can be placed when a user adds it to a model.
+
+For example a window component instance should snap to a vertical plane.
+
+@see SUComponentBehavior
+
+@bug This enum was incorrectly defined inside the \ref SUComponentBehavior struct. This is
+  not valid C. As of SketchUp 2025.0 (API 13.0), this enum is conditionally defined outside
+  of the struct when the header is consumed by a C compiler.
+
+@code
+// Usage from a C compiler:
+SUSnapToBehavior behavior;
+SUComponentDefinitionSetBehavior(component_definition, &behavior);
+if (behavior.component_snap == SUSnapToBehavior_Vertical) {
+  // ...
+}
+@endcode
+
+@code
+// Usage from a C++ compiler:
+SUSnapToBehavior behavior;
+SUComponentDefinitionSetBehavior(component_definition, &behavior);
+if (behavior.component_snap == SUComponentBehavior::SUSnapToBehavior_Vertical) {
+  // ...
+}
+@endcode
+*/
+enum SUSnapToBehavior {
+  SUSnapToBehavior_None = 0,
+  SUSnapToBehavior_Any,
+  SUSnapToBehavior_Horizontal,
+  SUSnapToBehavior_Vertical,
+  SUSnapToBehavior_Sloped
+};

data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/component_instance.h

@@ -72,9 +72,9 @@ SUComponentInstanceFromDrawingElement(SUDrawingElementRef drawing_elem);
 
 /**
 @brief Sets the name of a component instance object.
-@param[in] instance The component instance object.
-@param[in] name     The name string to set the component instance object.
-                    Assumed to be UTF-8 encoded.
+@param[in,out] instance The component instance object.
+@param[in] name         The name string to set the component instance object.
+                        Assumed to be UTF-8 encoded.
 @related SUComponentInstanceRef
 @return
 - \ref SU_ERROR_NONE on success
@@ -86,7 +86,7 @@ SU_RESULT SUComponentInstanceSetName(SUComponentInstanceRef instance, const char
 /**
 @brief Deallocates a component instance object created with
        SUComponentDefinitionCreateInstance().
-@param[in] instance The component instance object.
+@param[in,out] instance The component instance object.
 @related SUComponentInstanceRef
 @return
 - \ref SU_ERROR_NONE on success
@@ -111,8 +111,8 @@ SU_RESULT SUComponentInstanceGetName(SUComponentInstanceRef instance, SUStringRe
 /**
 @brief Sets the globally unique identifier (guid) string of a instance object.
 @since SketchUp 2015, API 3.0
-@param[in]  instance The component instance object.
-@param[in]  guid     The utf-8 formatted guid string.
+@param[in,out]  instance The component instance object.
+@param[in]      guid     The utf-8 formatted guid string.
 @related SUComponentInstanceRef
 @return
 - \ref SU_ERROR_NONE on success
@@ -141,12 +141,12 @@ SU_RESULT SUComponentInstanceGetGuid(SUComponentInstanceRef instance, SUStringRe
 The transform is relative to the parent component. If the parent component is
 the root component of a model, then the transform is relative to absolute
 coordinates.
-@param[in] instance  The component instance object.
-@param[in] transform The affine transform to set.
+@param[in,out] instance  The component instance object.
+@param[in]     transform The affine transform to set.
 @related SUComponentInstanceRef
 @return
 - \ref SU_ERROR_NONE on success
-- \ref SU_ERROR_INVALID_INPUT if instance is not a valid object
+- \ref SU_ERROR_INVALID_INPUT if instance is not a valid object or transform is non invertible
 - \ref SU_ERROR_NULL_POINTER_INPUT if transform is NULL
 */
 SU_RESULT SUComponentInstanceSetTransform(
@@ -184,8 +184,8 @@ SU_RESULT SUComponentInstanceGetDefinition(
 /**
 @brief Locks the instance if is_locked is true, otherwise unlocks the instance.
 @since SketchUp 2016, API 4.0
-@param[in] instance The instance object.
-@param[in] lock     if true lock the instance, otherwise unlock it.
+@param[in,out] instance The instance object.
+@param[in]     lock     if true lock the instance, otherwise unlock it.
 @related SUComponentInstanceRef
 @return
 - \ref SU_ERROR_NONE on success

data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/curve.h

@@ -56,9 +56,9 @@ SU_EXPORT SUCurveRef SUCurveFromEntity(SUEntityRef entity);
         same as the end position of the previous edge in the array.  Each
         element of the array of edges is subsequently associated with the
         created curve object and must not be deallocated via SUEdgeRelease().
-@param curve The curve object created.
-@param edges The array of edge objects.
-@param len   The number of edge objects in the array.
+@param[out] curve The curve object created.
+@param[in]  edges The array of edge objects.
+@param[in]  len   The number of edge objects in the array.
 @related SUCurveRef
 @return
 - \ref SU_ERROR_NONE on success
@@ -74,7 +74,7 @@ SU_RESULT SUCurveCreateWithEdges(SUCurveRef* curve, const SUEdgeRef edges[], siz
 
 /**
 @brief  Releases a curve object and its associated edge objects.
-@param curve The curve object.
+@param[in,out] curve The curve object.
 @related SUCurveRef
 @return
 - \ref SU_ERROR_NONE on success

data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/defs.h

@@ -1,4 +1,4 @@
-// Copyright 2013-2020 Trimble Inc. All Rights Reserved.
+// Copyright 2012-2024 Trimble Inc. All Rights Reserved.
 
 /**
  * @file
@@ -34,6 +34,8 @@ DEFINE_SU_TYPE(SUEntitiesRef)
 DEFINE_SU_TYPE(SUEntityListRef)
 DEFINE_SU_TYPE(SUEntityListIteratorRef)
 DEFINE_SU_TYPE(SUEntityRef)
+DEFINE_SU_TYPE(SUEnvironmentRef)
+DEFINE_SU_TYPE(SUEnvironmentsRef)
 DEFINE_SU_TYPE(SUFaceRef)
 DEFINE_SU_TYPE(SUFontRef)
 DEFINE_SU_TYPE(SUGeometryInputRef)
@@ -65,6 +67,7 @@ DEFINE_SU_TYPE(SUSchemaTypeRef)
 DEFINE_SU_TYPE(SUSectionPlaneRef)
 DEFINE_SU_TYPE(SUSelectionRef)
 DEFINE_SU_TYPE(SUShadowInfoRef)
+DEFINE_SU_TYPE(SUSnapRef)
 DEFINE_SU_TYPE(SUStyleRef)
 DEFINE_SU_TYPE(SUStylesRef)
 DEFINE_SU_TYPE(SUTextRef)
@@ -87,6 +90,8 @@ enum SURefType {
   SURefType_Curve,                      ///< SUCurveRef type
   SURefType_Edge,                       ///< SUEdgeRef type
   SURefType_EdgeUse,                    ///< SUEdgeUseRef type
+  SURefType_Environment,                ///< SUEnvironment type
+  SURefType_Environments,               ///< SUEnvironments type
   SURefType_Entities,                   ///< SUEntitiesRef type
   SURefType_Face,                       ///< SUFaceRef type
   SURefType_Group,                      ///< SUGroupRef type
@@ -134,7 +139,7 @@ enum SURefType {
   SURefType_LineStyleManager,           ///< SULineStyleManagerRef type
   SURefType_Selection,                  ///< SUSelectionRef type
   SURefType_LayerFolder,                ///< SULayerFolderRef type
-
+  SURefType_Snap,                       ///< SUSnapRef type
 };
 
 #pragma pack(pop)

data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/dimension.h

@@ -191,6 +191,8 @@ SU_RESULT SUDimensionSetArrowType(SUDimensionRef dimension, enum SUArrowType typ
 
 /**
 @brief Get the dimension's font reference.
+@note The returned font reference may become invalid if another font is
+      assigned to this dimension object later.
 @since SketchUp 2019, API 7.0
 @param[in]  dimension The dimension object.
 @param[out] font      The font retrieved.

data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/drawing_element.h

@@ -88,9 +88,9 @@ SU_RESULT SUDrawingElementGetMaterial(SUDrawingElementRef elem, SUMaterialRef* m
 
 The material object must not be subsequently deallocated while associated with
 the drawing element.
-@param[in] elem     The drawing element.
-@param[in] material The material object to set. If an invalid reference is
-                    given, then the material of the element will be removed.
+@param[in,out] elem     The drawing element.
+@param[in]     material The material object to set. If an invalid reference is
+                        given, then the material of the element will be removed.
 @related SUDrawingElementRef
 @return
 - \ref SU_ERROR_NONE on success
@@ -113,8 +113,8 @@ SU_RESULT SUDrawingElementGetLayer(SUDrawingElementRef elem, SULayerRef* layer);
 
 /**
 @brief Sets the layer object to be associated with a drawing element.
-@param[in] elem  The drawing element.
-@param[in] layer The layer object to set.
+@param[in,out] elem  The drawing element.
+@param[in]     layer The layer object to set.
 @related SUDrawingElementRef
 @return
 - \ref SU_ERROR_NONE on success
@@ -124,8 +124,8 @@ SU_RESULT SUDrawingElementSetLayer(SUDrawingElementRef elem, SULayerRef layer);
 
 /**
 @brief Sets the hide flag of a drawing element.
-@param[in] elem      The drawing element.
-@param[in] hide_flag The hide flag to set.
+@param[in,out] elem      The drawing element.
+@param[in]     hide_flag The hide flag to set.
 @related SUDrawingElementRef
 @return
 - \ref SU_ERROR_NONE on success
@@ -147,8 +147,8 @@ SU_RESULT SUDrawingElementGetHidden(SUDrawingElementRef elem, bool* hide_flag);
 
 /**
 @brief Sets the casts shadows flag of a drawing element.
-@param[in] elem               The drawing element.
-@param[in] casts_shadows_flag The casts shadows flag to set.
+@param[in,out] elem               The drawing element.
+@param[in]     casts_shadows_flag The casts shadows flag to set.
 @related SUDrawingElementRef
 @return
 - \ref SU_ERROR_NONE on success
@@ -170,8 +170,8 @@ SU_RESULT SUDrawingElementGetCastsShadows(SUDrawingElementRef elem, bool* casts_
 
 /**
 @brief Sets the receives shadows flag of a drawing element.
-@param[in] elem                  The drawing element.
-@param[in] receives_shadows_flag The casts shadows flag to set.
+@param[in,out] elem                  The drawing element.
+@param[in]     receives_shadows_flag The casts shadows flag to set.
 @related SUDrawingElementRef
 @return
 - \ref SU_ERROR_NONE on success

data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/edge.h

@@ -92,7 +92,7 @@ SU_RESULT SUEdgeCreate(SUEdgeRef* edge, const struct SUPoint3D* start, const str
 
 The edge object must have been created with SUEdgeCreate() and not
 subsequently associated with a parent object (e.g. SUEntitiesAddEdges()).
-@param[in] edge The edge object.
+@param[in,out] edge The edge object.
 @related SUEdgeRef
 @return
 - \ref SU_ERROR_NONE on success
@@ -140,8 +140,8 @@ SU_RESULT SUEdgeGetEndVertex(SUEdgeRef edge, SUVertexRef* vertex);
 
 /**
 @brief Sets the soft flag of an edge object.
-@param[in] edge      The edge object.
-@param[in] soft_flag The soft flag to set.
+@param[in,out] edge      The edge object.
+@param[in]     soft_flag The soft flag to set.
 @related SUEdgeRef
 @return
 - \ref SU_ERROR_NONE on success
@@ -163,8 +163,8 @@ SU_RESULT SUEdgeGetSoft(SUEdgeRef edge, bool* soft_flag);
 
 /**
 @brief Sets the smooth flag of an edge object.
-@param[in] edge        The edge object.
-@param[in] smooth_flag The smooth flag to set.
+@param[in,out] edge        The edge object.
+@param[in]     smooth_flag The smooth flag to set.
 @related SUEdgeRef
 @return
 - \ref SU_ERROR_NONE on success
@@ -238,8 +238,8 @@ SU_RESULT SUEdgeGetLengthWithTransform(
 
 /**
 @brief Sets the color of an edge object.
-@param[in] edge  The edge object.
-@param[in] color The color object to set.
+@param[in,out] edge  The edge object.
+@param[in]     color The color object to set.
 @related SUEdgeRef
 @return
 - \ref SU_ERROR_NONE on success