scriptup 2024.0.5 → 2024.0.6

data/sketchup-sdk-win/headers/LayOutAPI/model/group.h

@@ -0,0 +1,243 @@
+// Copyright 2015 Trimble Navigation Ltd. All rights reserved.
+// This file is intended for public distribution.
+
+#ifndef LAYOUT_MODEL_GROUP_H_
+#define LAYOUT_MODEL_GROUP_H_
+
+#include <LayOutAPI/common.h>
+#include <LayOutAPI/model/defs.h>
+#include <LayOutAPI/model/document.h>
+
+/**
+@struct LOGroupRef
+@brief References a group entity. A group is a special type of entity that
+       does not belong to a layer and contains other entities as children. A
+       group's children may include other groups, allowing for a hierarchical
+       tree structure of entities. A group must contain at least one child
+       and will be automatically collapsed if an operation is performed that
+       results in the group being empty.
+*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif  // __cplusplus
+
+/**
+@enum LOGroupResizeBehaviorType
+@brief Defines the different types of resize behavior when scale is changed.
+*/
+typedef enum {
+  LOGroupResizeBehaviorType_None = 0,       /// Group is not resized.
+  LOGroupResizeBehaviorType_Bounds,         /// Entity bounds are resized.
+  LOGroupResizeBehaviorType_BoundsAndFonts  /// Bounds and fonts are resized.
+} LOGroupResizeBehaviorType;
+
+/**
+@brief Creates a new group object, populating it with the entities in the given
+       \ref LOEntityListRef. It is possible to create a group from entities
+       that are already in a document, as well as from entities that are not
+       yet in a document. For entities that are already in a document, they can
+       only be grouped if they all belong to shared layers, or all belong to
+       non-shared layers on the same page. If the entities are in a document,
+       then the new group will be added to the document at the top of the group
+       hierarchy.
+@param[out] group       The group object.
+@param[in]  entity_list The list of entities to add to the group.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if group is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *group already refers to a valid object
+- \ref SU_ERROR_INVALID_INPUT if entity_list does not refer to a valid object
+- \ref SU_ERROR_GENERIC if entity_list is empty
+- \ref SU_ERROR_GENERIC if entity_list contains entities that belong to
+  different documents
+- \ref SU_ERROR_GENERIC if entity_list contains a mix of entities that belong
+  to a document and entities that don't belong to a document
+- \ref SU_ERROR_GENERIC if entity_list contains entities on both shared
+  and non-shared layers, or on non-shared layers belonging to different pages.
+- \ref SU_ERROR_GENERIC if entity_list contains the same entity more than
+  once.
+*/
+LO_RESULT LOGroupCreate(LOGroupRef* group, LOEntityListRef entity_list);
+
+/**
+@brief Adds a reference to a group object.
+@param[in] group The group object.
+@return
+SU_ERROR_NONE on success
+SU_ERROR_INVALID_INPUT if group does not refer to a valid object
+*/
+LO_RESULT LOGroupAddReference(LOGroupRef group);
+
+/**
+@brief Releases a group object. The object will be invalidated if
+       releasing the last reference.
+@param[in] group The group object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if group is NULL
+- \ref SU_ERROR_INVALID_INPUT if *group does not refer to a valid object
+*/
+LO_RESULT LOGroupRelease(LOGroupRef* group);
+
+/**
+@brief Converts from a \ref LOEntityRef to a \ref LOGroupRef.
+       This is essentially a downcast operation so the given \ref LOEntityRef
+       must be convertible to a \ref LOGroupRef.
+@param[in] entity The entity object.
+@return
+- The converted \ref LOGroupRef if the downcast operation succeeds
+- If not, the returned reference will be invalid
+*/
+LO_EXPORT LOGroupRef LOGroupFromEntity(LOEntityRef entity);
+
+/**
+@brief Converts from a \ref LOGroupRef to a \ref LOEntityRef.
+       This is essentially an upcast operation.
+@param[in] group The group object.
+@return
+- The converted \ref LOEntityRef if group is a valid object
+- If not, the returned reference will be invalid
+*/
+LO_EXPORT LOEntityRef LOGroupToEntity(LOGroupRef group);
+
+/**
+@brief Removes all the entities from a group and removes the empty group. The
+       entities will become children of the group's parent. *group will be set
+       to invalid by this function.
+@param[in] group The group object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if group is NULL
+- \ref SU_ERROR_INVALID_INPUT if *group does not refer to a valid object
+- \ref SU_ERROR_ENTITY_LOCKED if group is locked
+*/
+LO_RESULT LOGroupUngroup(LOGroupRef* group);
+
+/**
+@brief Populates a \ref LOEntityListRef object with all the children of a group.
+@param[in] group       The group object.
+@param[in] entity_list The entity list object to populate with the group's
+                       children.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if group does not refer to a valid object
+- \ref SU_ERROR_INVALID_INPUT if entity_list does not refer to a valid object
+*/
+LO_RESULT LOGroupGetEntities(LOGroupRef group, LOEntityListRef entity_list);
+
+/**
+@brief Gets the number of children within a group.
+@param[in]  group        The group object.
+@param[out] num_entities The number of children in the group.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if group does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if num_entities is NULL
+*/
+LO_RESULT LOGroupGetNumberOfEntities(LOGroupRef group, size_t* num_entities);
+
+/**
+@brief Gets the child at the given index from within a group.
+@param[in]  group        The group object.
+@param[in]  index        The index of the child entity to get.
+@param[out] child_entity The child entity object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if group does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if child_entity is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *child_entity already refers to a valid
+  object
+*/
+LO_RESULT LOGroupGetEntityAtIndex(LOGroupRef group, size_t index, LOEntityRef* child_entity);
+
+/**
+@brief Gets the scale factor set on a group.
+@since LayOut 2018, API 3.0
+@param[in]  group         The group object.
+@param[out] scale_factor  The scale factor of the group.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if group does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if scale_context is NULL
+- \ref SU_ERROR_NO_DATA if group does not have a scale factor set.
+*/
+LO_RESULT LOGroupGetScaleFactor(LOGroupRef group, double* scale_factor);
+
+/**
+@brief Sets the scale factor on a group.
+@since LayOut 2018, API 3.0
+@param[in] group           The group object.
+@param[in] scale_factor    The scale factor to set.
+@param[in] units           The units format to use.
+@param[in] resize_behavior How entities in the group should adjust
+                           to the new scale.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if group does not refer to a valid object
+- \ref SU_ERROR_UNSUPPORTED if group already effectively has a scale from
+  a parent or sub-group.
+- \ref SU_ERROR_LAYER_LOCKED if group is on a locked layer
+- \ref SU_ERROR_ENTITY_LOCKED if group is locked
+*/
+LO_RESULT LOGroupSetScaleFactor(
+    LOGroupRef group, double scale_factor, LODocumentUnits units,
+    LOGroupResizeBehaviorType resize_behavior);
+
+/**
+@brief Returns the scale units for a group.
+@since LayOut 2018, API 3.0
+@param[in]  group     The group object.
+@param[out] units     The unit format for the group.
+@param[out] precision The units precision. This is expressed as a value in the
+                      current units.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if group does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if units is NULL
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if precision is NULL
+- \ref SU_ERROR_NO_DATA if this specific group does not have a scale factor set.
+*/
+LO_RESULT LOGroupGetScaleUnits(LOGroupRef group, LODocumentUnits* units, double* precision);
+
+/**
+@brief Sets the units format on a group.
+@since LayOut 2018, API 3.0
+@param[in] group The group object.
+@param[in] units The units format to use.
+@param[in] precision The units precision. This is expressed as a value in the
+                     specified units. LayOut only allows for a finite set of
+                     precision values for each units setting, so it will set
+                     the precision to the closest valid setting for the
+                     specified units. See the "Units" section of LayOut's
+                     "Document Setup" dialog for a reference of the available
+                     precisions for each units setting.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if group does not refer to a valid object
+- \ref SU_ERROR_LAYER_LOCKED if group is on a locked layer
+- \ref SU_ERROR_ENTITY_LOCKED if group is locked
+- \ref SU_ERROR_UNSUPPORTED if group does not have a scale factor set.
+*/
+LO_RESULT LOGroupSetScaleUnits(LOGroupRef group, LODocumentUnits units, double precision);
+
+/**
+@brief Removes the scale factor of a group.
+@since LayOut 2018, API 3.0
+@param[in] group           The group object.
+@param[in] resize_behavior How entities in the group should adjust
+                           to the new scale.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if group does not refer to a valid object
+- \ref SU_ERROR_LAYER_LOCKED if group is on a locked layer
+- \ref SU_ERROR_ENTITY_LOCKED if group is locked
+- \ref SU_ERROR_UNSUPPORTED if group does not have a scale factor set.
+*/
+LO_RESULT LOGroupRemoveScaleFactor(LOGroupRef group, LOGroupResizeBehaviorType resize_behavior);
+
+#ifdef __cplusplus
+}  // end extern C
+#endif  // __cplusplus
+
+#endif  // LAYOUT_MODEL_GROUP_H_

