scriptup 2024.0.5 → 2024.0.7

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

@@ -0,0 +1,81 @@
+// Copyright 2015 Trimble Navigation Ltd. All rights reserved.
+// This file is intended for public distribution.
+
+#ifndef LAYOUT_MODEL_PAGE_LIST_H_
+#define LAYOUT_MODEL_PAGE_LIST_H_
+
+#include <LayOutAPI/common.h>
+#include <LayOutAPI/model/defs.h>
+
+/**
+@struct LOPageListRef
+@brief References an ordered, indexable list of \ref LOPageRef objects.
+*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif  // __cplusplus
+
+/**
+@brief Creates a new empty page list object.
+@param[out] page_list An empty page list object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if page_list is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *page_list already refers to a valid object
+*/
+LO_RESULT LOPageListCreate(LOPageListRef* page_list);
+
+/**
+@brief Releases a page list object. *page_list will be set to invalid by this
+       function.
+@param[in] page_list The page list object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if page_list does not refer to a valid
+  object
+- \ref SU_ERROR_INVALID_INPUT if *page_list does not refer to a valid object
+*/
+LO_RESULT LOPageListRelease(LOPageListRef* page_list);
+
+/**
+@brief Gets the number of pages in this list.
+@param[in]  page_list The page list object.
+@param[out] num_pages The number of page objects in the list.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if page_list does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if num_pages is NULL
+*/
+LO_RESULT LOPageListGetNumberOfPages(LOPageListRef page_list, size_t* num_pages);
+
+/**
+@brief Gets the page at the specified index.
+@param[in]  page_list The page list object.
+@param[in]  index     The index of the page to get.
+@param[out] page      The page object at index in the list.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if page_list does not refer to a valid object
+- \ref SU_ERROR_OUT_OF_RANGE if index is out of range for this list
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if page is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *page already refers to a valid object
+*/
+LO_RESULT LOPageListGetPageAtIndex(LOPageListRef page_list, size_t index, LOPageRef* page);
+
+/**
+@brief Adds a page at the end of the list.
+@param[in] page_list The page list object.
+@param[in] page      The page object to add.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if page_list does not refer to a valid object
+- \ref SU_ERROR_INVALID_INPUT if page does not refer to a valid object
+*/
+LO_RESULT LOPageListAddPage(LOPageListRef page_list, LOPageRef page);
+
+#ifdef __cplusplus
+}  // end extern "C"
+#endif  // __cplusplus
+
+#endif  // LAYOUT_MODEL_PAGE_LIST_H_

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

