scriptup 2024.0.7 → 2026.0.1

data/ext/utils.h

@@ -1,7 +1,13 @@
+#ifndef SCRIPTUP_UTILS_H
+#define SCRIPTUP_UTILS_H
+
 #include <ruby.h>
 
-#ifndef UTILS_H
+#ifdef TEXT
+#undef TEXT
+#endif //TEXT
 #define SKETCHUP "Sketchup"
+#define GEOM "Geom"
 #define MODEL "Model"
 #define MATERIAL "Material"
 #define MATERIALS "Materials"
@@ -16,6 +22,18 @@
 #define ATTRIBUTEDICTIONARIES "AttributeDictionaries"
 #define DRAWINGELEMENT "DrawingElement"
 #define BEHAVIOR "Behavior"
+#define BOUNDINGBOX "BoundingBox"
+#define FACE "Face"
+#define LAYER "Layer"
+#define CONSTRUCTIONLINE "ConstructionLine"
+#define CONSTRUCTIONPOINT "ConstructionPoint"
+#define DIMENSION "Dimension"
+#define EDGE "Edge"
+#define IMAGE "Image"
+#define SECTIONPLANE "SectionPlane"
+#define GROUP "Group"
+#define TEXT "Text"
+#define IMAGEREP "ImageRep"
 #define SKETCHUP_MATERIAL SKETCHUP "::" MATERIAL
 #define SKETCHUP_MATERIALS SKETCHUP "::" MATERIALS
 #define SKETCHUP_TEXTURE SKETCHUP "::" TEXTURE
@@ -28,6 +46,18 @@
 #define SKETCHUP_ATTRIBUTEDICTIONARIES SKETCHUP "::" ATTRIBUTEDICTIONARIES
 #define SKETCHUP_DEFINITIONLIST SKETCHUP "::" DEFINITIONLIST
 #define SKETCHUP_BEHAVIOR SKETCHUP "::" BEHAVIOR
+#define GEOM_BOUNDINGBOX GEOM "::" BOUNDINGBOX
+#define SKETCHUP_FACE SKETCHUP "::" FACE
+#define SKETCHUP_LAYER SKETCHUP "::" LAYER
+#define SKETCHUP_CONSTRUCTIONLINE SKETCHUP "::" CONSTRUCTIONLINE
+#define SKETCHUP_CONSTRUCTIONPOINT SKETCHUP "::" CONSTRUCTIONPOINT
+#define SKETCHUP_DIMENSION SKETCHUP "::" DIMENSION
+#define SKETCHUP_EDGER SKETCHUP "::" EDGE
+#define SKETCHUP_IMAGE SKETCHUP "::" IMAGE
+#define SKETCHUP_SECTIONPLANE SKETCHUP "::" SECTIONPLANE
+#define SKETCHUP_GROUP SKETCHUP "::" GROUP
+#define SKETCHUP_TEXT SKETCHUP "::" TEXT
+#define SKETCHUP_IMAGEREP SKETCHUP "::" IMAGEREP
 
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wbackslash-newline-escape"
@@ -75,6 +105,7 @@
 	GETUTF8FROMSTRING(name, output); \
 	SUStringRelease(&name); \
 }
-#endif // UTILS_H
 
-#pragma clang diagnostic pop
+#pragma clang diagnostic pop
+
+#endif // SCRIPTUP_UTILS_H

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

