scriptup 2024.0.5 → 2024.0.6

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

@@ -0,0 +1,240 @@
+// Copyright 2015 Trimble Navigation Ltd. All rights reserved.
+// This file is intended for public distribution.
+
+#ifndef LAYOUT_MODEL_RECTANGLE_H_
+#define LAYOUT_MODEL_RECTANGLE_H_
+
+#include <LayOutAPI/common.h>
+#include <LayOutAPI/geometry/geometry.h>
+#include <LayOutAPI/model/defs.h>
+
+/**
+@struct LORectangleRef
+@brief References a simple rectangular shape entity.
+*/
+
+/**
+@enum LORectangleType
+@brief Defines the shape of the rectangle within its boundaries.
+*/
+typedef enum {
+  LORectangleType_Normal = 0,  ///< Normal rectangle with 90 degree corners.
+  LORectangleType_Rounded,     ///< Rectangle with rounded corners and a specified radius.
+  LORectangleType_Lozenge,     ///< Rectangle with rounded corners and a radius equal to half the
+                               ///< smaller of width or height.
+  LORectangleType_Bulged,      ///< Rectangle whose left and right sides are arcs with a specified
+                               ///< radius.
+  LONumRectangleTypes
+} LORectangleType;
+
+#ifdef __cplusplus
+extern "C" {
+#endif  // __cplusplus
+
+/**
+@brief Creates a 'normal' rectangle with 90 degree corners.
+@param[out] rectangle The rectangle object.
+@param[in]  bounds    The starting dimensions of the rectangle.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if rectangle is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *rectangle already refers to a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if bounds is NULL
+- \ref SU_ERROR_OUT_OF_RANGE if bounds has a width or height of zero
+*/
+LO_RESULT LORectangleCreate(LORectangleRef* rectangle, const LOAxisAlignedRect2D* bounds);
+
+/**
+@brief Creates a 'rounded' rectangle with arcs in each corner.
+@param[out] rectangle     The rectangle object.
+@param[in]  bounds        The starting dimensions of the rectangle.
+@param[in]  corner_radius The radius of the circles in the corners in inches.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if rectangle is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *rectangle already refers to a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if bounds is NULL
+- \ref SU_ERROR_OUT_OF_RANGE if bounds has a width or height of zero
+- \ref SU_ERROR_OUT_OF_RANGE if corner_radius is negative
+*/
+LO_RESULT LORectangleCreateRounded(
+    LORectangleRef* rectangle, const LOAxisAlignedRect2D* bounds, double corner_radius);
+/**
+@brief Creates a 'Lozenge' rectangle with the shorter side curved.
+@param[out] rectangle The rectangle object.
+@param[in]  bounds    The starting dimensions of the rectangle.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if rectangle is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *rectangle already refers to a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if bounds is NULL
+- \ref SU_ERROR_OUT_OF_RANGE if bounds has a width or height of zero
+*/
+LO_RESULT LORectangleCreateLozenge(LORectangleRef* rectangle, const LOAxisAlignedRect2D* bounds);
+/**
+@brief Creates a 'bulged' rectangle with the vertical sides curved.
+@param[out] rectangle      The rectangle object.
+@param[in]  bounds         The starting dimensions of the rectangle.
+@param[in]  bulge_distance The size of the bulge, from the outer edge of the
+                           rectangle in.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if rectangle is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *rectangle already refers to a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if bounds is NULL
+- \ref SU_ERROR_OUT_OF_RANGE if bounds has a width or height of zero
+- \ref SU_ERROR_OUT_OF_RANGE if bulge_distance is negative
+*/
+LO_RESULT LORectangleCreateBulged(
+    LORectangleRef* rectangle, const LOAxisAlignedRect2D* bounds, double bulge_distance);
+
+/**
+@brief Adds a reference to a rectangle object.
+@param[in] rectangle The rectangle object.
+@return
+SU_ERROR_NONE on success
+SU_ERROR_INVALID_INPUT if rectangle does not refer to a valid object
+*/
+LO_RESULT LORectangleAddReference(LORectangleRef rectangle);
+
+/**
+@brief Releases a rectangle object. The object will be invalidated if releasing
+       the last reference.
+@param[in] rectangle The rectangle object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if rectangle is NULL
+- \ref SU_ERROR_INVALID_INPUT if *rectangle does not refer to a valid object
+*/
+LO_RESULT LORectangleRelease(LORectangleRef* rectangle);
+
+/**
+@brief Converts from a \ref LOEntityRef to a \ref LORectangleRef.
+       This is essentially a downcast operation so the given \ref LOEntityRef
+       must be convertible to a \ref LORectangleRef.
+@param[in] entity The entity object.
+@return
+- The converted \ref LORectangleRef if the downcast operation succeeds
+- If not, the returned reference will be invalid
+*/
+LO_EXPORT LORectangleRef LORectangleFromEntity(LOEntityRef entity);
+
+/**
+@brief Converts from a \ref LORectangleRef to a \ref LOEntityRef.
+       This is essentially an upcast operation.
+@param[in] rectangle The rectangle object.
+@return
+- The converted \ref LOEntityRef if rectangle is a valid object
+- If not, the returned reference will be invalid
+*/
+LO_EXPORT LOEntityRef LORectangleToEntity(LORectangleRef rectangle);
+
+/**
+@brief Gets the point that was originally defined as the upper left point.
+       Transforms to this object may have moved it so that it is no longer the
+       top left point geometrically on the page.
+@param[in]  rectangle The rectangle object.
+@param[out] point     The position of the original top left point.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if rectangle does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if point is NULL
+*/
+LO_RESULT LORectangleGetTopLeftPoint(LORectangleRef rectangle, LOPoint2D* point);
+
+/**
+@brief Gets the point that was originally defined as the upper right point.
+       Transforms to this object may have moved it so that it is no longer the
+       top right point geometrically on the page.
+@param[in]  rectangle The rectangle object.
+@param[out] point     The position of the original top right point.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if rectangle does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if point is NULL
+*/
+LO_RESULT LORectangleGetTopRightPoint(LORectangleRef rectangle, LOPoint2D* point);
+
+/**
+@brief Gets the point that was originally defined as the bottom left point.
+       Transforms to this object may have moved it so that it is no longer the
+       bottom left point geometrically on the page.
+@param[in]  rectangle The rectangle object.
+@param[out] point     The position of the original bottom left point.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if rectangle does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if point is NULL
+*/
+LO_RESULT LORectangleGetBottomLeftPoint(LORectangleRef rectangle, LOPoint2D* point);
+
+/**
+@brief Gets the point that was originally defined as the bottom right point.
+       Transforms to this object may have moved it so that it is no longer the
+       bottom right point geometrically on the page.
+@param[in]  rectangle The rectangle object.
+@param[out] point     The position of the original bottom right point.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if rectangle does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if point is NULL
+*/
+LO_RESULT LORectangleGetBottomRightPoint(LORectangleRef rectangle, LOPoint2D* point);
+
+/**
+@brief Gets the type of a rectangle.
+@param[in]  rectangle The rectangle object.
+@param[out] type      The type of the rectangle.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if rectangle does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if type is NULL
+*/
+LO_RESULT LORectangleGetRectangleType(LORectangleRef rectangle, LORectangleType* type);
+
+/**
+@brief Gets the type of a rectangle.
+@param[in] rectangle The rectangle object.
+@param[in] type      The type of the rectangle.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if rectangle does not refer to a valid object
+- \ref SU_ERROR_LAYER_LOCKED if rectangle is on a locked layer
+- \ref SU_ERROR_ENTITY_LOCKED if rectangle is locked
+- \ref SU_ERROR_GENERIC if type is not a valid rectangle type
+*/
+LO_RESULT LORectangleSetRectangleType(LORectangleRef rectangle, LORectangleType type);
+
+/**
+@brief Returns the radius that defines the shape of a bulged or rounded
+       rectangle.
+@param[in]  rectangle The rectangle object.
+@param[out] radius    The radius for bulged and rounded rectangles.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if rectangle does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if radius is NULL
+- \ref SU_ERROR_NO_DATA if the rectangle is not of type \ref
+  LORectangleType_Bulged or \ref LORectangleType_Rounded
+*/
+LO_RESULT LORectangleGetRadius(LORectangleRef rectangle, double* radius);
+
+/**
+@brief Sets the radius that defines the shape of a bulged or rounded rectangle.
+@param[in]  rectangle The rectangle object.
+@param[out] radius    The radius for bulged and rounded rectangles.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if rectangle does not refer to a valid object
+- \ref SU_ERROR_NO_DATA if the rectangle is not of type \ref
+  LORectangleType_Bulged or \ref LORectangleType_Rounded
+- \ref SU_ERROR_OUT_OF_RANGE if radius is negative
+- \ref SU_ERROR_LAYER_LOCKED if rectangle is on a locked layer
+- \ref SU_ERROR_ENTITY_LOCKED if rectangle is locked
+*/
+LO_RESULT LORectangleSetRadius(LORectangleRef rectangle, double radius);
+
+#ifdef __cplusplus
+}  // end extern "C"
+#endif  // __cplusplus
+#endif  // LAYOUT_MODEL_RECTANGLE_H_

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