@@ -0,0 +1,464 @@
+// Copyright 2015 Trimble Navigation Ltd. All rights reserved.
+// This file is intended for public distribution.
+
+#ifndef LAYOUT_MODEL_PATH_H_
+#define LAYOUT_MODEL_PATH_H_
+
+#include <LayOutAPI/common.h>
+#include <LayOutAPI/geometry/geometry.h>
+#include <LayOutAPI/model/defs.h>
+
+/**
+@struct LOPathRef
+@brief References a path entity. A path entity represents a continuous,
+       multi-segment polyline or Bezier curve.
+*/
+
+/**
+@enum LOPathPointType
+@brief Defines how a point is to be interpreted in a path entity.
+*/
+typedef enum {
+  LOPathPointType_MoveTo = 0,     ///< Reserved for the first point in a path.
+  LOPathPointType_LineTo,         ///< Straight line segment to a given point.
+  LOPathPointType_BezierTo,       ///< Bezier line segment to a given point.
+  LOPathPointType_ArcCenter,      ///< Control point that defines the center of an arc.
+  LOPathPointType_BezierControl,  ///< Control point that defines Bezier curvature.
+  LOPathPointType_Close,  ///< Close the path with a straight line segment back to the first point.
+  LONumPathPointTypes
+} LOPathPointType;
+
+/**
+@enum LOPathWindingType
+@brief Defines the winding direction of the path.
+@since LayOut 2019, API 4.0
+*/
+typedef enum {
+  LOPathWindingType_None = 0,
+  LOPathWindingType_Clockwise,
+  LOPathWindingType_CounterClockwise,
+  LONumPathWindingTypes
+} LOPathWindingType;
+
+#ifdef __cplusplus
+extern "C" {
+#endif  // __cplusplus
+
+/**
+@brief Creates a new path object with a straight line between start_point and
+       end_point.
+@param[out] path        The path object.
+@param[in]  start_point The starting point of the path.
+@param[in]  end_point   The ending point of the path.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if path is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *path already refers to a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if start_point is NULL
+- \ref SU_ERROR_NULL_POINTER_INPUT if end_point is NULL
+- \ref SU_ERROR_GENERIC if the path would be zero length
+*/
+LO_RESULT LOPathCreate(LOPathRef* path, const LOPoint2D* start_point, const LOPoint2D* end_point);
+
+/**
+@brief Creates a new path object with a Bezier curve between start_point and
+       end_point.
+@param[out] path            The path object.
+@param[in]  start_point     The starting point of the path.
+@param[in]  control_point_1 The first control point.
+@param[in]  control_point_2 The second control point.
+@param[in]  end_point       The ending point of the path.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if path is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *path already refers to a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if start_point is NULL
+- \ref SU_ERROR_NULL_POINTER_INPUT if control_point_1 is NULL
+- \ref SU_ERROR_NULL_POINTER_INPUT if control_point_2 is NULL
+- \ref SU_ERROR_NULL_POINTER_INPUT if end_point is NULL
+- \ref SU_ERROR_GENERIC if the path would be zero length
+*/
+LO_RESULT LOPathCreateBezier(
+    LOPathRef* path, const LOPoint2D* start_point, const LOPoint2D* control_point_1,
+    const LOPoint2D* control_point_2, const LOPoint2D* end_point);
+
+/**
+@brief Creates a new path object representing the same shape as a rectangle
+       object.
+@param[out] path      The path object.
+@param[in]  rectangle The rectangle object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if path is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *path already refers to a valid object
+- \ref SU_ERROR_INVALID_INPUT if rectangle does not refer to a valid object
+*/
+LO_RESULT LOPathCreateFromRectangle(LOPathRef* path, LORectangleRef rectangle);
+
+/**
+@brief Creates a new path object representing the same shape as an ellipse
+       object.
+@param[out] path    The path object.
+@param[in]  ellipse The ellipse object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if path is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *path already refers to a valid object
+- \ref SU_ERROR_INVALID_INPUT if ellipse does not refer to a valid object
+*/
+LO_RESULT LOPathCreateFromEllipse(LOPathRef* path, LOEllipseRef ellipse);
+
+/**
+@brief Creates a new path object representing an arc.
+@since LayOut 2017, API 2.0
+@param[out] path         The path object.
+@param[in]  center_point The center point of the arc.
+@param[in]  radius       The radius of the arc.
+@param[in]  start_angle  The start angle of the arc.
+@param[in]  end_angle    The end angle of the arc.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if path is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *path already refers to a valid object
+- \ref SU_ERROR_OUT_OF_RANGE if radius is less than or equal to zero
+- \ref SU_ERROR_OUT_OF_RANGE if start_angle is equal to end_angle
+*/
+LO_RESULT LOPathCreateArc(
+    LOPathRef* path, const LOPoint2D* center_point, double radius, double start_angle,
+    double end_angle);
+
+/**
+@brief Adds a reference to a path object.
+@param[in] path The path object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if path does not refer to a valid object
+*/
+LO_RESULT LOPathAddReference(LOPathRef path);
+
+/**
+@brief Releases a path object. The object will be invalidated if releasing the
+       last reference.
+@param[in] path The path object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if path is NULL
+- \ref SU_ERROR_INVALID_INPUT if *path does not refer to a valid object
+*/
+LO_RESULT LOPathRelease(LOPathRef* path);
+
+/**
+@brief Converts from a \ref LOEntityRef to a \ref LOPathRef.
+       This is essentially a downcast operation so the given \ref LOEntityRef
+       must be convertible to a \ref LOPathRef.
+@param[in] entity The entity object.
+@return
+- The converted \ref LOPathRef if the downcast operation succeeds
+- If not, the returned reference will be invalid
+*/
+LO_EXPORT LOPathRef LOPathFromEntity(LOEntityRef entity);
+
+/**
+@brief Converts from a \ref LOPathRef to a \ref LOEntityRef.
+       This is essentially an upcast operation.
+@param[in] path The path object.
+@return
+- The converted \ref LOEntityRef if path is a valid object
+- If not, the returned reference will be invalid
+*/
+LO_EXPORT LOEntityRef LOPathToEntity(LOPathRef path);
+
+/**
+@brief Gets the number of points in the path.
+@param[in]  path The path object.
+@param[out] size The number of points in the path.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if path does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if size is NULL
+*/
+LO_RESULT LOPathGetNumberOfPoints(LOPathRef path, size_t* size);
+
+/**
+@brief Gets the points in the path.
+@param[in]  path                    The path object.
+@param[in]  points_size             The maximum number of points to copy.
+@param[out] points                  The array that the points will be copied to.
+@param[out] number_of_points_copied The number of points actually copied.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if path does not refer to a valid object
+- \ref SU_ERROR_OUT_OF_RANGE if points_size is less than 1
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if points is NULL
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if points_copied is NULL
+*/
+LO_RESULT LOPathGetPoints(
+    LOPathRef path, size_t points_size, LOPoint2D points[], size_t* number_of_points_copied);
+
+/**
+@brief Gets the point in the path at the given index.
+@param[in]  path          The path object.
+@param[in]  point_index   The index of the point to get.
+@param[out] point         The point at the given index.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if path does not refer to a valid object
+- \ref SU_ERROR_OUT_OF_RANGE if point_index is out of range
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if point is NULL
+*/
+LO_RESULT LOPathGetPointAtIndex(LOPathRef path, size_t point_index, LOPoint2D* point);
+
+/**
+@brief Gets the type of each point in the path.
+@param[in]  path                        The path object.
+@param[in]  pointtypes_size             The maximum number of point types to
+                                        copy.
+@param[out] pointtypes                  The array that the point types will be
+                                        copied to.
+@param[out] number_of_pointtypes_copied The number of point types actually
+                                        copied.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if path does not refer to a valid object
+- \ref SU_ERROR_OUT_OF_RANGE if pointtypes_size is less than 1
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if pointtypes is NULL
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if number_of_pointtypes_copied is NULL
+*/
+LO_RESULT LOPathGetPointTypes(
+    LOPathRef path, size_t pointtypes_size, LOPathPointType pointtypes[],
+    size_t* number_of_pointtypes_copied);
+
+/**
+@brief Gets the type of the specified point in the path.
+@param[in]  path        The path object.
+@param[in]  point_index The index of the point to get type information of.
+@param[out] pointtype   The point type.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if path does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if pointtype is NULL
+*/
+LO_RESULT LOPathGetPointTypeAtIndex(LOPathRef path, size_t point_index, LOPathPointType* pointtype);
+
+/**
+@brief Gets the start point for the path.
+@param[in]  path  The path object.
+@param[out] point The start point.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if path does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if point is NULL
+*/
+LO_RESULT LOPathGetStartPoint(LOPathRef path, LOPoint2D* point);
+
+/**
+@brief Gets the end point for the path.
+@param[in]  path  The path object.
+@param[out] point The end point.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if path does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if point is NULL
+*/
+LO_RESULT LOPathGetEndPoint(LOPathRef path, LOPoint2D* point);
+
+/**
+@brief Creates a new path object in the shape of the start arrow of the given
+       path.
+@param[out] arrow_path The start arrow as a path.
+@param[in]  path       The path object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if arrow_path is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *arrow_path already refers to a valid object
+- \ref SU_ERROR_INVALID_INPUT if path does not refer to a valid object
+- \ref SU_ERROR_NO_DATA if path does not have a start arrow
+*/
+LO_RESULT LOPathCreateFromStartArrow(LOPathRef* arrow_path, LOPathRef path);
+
+/**
+@brief Creates a new path object in the shape of the end arrow of the given
+       path.
+@param[out] arrow_path The end arrow as a path.
+@param[in]  path       The path object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if arrow_path is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *arrow_path already refers to a valid object
+- \ref SU_ERROR_INVALID_INPUT if path does not refer to a valid object
+- \ref SU_ERROR_NO_DATA if path does not have an end arrow
+*/
+LO_RESULT LOPathCreateFromEndArrow(LOPathRef* arrow_path, LOPathRef path);
+
+/**
+@brief Gets whether or not the path is a closed loop.
+@param[in]  path      The path object.
+@param[out] is_closed Whether the path is closed or not.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if path does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if is_closed is NULL
+*/
+LO_RESULT LOPathGetClosed(LOPathRef path, bool* is_closed);
+
+/**
+@brief Gets the length of the path.
+@param[in]  path              The path object.
+@param[out] parametric_length The length of the path.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if path does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if parametric_length is NULL
+*/
+LO_RESULT LOPathGetParametricLength(LOPathRef path, double* parametric_length);
+
+/**
+@brief Gets the point at the given distance along the path.
+@param[in]  path             The path object.
+@param[in]  parametric_value The distance along the path to get the point.
+@param[out] point            The point at the given distance along the path.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if path does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if point is NULL
+- \ref SU_ERROR_OUT_OF_RANGE if parametric_value is less than 0 or greater than
+  the path's parametric length
+*/
+LO_RESULT LOPathGetPointAtParameter(LOPathRef path, double parametric_value, LOPoint2D* point);
+
+/**
+@brief Gets the tangent at the given distance along the path.
+@param[in]  path             The path object.
+@param[in]  parametric_value The distance along the path to get the tangent.
+@param[out] tangent          The tangent at the given distane along the path.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if path does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if tangent is NULL
+- \ref SU_ERROR_OUT_OF_RANGE if parametric_value is less than 0 or greater than
+  the path's parametric length
+*/
+LO_RESULT LOPathGetTangentAtParameter(LOPathRef path, double parametric_value, LOVector2D* tangent);
+
+/**
+@brief Gets whether or not the path represents a circle, and if so, gets the
+       geometric representation of the circle.
+@since LayOut 2017, API 2.0
+@param[in]  path      The path object.
+@param[out] is_circle Whether or not the path is a circle.
+@param[out] center    Center point of the circle. Will only be set if is_circle
+                      returns true.
+@param[out] radius    Radius of the circle. Will only be set if is_circle
+                      returns true.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if path does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if is_circle is NULL
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if center is NULL
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if radius is NULL
+*/
+LO_RESULT LOPathGetCircle(LOPathRef path, bool* is_circle, LOPoint2D* center, double* radius);
+
+/**
+@brief Gets whether or not the path represents an arc, and if so, gets the
+       geometric representation of the arc.
+@since LayOut 2017, API 2.0
+@param[in]  path        The path object.
+@param[out] is_arc      Whether or not the path is an arc.
+@param[out] center      Center point of the arc. Will only be set if is_arc
+                        returns true.
+@param[out] radius      Radius of the arc. Will only be set if is_arc returns
+                        true.
+@param[out] start_angle Start angle of the arc. Will only be set if is_arc
+                        returns true.
+@param[out] end_angle   End angle of the arc. Will only be set if is_arc
+                        returns true.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if path does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if is_arc is NULL
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if center is NULL
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if radius is NULL
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if start_angle is NULL
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if end_angle is NULL
+*/
+LO_RESULT LOPathGetArc(
+    LOPathRef path, bool* is_arc, LOPoint2D* center, double* radius, double* start_angle,
+    double* end_angle);
+
+/**
+@brief Adds a point to the end of the path.
+@param[in] path  The path object.
+@param[in] point The point to append.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if path does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if point is NULL
+- \ref SU_ERROR_LAYER_LOCKED if path is on a locked layer
+- \ref SU_ERROR_ENTITY_LOCKED if path is locked
+*/
+LO_RESULT LOPathAppendLineTo(LOPathRef path, const LOPoint2D* point);
+
+/**
+@brief Adds a Bezier point to the end of the path.
+@param[in]  path            The path object.
+@param[in]  control_point_1 The first control point.
+@param[in]  control_point_2 The second control point.
+@param[in]  point           The point to append.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if path does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if control_point_1 is NULL
+- \ref SU_ERROR_NULL_POINTER_INPUT if control_point_2 is NULL
+- \ref SU_ERROR_NULL_POINTER_INPUT if point is NULL
+- \ref SU_ERROR_LAYER_LOCKED if path is on a locked layer
+- \ref SU_ERROR_ENTITY_LOCKED if path is locked
+*/
+LO_RESULT LOPathAppendBezierTo(
+    LOPathRef path, const LOPoint2D* control_point_1, const LOPoint2D* control_point_2,
+    const LOPoint2D* point);
+
+/**
+@brief Appends two paths. This will duplicate other_path and append it to the path.
+       Note that path may be reversed as a result of this operation.
+@since LayOut 2018, API 3.0
+@param[in]  path       The path object.
+@param[in]  other_path The path to append to path.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if path or other_path do not refer to valid objects
+- \ref SU_ERROR_LAYER_LOCKED if path is on a locked layer
+- \ref SU_ERROR_ENTITY_LOCKED if path is locked
+- \ref SU_ERROR_INVALID_ARGUMENT if path and other_path are the same object
+- \ref SU_ERROR_UNSUPPORTED if path and other_path do not share a common endpoint
+*/
+LO_RESULT LOPathAppendPathTo(LOPathRef path, LOPathRef other_path);
+
+/**
+@brief Finishes the path loop if the path is not closed.
+@param[in] path The path object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if path does not refer to a valid object
+- \ref SU_ERROR_GENERIC if path has already been closed.
+- \ref SU_ERROR_LAYER_LOCKED if path is on a locked layer
+- \ref SU_ERROR_ENTITY_LOCKED if path is locked
+*/
+LO_RESULT LOPathClose(LOPathRef path);
+
+/**
+@brief Returns the winding type of the path.
+@since LayOut 2019, API 4.0
+@param[in]  path    The path object.
+@param[out] winding The winding type of the path.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if path does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if winding is NULL
+*/
+LO_RESULT LOPathGetWindingType(LOPathRef path, LOPathWindingType* winding);
+
+#ifdef __cplusplus
+}  // end extern "C"
+#endif  // __cplusplus
+#endif  // LAYOUT_MODEL_PATH_H_