@@ -29,8 +29,8 @@ extern "C" {
 - \ref SU_ERROR_NULL_POINTER_OUTPUT if \p overlay is NULL
 - \ref SU_ERROR_OVERWRITE_VALID if \p overlay is already a valid object
 - \ref SU_ERROR_DUPLICATE if the given SUOverlayCreateInfo::id already exists in the model
-@relatedalso SUModelRef
-@relatedalso SUOverlayRef
+@related SUModelRef
+@see SUOverlayRef
 */
 SU_RESULT SUModelCreateOverlay(
     SUModelRef model, const struct SUOverlayCreateInfo* info, SUOverlayRef* overlay);
@@ -45,8 +45,8 @@ SU_RESULT SUModelCreateOverlay(
 - \ref SU_ERROR_INVALID_INPUT if \p model or \p overlay is an invalid object
 - \ref SU_ERROR_NULL_POINTER_INPUT if \p overlay is NULL
 - \ref SU_ERROR_NO_DATA if \p overlay could be found in the model
-@relatedalso SUModelRef
-@relatedalso SUOverlayRef
+@related SUModelRef
+@see SUOverlayRef
 */
 SU_RESULT SUModelReleaseOverlay(SUModelRef model, SUOverlayRef* overlay);
 

data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/application/overlay.h

@@ -58,18 +58,25 @@ struct SUBeginFrameInfo {
   double aspect_ratio;            ///< Aspect ratio of the view port
   double near_clipping_distance;  ///< Distance to near clipping plane from the camera
   double far_clipping_distance;   ///< Distance to far clipping plane from the camera
-  double projection_matrix[16];   ///< Projection Matrix.
-  double view_matrix[16];         ///< View Matrix
+  double projection_matrix[16];   ///< Projection Matrix, stored in row major order.
+  double view_matrix[16];         ///< View Matrix, stored in row major order.
   double viewport_width;          ///< Viewport width
   double viewport_height;         ///< Viewport height
 
-  double fov;     ///< Field of view of the perspective camera (in degrees). Valid only when
-                  ///< is_perspective is true.
+  /**
+   * Field of view of the perspective camera (in degrees). Valid only when
+   * is_perspective is true.
+   */
+  double fov;
+
   double height;  ///< Parallel projection frustum height. Valid only when is_perspective is false.
   bool is_perspective;  ///< Whether the camera is perspective or orthographic.
 
-  void* reserved;  ///< Reserved for internal use. This will be set to NULL by SketchUp and should
-                   ///< not be modified.
+  /**
+   * Reserved for internal use. This will be set to NULL by SketchUp and should
+   * not be modified.
+   */
+  void* reserved;
 };
 
 /**
@@ -126,6 +133,7 @@ enum SUOverlayImageOrientation : uint8_t {
 @struct SUOverlayDrawFrameInfo
 @brief Data that SketchUp will use the to blend the given color/depth buffer onto SketchUp
 rendering.
+@attention color and depth buffers must be valid until the end_frame callback is called.
 @related SUOverlayRef
 */
 struct SUOverlayDrawFrameInfo {
@@ -137,9 +145,11 @@ struct SUOverlayDrawFrameInfo {
   double blending_factor;
 
   /// Color buffer info. ptr points to a uint8_t buffer with 4 channels.
+  /// The buffer pointed to by color must be valid until the end_frame callback is called.
   struct SUDrawFrameMemoryBuffer color;
 
   /// Depth buffer info. ptr points to a float buffer.
+  /// The buffer pointed to by color must be valid until the end_frame callback is called.
   struct SUDrawFrameMemoryBuffer depth;
 
   /// Reserved for internal use. This will be set to NULL by SketchUp and should not be modified.
@@ -154,6 +164,8 @@ typedef void (*SUOverlayDrawFrameFuncT)(SUOverlayRef, struct SUOverlayDrawFrameI
 
 /**
 @brief Signature for SUOverlayCreateInfo::end_frame callback
+@attention SUOverlayDrawFrameInfo::color and SUOverlayDrawFrameInfo::depth buffers must be valid
+until the end_frame callback is called.
 @related SUOverlayRef
 */
 typedef void (*SUOverlayEndFrameFuncT)(SUOverlayRef, void*);
@@ -224,6 +236,8 @@ struct SUOverlayCreateInfo {
   SUOverlayDrawFrameFuncT draw_frame;
   /// Function that SketchUp will call to signal the resources passed in draw_frame are no longer
   /// needed.
+  /// SUOverlayDrawFrameInfo::color and SUOverlayDrawFrameInfo::depth buffers must be valid until
+  /// the end_frame callback is called.
   SUOverlayEndFrameFuncT end_frame;
 };
 

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

@@ -1,4 +1,4 @@
-// Copyright 2015 Trimble Inc., All rights reserved.
+// Copyright 2015-2024 Trimble Inc. All rights reserved.
 // This file is intended for public distribution.
 
 /**
@@ -90,13 +90,9 @@ typedef wchar_t unichar;  ///< A platform-independent UTF16 type.
     #endif  // GSLAPI_API_EXPORTS
   #endif    // WINDOWS
 
-  #if defined __APPLE__
+  #if defined __APPLE__ && !defined GSLAPI_NO_EXPORTS
     #undef SU_EXPORT
-    #ifdef GSLAPI_API_EXPORTS
-      #define SU_EXPORT __attribute__((visibility("default")))
-    #else
-      #define SU_EXPORT __attribute__((visibility("hidden")))
-    #endif
+    #define SU_EXPORT __attribute__((visibility("default")))
   #endif  // #if defined __APPLE__
 
   #define DEFINE_SU_TYPE(TYPENAME) \
@@ -104,8 +100,6 @@ typedef wchar_t unichar;  ///< A platform-independent UTF16 type.
       void* ptr;                   \
     } TYPENAME;
 
-  // #define SU_RESULT SU_EXPORT enum SUResult
-
 #endif  // DOXYGEN_SHOULD_SKIP_THIS
 
 /**
@@ -158,6 +152,12 @@ typedef unsigned __int32 uint32_t;
   #include <stdint.h>
 #endif  // #if !defined(__STDC_HOSTED__) || (__STDC_HOSTED__ == 0)
 
+#ifndef __cplusplus
+  // C compilers need this header for the bool type.
+  // This header maps bool to C99's _Bool type.
+  #include <stdbool.h>
+#endif
+
 /**
 @brief This macro is used to indicate if functions are intended to be
        deprecated.  If you would like to hide the deprecation warnings simply

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

@@ -42,7 +42,15 @@ struct SUExtensionLicense {
 };
 
 /**
-@brief Acquires a license for a given extension.
+@brief Gets a license for a given extension.
+
+Starting in SketchUp 2025.0 (API 13.0), this function automatically tries to fetch a license from
+Extension Warehouse if the extension doesn't have a license on the current device. This only works
+if the user is signed in. In earlier SketchUp versions, the user has to go to Extension Manager,
+expand the extension in question and press Update License if the license is missing. (For
+performance reasons this automatic fetching is skipped during SketchUp startup. Make sure to do a
+license check when the user interacts with the extension).
+
 @param[in]  extension_id The Extension Warehouse UUID for the extension.
 @param[out] out_license  the licensing retrieved.
 @related SUExtensionLicense

data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/geometry/point2d.h

@@ -62,11 +62,11 @@ SU_RESULT SUPoint2DOffset(
     const struct SUPoint2D* point1, const struct SUVector2D* vector, struct SUPoint2D* point2);
 
 /**
-@brief Gets the distance between two point objects.
+@brief Gets the distance between two point objects, in inches.
 @since SketchUp 2017, API 5.0
 @param[in]  point1   The first point object.
 @param[in]  point2   The second point object.
-@param[out] distance The distance between the two points.
+@param[out] distance The distance between the two points, in inches.
 @related SUPoint2D
 @return
 - \ref SU_ERROR_NONE on success

data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/geometry/point3d.h

@@ -63,11 +63,11 @@ SU_RESULT SUPoint3DOffset(
     const struct SUPoint3D* point1, const struct SUVector3D* vector, struct SUPoint3D* point2);
 
 /**
-@brief Gets the distance between two point objects.
+@brief Gets the distance between two point objects, in inches.
 @since SketchUp 2018 M0, API 6.0
 @param[in]  point1   The first point object.
 @param[in]  point2   The second point object.
-@param[out] distance The distance between the two points.
+@param[out] distance The distance between the two points, in inches.
 @related SUPoint3D
 @return
 - \ref SU_ERROR_NONE on success

data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/geometry/transformation2d.h

@@ -62,7 +62,7 @@ SU_RESULT SUTransformation2DNonUniformScale(
 @since SketchUp 2019, API 7.0
 @param[out] transform The transformation to be set.
 @param[in]  point     The point specifying the translation component of the
-                      transformation.
+                      transformation. The coordinates of the point are in inches.
 @param[in]  scale     The scale value for the transformation.
 @related SUTransformation2D
 @return
@@ -78,7 +78,7 @@ SU_RESULT SUTransformation2DScaleAboutPoint(
 @since SketchUp 2019, API 7.0
 @param[out] transform The transformation to be set.
 @param[in]  point     The point specifying the translation component of the
-                      transformation.
+                      transformation. The coordinates of the point should be expressed in inches.
 @param[in]  x_scale   The x-axis scale value for the transformation.
 @param[in]  y_scale   The y-axis scale value for the transformation.
 @related SUTransformation2D
@@ -96,7 +96,7 @@ SU_RESULT SUTransformation2DNonUniformScaleAboutPoint(
 @since SketchUp 2019, API 7.0
 @param[out] transform The calculated transformation.
 @param[in]  point     The point specifying the translation component of the
-                      transformation.
+                      transformation. The coordinates of the point should be expressed in inches.
 @param[in]  angle     The rotation in radians for the transformation.
 @related SUTransformation2D
 @return

data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/geometry/vector2d.h

@@ -121,7 +121,7 @@ SU_RESULT SUVector2DNormalize(struct SUVector2D* vector);
 /**
 @brief Reverses a vector.
 @since SketchUp 2017, API 5.0
-@param[in] vector The vector object.
+@param[in,out] vector The vector object.
 @related SUVector2D
 @return
 - \ref SU_ERROR_NONE on success
@@ -173,10 +173,10 @@ SU_RESULT SUVector2DCross(
 SU_RESULT SUVector2DIsUnitVector(const struct SUVector2D* vector, bool* is_unit_vector);
 
 /**
-@brief Gets the length of a vector.
+@brief Gets the length of a vector, in inches.
 @since SketchUp 2017, API 5.0
 @param[in]  vector The vector object.
-@param[out] length The length of the vector.
+@param[out] length The length of the vector, in inches.
 @related SUVector2D
 @return
 - \ref SU_ERROR_NONE on success
@@ -186,10 +186,10 @@ SU_RESULT SUVector2DIsUnitVector(const struct SUVector2D* vector, bool* is_unit_
 SU_RESULT SUVector2DGetLength(const struct SUVector2D* vector, double* length);
 
 /**
-@brief Sets the length of a vector.
+@brief Sets the length of a vector, in inches.
 @since SketchUp 2017, API 5.0
 @param[in,out] vector The vector object.
-@param[in]     length The new length the vector should be.
+@param[in]     length The new length the vector should be, in inches.
 @related SUVector2D
 @return
 - \ref SU_ERROR_NONE on success

data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/geometry/vector3d.h

@@ -187,10 +187,10 @@ SU_RESULT SUVector3DCross(
 SU_RESULT SUVector3DIsUnitVector(const struct SUVector3D* vector, bool* is_unit_vector);
 
 /**
-@brief Gets the length of a vector.
+@brief Gets the length of a vector, in inches.
 @since SketchUp 2018, API 6.0
 @param[in]  vector The vector object.
-@param[out] length The length of the vector.
+@param[out] length The length of the vector, in inches.
 @related SUVector3D
 @return
 - \ref SU_ERROR_NONE on success
@@ -200,10 +200,10 @@ SU_RESULT SUVector3DIsUnitVector(const struct SUVector3D* vector, bool* is_unit_
 SU_RESULT SUVector3DGetLength(const struct SUVector3D* vector, double* length);
 
 /**
-@brief Sets the length of a vector.
+@brief Sets the length of a vector, in inches.
 @since SketchUp 2018, API 6.0
 @param[in,out] vector The vector object.
-@param[in]     length The new length the vector should be.
+@param[in]     length The new length the vector should be, in inches.
 @related SUVector3D
 @return
 - \ref SU_ERROR_NONE on success

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

@@ -18,7 +18,7 @@ extern "C" {
 
 /**
 @struct SUPoint2D
-@brief Represents a point in 2-dimensional space.
+@brief Represents a point in 2-dimensional space. The coordinates are represented in inches.
 */
 struct SUPoint2D {
   double x;  ///< X coordinate
@@ -27,7 +27,7 @@ struct SUPoint2D {
 
 /**
 @struct SUVector2D
-@brief Represents a vector in 2-dimensional space.
+@brief Represents a vector in 2-dimensional space. The magnitudes are represented in inches.
 */
 struct SUVector2D {
   double x;  ///< X magnitude
@@ -36,7 +36,7 @@ struct SUVector2D {
 
 /**
 @struct SUPoint3D
-@brief Represents a point in 3-dimensional space.
+@brief Represents a point in 3-dimensional space. The coordinates are represented in inches.
 */
 struct SUPoint3D {
   double x;  ///< X coordinate
@@ -46,7 +46,7 @@ struct SUPoint3D {
 
 /**
 @struct SUVector3D
-@brief Represents a vector in 3-dimensional space.
+@brief Represents a vector in 3-dimensional space. The magnitudes are represented in inches.
 */
 struct SUVector3D {
   double x;  ///< X magnitude
@@ -70,7 +70,8 @@ struct SUPlane3D {
 /**
 @struct SUBoundingBox3D
 @brief Represents a 3D axis-aligned bounding box represented by the extreme
-       diagonal corner points with minimum and maximum x,y,z coordinates.
+       diagonal corner points with minimum and maximum x,y,z coordinates. The coordinates of the
+       points are in inches.
 */
 struct SUBoundingBox3D {
   struct SUPoint3D min_point;  ///< A 3D point where x, y and z are minimum
@@ -82,7 +83,7 @@ struct SUBoundingBox3D {
 /**
 @struct SUAxisAlignedRect2D
 @brief Represents a 2D rectangle that is aligned with the X and Y axis of the
-       coordinate system.
+       coordinate system. The coordinates of the points of the rectangle are in inches.
 */
 struct SUAxisAlignedRect2D {
   struct SUPoint2D upper_left;   ///< Upper left corner of the bounding box.
@@ -91,7 +92,8 @@ struct SUAxisAlignedRect2D {
 
 /**
 @struct SURay3D
-@brief Represents a 3D ray defined by a point and normal vector.
+@brief Represents a 3D ray defined by a point and normal vector. The coordinates of the point are
+represented in inches.
 @since SketchUp 2018, API 6.0
 */
 struct SURay3D {

data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/import_export/modelimporterplugin.h

@@ -18,7 +18,7 @@ enum SketchUpOptionsDialogResponse {
   IMPORTER_OPTIONS_ACCEPTED = 2      ///< Importer options accepted.
 };
 
-/** Return type of GetImporterBehavior(). */
+/** @brief Return type of GetImporterBehavior(). */
 enum SketchUpModelImporterBehavior {
   IMPORT_MODEL_AT_ORIGIN = 0,     ///< Preserves coordinates of the imported
                                   ///< geometry.
@@ -123,7 +123,7 @@ class SketchUpModelImporterInterface {
   @brief  This performs the conversion from the selected input file to the
           given temporary output file using options set during the
           ShowOptionsDialog method.  The output file is then inserted into
-          the current model using rules defined by the GetImporterBehavior
+          the current model using rules defined by the GetImporterBehavior()
           method.
   @param[in] input                     The user selected input file. The file
                                        name is specified in UTF-8 and may
@@ -143,15 +143,19 @@ class SketchUpModelImporterInterface {
   virtual bool ConvertToSkp(
       const std::string& input, const std::string& output_skp,
       SketchUpPluginProgressCallback* progress, void* reserved) = 0;
+
   /**
   @brief Displays a modal dialog showing an optional summary of the import
-         process.  The default does nothing.  Note that Ruby scripting often
-         disables this dialog.
+         process.
+
+  The default does nothing.
   */
   virtual void ShowSummaryDialog() {
   }
+
   /**
   @brief  Defines the method SketchUp uses when placing the imported model.
+  @return The import behavior SketchUp should use when importing the model.
   */
   virtual SketchUpModelImporterBehavior GetImporterBehavior() const {
     return IMPORT_MODEL_PRESERVE_ORIGIN;

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

@@ -92,10 +92,10 @@ SU_RESULT SUAttributeDictionaryGetName(SUAttributeDictionaryRef dictionary, SUSt
 
 /**
 @brief Inserts a key-value pair into an attribute dictionary object.
-@param[in] dictionary The attribute dictionary object.
-@param[in] key        The key of the key-value pair. Assumed to be UTF-8
-                      encoded.
-@param[in] value_in   The value of the key-value pair.
+@param[in,out] dictionary The attribute dictionary object.
+@param[in]     key        The key of the key-value pair. Assumed to be UTF-8
+                          encoded.
+@param[in]     value_in   The value of the key-value pair.
 @related SUAttributeDictionaryRef
 @return
 - \ref SU_ERROR_NONE on success