@@ -0,0 +1,120 @@
+// Copyright 2022 Trimble Inc. All rights reserved.
+// This file is intended for public distribution.
+
+#ifndef LAYOUT_MODEL_REFERENCEENTITY_H_
+#define LAYOUT_MODEL_REFERENCEENTITY_H_
+
+#include <LayOutAPI/common.h>
+#include <LayOutAPI/model/defs.h>
+
+/**
+@struct LOReferenceEntityRef
+@brief References an entity containing the contents of an imported file.
+@since LayOut 2023, API 8.0
+*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif  // __cplusplus
+
+
+/**
+@brief Adds a reference to a reference entity object.
+@since LayOut 2023, API 8.0
+@param[in] reference_entity The reference entity object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if reference_entity does not refer to a valid object
+*/
+LO_RESULT LOReferenceEntityAddReference(LOReferenceEntityRef reference_entity);
+
+/**
+@brief Releases a reference entity object. The object will be invalidated if releasing the last
+       reference.
+@since LayOut 2023, API 8.0
+@param[in] reference_entity The reference entity object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if reference_entity is NULL
+- \ref SU_ERROR_INVALID_INPUT if *reference_entity does not refer to a valid object
+*/
+LO_RESULT LOReferenceEntityRelease(LOReferenceEntityRef* reference_entity);
+
+/**
+@brief Converts from a \ref LOEntityRef to a \ref LOReferenceEntityRef.
+       This is essentially a downcast operation so the given \ref LOEntityRef
+       must be convertible to a \ref LOReferenceEntityRef.
+@since LayOut 2023, API 8.0
+@param[in] entity The entity object.
+@return
+- The converted \ref LOReferenceEntityRef if the downcast operation succeeds
+- If not, the returned reference will be invalid
+*/
+LO_EXPORT LOReferenceEntityRef LOReferenceEntityFromEntity(LOEntityRef entity);
+
+/**
+@brief Converts from a \ref LOReferenceEntityRef to a \ref LOEntityRef.
+       This is essentially an upcast operation.
+@since LayOut 2023, API 8.0
+@param[in] reference_entity The reference entity object.
+@return
+- The converted \ref LOEntityRef if reference_entity is a valid object
+- If not, the returned reference will be invalid
+*/
+LO_EXPORT LOEntityRef LOReferenceEntityToEntity(LOReferenceEntityRef reference_entity);
+
+/**
+@brief Returns any clip mask assigned to the reference entity.
+@since LayOut 2023, API 8.0
+@param[in]  reference_entity The reference entity object.
+@param[out] clip_mask        The clip mask of the reference entity.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if reference_entity 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 reference entity is not being clipped by a clip mask
+*/
+LO_RESULT LOReferenceEntityGetClipMask(
+    LOReferenceEntityRef reference_entity, LOEntityRef* clip_mask);
+
+/**
+@brief Sets the clip mask of the reference entity. 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 reference entity. 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, or may be
+SU_INVALID, which will remove the existing clip mask, if any.
+@since LayOut 2023, API 8.0
+@param[in] reference_entity The reference entity object.
+@param[in] clip_mask        The new clip mask for the reference entity.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if reference_entity 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 reference_entity is on a locked layer
+- \ref SU_ERROR_ENTITY_LOCKED if reference_entity is locked
+*/
+LO_RESULT LOReferenceEntitySetClipMask(
+    LOReferenceEntityRef reference_entity, LOEntityRef clip_mask);
+
+/**
+@brief Creates the entities that represent the reference entity in its exploded form and adds them
+to a \ref LOEntityListRef. It is NOT necessary to explicitly release these entities, since \ref
+       LOEntityListRef itself adds a reference to the entities and will release them when they are
+       removed from the list or when the list is released.
+@since LayOut 2023, API 8.0
+@param[in] reference_entity The reference entity object.
+@param[in] entity_list      The entity list object to add the new entities to.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if reference_entity does not refer to a valid object
+- \ref SU_ERROR_INVALID_INPUT if entity_list does not refer to a valid object
+*/
+LO_RESULT LOReferenceEntityGetExplodedEntities(
+    LOReferenceEntityRef reference_entity, LOEntityListRef entity_list);
+
+#ifdef __cplusplus
+}  // end extern "C"
+#endif  // __cplusplus
+#endif  // LAYOUT_MODEL_REFERENCEENTITY_H_