data/sketchup-sdk-win/headers/LayOutAPI/model/image.h

@@ -0,0 +1,146 @@
+// Copyright 2015 Trimble Navigation Ltd. All rights reserved.
+// This file is intended for public distribution.
+
+#ifndef LAYOUT_MODEL_IMAGE_H_
+#define LAYOUT_MODEL_IMAGE_H_
+
+#include <LayOutAPI/common.h>
+#include <LayOutAPI/geometry/geometry.h>
+#include <LayOutAPI/model/defs.h>
+
+/**
+@struct LOImageRef
+@brief References a raster image entity.
+*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif  // __cplusplus
+
+/**
+@brief Creates a new image object from an image file on disk.
+@param[out] image     The image object.
+@param[in]  bounds    The bounding box for the image.
+@param[in]  file_path The file path to the image on disk.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if image is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *image already refers to a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if bounds is NULL
+- \ref SU_ERROR_NULL_POINTER_INPUT if file_path is NULL
+- \ref SU_ERROR_OUT_OF_RANGE if bounds has a width or height of zero
+- \ref SU_ERROR_SERIALIZATION if there was an error reading the image file or
+  allocating the memory for the image
+- \ref SU_ERROR_NO_DATA if the image file could not be found
+*/
+LO_RESULT LOImageCreateFromFile(
+    LOImageRef* image, const LOAxisAlignedRect2D* bounds, const char* file_path);
+
+/**
+@brief Adds a reference to an image object.
+@param[in] image The image object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if image does not refer to a valid object
+*/
+LO_RESULT LOImageAddReference(LOImageRef image);
+
+/**
+@brief Releases an image object. The object will be invalidated if
+       releasing the last reference.
+@param[in] image The image object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if image is NULL
+- \ref SU_ERROR_INVALID_INPUT if *image does not refer to a valid object
+*/
+LO_RESULT LOImageRelease(LOImageRef* image);
+
+/**
+@brief Converts from a \ref LOEntityRef to a \ref LOImageRef.
+       This is essentially a downcast operation so the given \ref LOEntityRef
+       must be convertible to a \ref LOImageRef.
+@param[in] entity The entity object.
+@return
+- The converted \ref LOImageRef if the downcast operation succeeds
+- If not, the returned reference will be invalid
+*/
+LO_EXPORT LOImageRef LOImageFromEntity(LOEntityRef entity);
+
+/**
+@brief Converts from a \ref LOImageRef to a \ref LOEntityRef.
+       This is essentially an upcast operation.
+@param[in] image The image object.
+@return
+- The converted \ref LOEntityRef if image is a valid object
+- If not, the returned reference will be invalid
+*/
+LO_EXPORT LOEntityRef LOImageToEntity(LOImageRef image);
+
+/**
+@brief Gets an image object's image representation.
+@param[in]  image    The image object.
+@param[out] imagerep The image representation object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if image does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if imagerep is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *imagerep already refers to a valid object
+*/
+LO_RESULT LOImageGetImageRep(LOImageRef image, LOImageRepRef* imagerep);
+
+/**
+@brief Gets an image object's image representation in the document's output resolution.
+
+This should be used by exporters to retrieve the image data at the quality set by \ref
+LOPageInfoSetImageOutputResolution.
+@since LayOut 2023.1, API 8.1
+@param[in]  image    The image object.
+@param[out] imagerep The image representation object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if \p image does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if \p imagerep is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if \p imagerep already refers to a valid object
+*/
+LO_RESULT LOImageGetOutputImageRep(LOImageRef image, LOImageRepRef* imagerep);
+
+/**
+@brief Returns any clip mask assigned to the image.
+@param[in]  image     The image object.
+@param[out] clip_mask The clip mask of the image.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if image does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if clip_mask is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *clip_mask already refers to a valid object
+- \ref SU_ERROR_NO_DATA if the image is not being clipped by a clip mask
+*/
+LO_RESULT LOImageGetClipMask(LOImageRef image, LOEntityRef* clip_mask);
+
+/**
+@brief Sets the clip mask of the image. A clip mask defines a region
+       of the entity that is visible. This allows you to crop with arbitrary
+       shapes. This operation will replace any clip mask that is already
+       assigned to this image. The entity being used must not be already part
+       of a document or group. The clip mask entity must be either a
+       rectangle, ellipse or a path.
+@note  Starting in LayOut 2020.1, API 5.1, clip_mask may be SU_INVALID, which
+       will remove the existing clip mask, if any.
+@since LayOut 2017, API 2.0
+@param[in] image     The image object.
+@param[in] clip_mask The new clip mask for the image.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if image does not refer to a valid object
+- \ref SU_ERROR_INVALID_ARGUMENT if clip_mask is already in a document or group
+- \ref SU_ERROR_UNSUPPORTED if clip_mask is not a rectangle, ellipse, or path
+- \ref SU_ERROR_LAYER_LOCKED if image is on a locked layer
+- \ref SU_ERROR_ENTITY_LOCKED if image is locked
+*/
+LO_RESULT LOImageSetClipMask(LOImageRef image, LOEntityRef clip_mask);
+
+#ifdef __cplusplus
+}  // end extern "C"
+#endif  // __cplusplus
+#endif  // LAYOUT_MODEL_IMAGE_H_

data/sketchup-sdk-win/headers/LayOutAPI/model/imagerep.h

@@ -0,0 +1,109 @@
+// Copyright 2015 Trimble Navigation Ltd. All rights reserved.
+// This file is intended for public distribution.
+
+#ifndef LAYOUT_MODEL_IMAGEREP_H_
+#define LAYOUT_MODEL_IMAGEREP_H_
+
+#include <LayOutAPI/common.h>
+#include <LayOutAPI/model/defs.h>
+#include <SketchUpAPI/color.h>
+
+/**
+@enum LOImageRepOutputFormat
+@brief Represents the file formats that an image representation can be saved as
+       when saving to a file.
+*/
+typedef enum {
+  LOImageRepOutputFormat_PNG = 0,  ///< PNG file format.
+  LOImageRepOutputFormat_JPG,      ///< JPG file format.
+  LONumImageRepOutputFormats
+} LOImageRepOutputFormat;
+
+/**
+@struct LOImageRepRef
+@brief References the bitmap representation for a raster image.
+*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif  // __cplusplus
+
+/**
+@brief Gets the dimensions in pixels of an image representation.
+@param[in]  imagerep The image representation object.
+@param[out] width    The width of the image.
+@param[out] height   The height of the image.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if imagerep does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if width is NULL
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if height is NULL
+*/
+LO_RESULT LOImageRepGetPixelDimensions(LOImageRepRef imagerep, size_t* width, size_t* height);
+
+/**
+@brief Gets the DPI of an image representation.
+@since LayOut 2018, API 3.0
+@param[in]  imagerep The image representation object.
+@param[out] x_dpi    The DPI in horizontal direction.
+@param[out] y_dpi    The DPI in vertical direction.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if imagerep does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if x_dpi is NULL
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if y_dpi is NULL
+*/
+LO_RESULT LOImageRepGetDPI(LOImageRepRef imagerep, double* x_dpi, double* y_dpi);
+
+/**
+@brief  Returns the total size and bits-per-pixel value of an image
+       representation. This function is useful to determine the size of the
+       buffer necessary to be passed into \ref LOImageRepGetData. The returned
+       data can be used along with the returned bits-per-pixel value and the
+       image dimensions to compute RGBA values at individual pixels of the
+       image.
+@param[in]  imagerep       The image representation object.
+@param[out] data_size      The total size of the image data in bytes.
+@param[out] bits_per_pixel The number of bits per pixel of the image data.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if imagerep is an invalid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if data_size or bits_per_pixel is NULL
+*/
+LO_RESULT LOImageRepGetDataSize(LOImageRepRef imagerep, size_t* data_size, size_t* bits_per_pixel);
+
+/**
+@brief Returns the pixel data for an image representation. The given array
+       must be large enough to hold the image representation's data. This size
+       can be obtained by calling \ref LOImageRepGetDataSize.
+@param[in]  imagerep   The image representation object.
+@param[in]  data_size  The size of the byte array.
+@param[out] pixel_data The image data retrieved.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if imagerep is an invalid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if pixel_data is NULL
+- \ref SU_ERROR_INSUFFICIENT_SIZE if data_size is insufficient for the image
+  data
+*/
+LO_RESULT LOImageRepGetData(LOImageRepRef imagerep, size_t data_size, SUByte pixel_data[]);
+
+/**
+@brief Saves the image representation to the file at the indicated path.
+@param[in] imagerep The image representation object.
+@param[in] filename The file path to where the image should go on disk.
+@param[in] format   What format to save the image as.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if imagerep is invalid
+- \ref SU_ERROR_NULL_POINTER_INPUT if filename is NULL
+- \ref SU_ERROR_SERIALIZATION if there was an error writing the image file
+*/
+LO_RESULT LOImageRepSaveAs(
+    LOImageRepRef imagerep, const char* filename, LOImageRepOutputFormat format);
+
+#ifdef __cplusplus
+}  // end extern "C"
+#endif  // __cplusplus
+
+#endif  // LAYOUT_MODEL_IMAGEREP_H_