scriptup 0.0.0

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

@@ -0,0 +1,244 @@
+// Copyright 2013 Trimble Inc. All Rights Reserved.
+
+/**
+ * @file
+ * @brief Interfaces for SUGroupRef.
+ */
+#ifndef SKETCHUP_MODEL_GROUP_H_
+#define SKETCHUP_MODEL_GROUP_H_
+
+#include <SketchUpAPI/common.h>
+#include <SketchUpAPI/unicodestring.h>
+#include <SketchUpAPI/transformation.h>
+#include <SketchUpAPI/model/defs.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+@struct SUGroupRef
+@extends SUComponentInstanceRef
+@brief  References a group object.
+*/
+
+/**
+@brief Converts from an \ref SUGroupRef to an \ref SUEntityRef.
+       This is essentially an upcast operation.
+@param[in] group The given group reference.
+@related SUGroupRef
+@return
+- The converted \ref SUEntityRef if group is a valid group
+- If not, the returned reference will be invalid
+*/
+SU_EXPORT SUEntityRef SUGroupToEntity(SUGroupRef group);
+
+/**
+@brief Converts from an \ref SUEntityRef to an \ref SUGroupRef.
+       This is essentially a downcast operation so the given entity must be
+       convertible to an SUGroupRef.
+@param[in] entity The given entity reference.
+@related SUGroupRef
+@return
+- The converted \ref SUGroupRef if the downcast operation succeeds
+- If not, the returned reference will be invalid
+*/
+SU_EXPORT SUGroupRef SUGroupFromEntity(SUEntityRef entity);
+
+/**
+@brief Converts from an \ref SUGroupRef to an \ref SUDrawingElementRef.
+       This is essentially an upcast operation.
+@param[in] group The given group reference.
+@related SUGroupRef
+@return
+- The converted \ref SUDrawingElementRef if group is a valid group
+- If not, the returned reference will be invalid
+*/
+SU_EXPORT SUDrawingElementRef SUGroupToDrawingElement(SUGroupRef group);
+
+/**
+@brief Converts from an \ref SUDrawingElementRef to an \ref SUGroupRef.
+       This is essentially a downcast operation so the given element must be
+       convertible to an SUGroupRef.
+@param[in] drawing_elem The given element reference.
+@related SUGroupRef
+@return
+- The converted \ref SUGroupRef if the downcast operation succeeds
+- If not, the returned reference will be invalid
+*/
+SU_EXPORT SUGroupRef SUGroupFromDrawingElement(SUDrawingElementRef drawing_elem);
+
+/**
+@brief Converts from an \ref SUGroupRef to an \ref SUComponentInstanceRef.
+       This is essentially an upcast operation.
+@since SketchUp 2016, API 4.0
+@param[in] group The given group reference.
+@related SUGroupRef
+@return
+- The converted \ref SUComponentInstanceRef if group is a valid group
+- If not, the returned reference will be invalid
+*/
+SU_EXPORT SUComponentInstanceRef SUGroupToComponentInstance(SUGroupRef group);
+
+/**
+@brief Converts from an \ref SUComponentInstanceRef to an \ref SUGroupRef. This
+       is essentially a downcast operation so the given element must be
+       convertible to an SUGroupRef.
+@since SketchUp 2016, API 4.0
+@param[in] component_inst The given component instance reference.
+@related SUGroupRef
+@return
+- The converted \ref SUGroupRef if the downcast operation succeeds
+- If not, the returned reference will be invalid
+*/
+SU_EXPORT SUGroupRef SUGroupFromComponentInstance(SUComponentInstanceRef component_inst);
+
+/**
+@brief Creates a new group object.
+
+The created group must be subsequently added to the Entities of a model,
+component definition or a group. Use SUModelRemoveComponentDefinitions() to
+remove the group from a model.
+@param[out] group The group object created.
+@related SUGroupRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if group is NULL
+*/
+SU_RESULT SUGroupCreate(SUGroupRef* group);
+
+/**
+@brief Sets the name of a group object.
+@param[in] group The group object.
+@param[in] name  The name string to set the group object.
+                 Assumed to be UTF-8 encoded.
+@related SUGroupRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if group is not a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if name is NULL
+*/
+SU_RESULT SUGroupSetName(SUGroupRef group, const char* name);
+
+/**
+@brief Retrieves the name of a group object.
+@param[in]  group The group object.
+@param[out] name  The name retrieved.
+@related SUGroupRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if group is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if name is NULL
+- \ref SU_ERROR_INVALID_OUTPUT if name does not point to a valid \ref
+  SUStringRef object
+*/
+SU_RESULT SUGroupGetName(SUGroupRef group, SUStringRef* name);
+
+/**
+@brief Retrieves the globally unique identifier (guid) string of a group object.
+@since SketchUp 2015, API 3.0
+@param[in]  group   The group object.
+@param[out] guid    The guid retrieved.
+@related SUGroupRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if group is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if guid is NULL
+- \ref SU_ERROR_INVALID_OUTPUT if guid does not point to a valid \ref
+  SUStringRef object
+*/
+SU_RESULT SUGroupGetGuid(SUGroupRef group, SUStringRef* guid);
+
+/**
+@brief Sets the globally unique identifier (guid) string of a group object.
+@since SketchUp 2015, API 3.0
+@param[in]  group    The group object.
+@param[in]  guid_str The utf-8 formatted guid string.
+@related SUGroupRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if group is not a valid object
+- \ref SU_ERROR_INVALID_INPUT if guid is NULL or invalid
+*/
+SU_RESULT SUGroupSetGuid(SUGroupRef group, const char* guid_str);
+
+/**
+@brief Sets the transform of a group object.
+
+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] group     The group object.
+@param[in] transform The affine transform to set.
+@related SUGroupRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if group is not a valid object.
+- \ref SU_ERROR_NULL_POINTER_INPUT if transform is NULL.
+*/
+SU_RESULT SUGroupSetTransform(SUGroupRef group, const struct SUTransformation* transform);
+
+/**
+@brief Retrieves the transform of a group object.
+
+See description of SUGroupSetTransform for a discussion of group transforms.
+@param[in]  group     The group object.
+@param[out] transform The transform retrieved.
+@related SUGroupRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if group is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if transform is NULL
+*/
+SU_RESULT SUGroupGetTransform(SUGroupRef group, struct SUTransformation* transform);
+
+/**
+@brief Retrieves the entities of the group object.
+@param[in]  group    The group object.
+@param[out] entities The entities retrieved.
+@related SUGroupRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if group is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if entities is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if entities reference object is valid
+*/
+SU_RESULT SUGroupGetEntities(SUGroupRef group, SUEntitiesRef* entities);
+
+/**
+@brief Retrieves the component definition of a group object.
+@since SketchUp 2014, API 2.0
+@param[in]  group     The group object.
+@param[out] component The component definition retrieved.
+@related SUGroupRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if \p group is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if \p component is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if \p component already refers to a valid object
+*/
+SU_RESULT SUGroupGetDefinition(SUGroupRef group, SUComponentDefinitionRef* component);
+
+/* The cond/endcond block will ensure that any code or comment keywords will be
+ignored by the Doxygen parser and will not appear in any documentation */
+///**@cond
+//@brief Explodes a group into separate entities.
+//@since SketchUp 2016, API 4.0
+//@param[in]  group    The group object.
+//@param[out] entities Array of entity pointers returned
+//@related SUGroupRef
+//@return
+//- \ref SU_ERROR_NONE on success
+//- \ref SU_ERROR_INVALID_INPUT if group is invalid
+//- \ref SU_ERROR_NULL_POINTER_OUTPUT if is_locked is NULL
+// SUStringRef object
+//*/
+// SU_RESULT SUGroupExplode(SUGroupRef group, bool* is_locked);
+
+/** @endcond */
+
+#ifdef __cplusplus
+}  // extern "C"
+#endif
+
+#endif  // SKETCHUP_MODEL_GROUP_H_

data/sketchup-sdk-win/headers/SketchUpAPI/model/guide_line.h

@@ -0,0 +1,155 @@
+// Copyright 2014 Trimble Inc. All Rights Reserved.
+
+/**
+ * @file
+ * @brief Interfaces for SUGuideLineRef.
+ */
+#ifndef SKETCHUP_MODEL_GUIDE_LINE_H_
+#define SKETCHUP_MODEL_GUIDE_LINE_H_
+
+#include <SketchUpAPI/common.h>
+#include <SketchUpAPI/geometry.h>
+#include <SketchUpAPI/model/defs.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+@struct SUGuideLineRef
+@extends SUDrawingElementRef
+@brief  A guide line that has a start and end position.
+@since SketchUp 2016, API 4.0
+*/
+
+/**
+@brief Converts from an \ref SUGuideLineRef to an \ref SUEntityRef. This is
+       essentially an upcast operation.
+@since SketchUp 2016, API 4.0
+@param[in] guide_line The guide line object.
+@related SUGuideLineRef
+@return
+- The converted \ref SUEntityRef if guide_line is a valid object
+- If not, the returned reference will be invalid
+*/
+SU_EXPORT SUEntityRef SUGuideLineToEntity(SUGuideLineRef guide_line);
+
+/**
+@brief Converts from an \ref SUEntityRef to an \ref SUGuideLineRef.
+       This is essentially a downcast operation so the given \ref SUEntityRef
+       must be convertible to an \ref SUGuideLineRef.
+@since SketchUp 2016, API 4.0
+@param[in] entity The entity object.
+@related SUGuideLineRef
+@return
+- The converted \ref SUGuideLineRef if the downcast operation succeeds
+- If the downcast operation fails, the returned reference will be invalid
+*/
+SU_EXPORT SUGuideLineRef SUGuideLineFromEntity(SUEntityRef entity);
+
+/**
+@brief Converts from an \ref SUGuideLineRef to an \ref SUDrawingElementRef.
+       This is essentially an upcast operation.
+@since SketchUp 2016, API 4.0
+@param[in] guide_line The given guide line reference.
+@related SUGuideLineRef
+@return
+- The converted \ref SUEntityRef if guide_line is a valid guide line
+- If not, the returned reference will be invalid
+*/
+SU_EXPORT SUDrawingElementRef SUGuideLineToDrawingElement(SUGuideLineRef guide_line);
+
+/**
+@brief Converts from an \ref SUDrawingElementRef to an \ref SUGuideLineRef.
+       This is essentially a downcast operation so the given element must be
+       convertible to an \ref SUGuideLineRef.
+@since SketchUp 2016, API 4.0
+@param[in] drawing_elem The given element reference.
+@related SUGuideLineRef
+@return
+- The converted \ref SUGuideLineRef if the downcast operation succeeds
+- If not, the returned reference will be invalid.
+*/
+SU_EXPORT SUGuideLineRef SUGuideLineFromDrawingElement(SUDrawingElementRef drawing_elem);
+
+/**
+@brief Creates a finite guide line object. The guide line object must be
+       subsequently deallocated with \ref SUGuideLineRelease() unless it is
+       associated with a parent object.  The generated line will be a segment
+       with start and end points.  The end point can be obtained by adding the
+       direction vector to the start point.
+@since SketchUp 2016, API 4.0
+@param[in]  guide_line The guide line object.
+@param[out] start      The guide line start position.
+@param[out] end        The guide line end position.
+@related SUGuideLineRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if guide_line is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if guide_line references a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if start or end is NULL
+*/
+SU_RESULT SUGuideLineCreateFinite(
+    SUGuideLineRef* guide_line, const struct SUPoint3D* start, const struct SUPoint3D* end);
+
+/**
+@brief Creates a infinite guide line object. The guide line object must be
+       subsequently deallocated with \ref SUGuideLineRelease() unless it is
+       associated with a parent object.  The generated line will be infinite.
+       Defined with a point along the line and a direction vector.
+@since SketchUp 2016, API 4.0
+@param[in]  guide_line The guide line object.
+@param[out] point      A point on the guide line.
+@param[out] direction  The guide line direction vector.
+@related SUGuideLineRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if guide_line is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if guide_line references a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if start or end is NULL
+*/
+SU_RESULT SUGuideLineCreateInfinite(
+    SUGuideLineRef* guide_line, const struct SUPoint3D* point, const struct SUVector3D* direction);
+
+/**
+@brief Releases a guide line object. The guide line object must have been
+       created with \ref SUGuideLineCreateFinite() or \ref
+       SUGuideLineCreateInfinite and not subsequently associated with a parent
+       object (e.g. \ref SUEntitiesRef).
+@since SketchUp 2016, API 4.0
+@param[in] guide_line The guide line object.
+@related SUGuideLineRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if guide_line is NULL
+- \ref SU_ERROR_INVALID_INPUT if guide_line does not reference a valid object
+*/
+SU_RESULT SUGuideLineRelease(SUGuideLineRef* guide_line);
+
+/**
+@brief Retrieves the data defining the line (a point, a direction vector, and a
+       boolean flagging if the line is infinite).  For finite lines \p start
+       is the start point, and the end point can be obtained by adding
+       the direction vector (\p direction) to the start point (\p start).
+       For infinite lines \p start is simply a point on the guide line, and
+       \p direction is always a unit vector.
+@since SketchUp 2016, API 4.0
+@param[in]  guide_line The guide line object.
+@param[out] start      A point on the guide line.
+@param[out] direction  The guide line direction.
+@param[out] isinfinite returns true if infinite otherwise returns false
+@related SUGuideLineRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if guide line is an invalid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if start, direction, or isinfinite is NULL
+*/
+SU_RESULT SUGuideLineGetData(
+    SUGuideLineRef guide_line, struct SUPoint3D* start, struct SUVector3D* direction,
+    bool* isinfinite);
+
+#ifdef __cplusplus
+}  // extern "C"
+#endif
+
+#endif  // SKETCHUP_MODEL_GUIDE_LINE_H_

data/sketchup-sdk-win/headers/SketchUpAPI/model/guide_point.h

@@ -0,0 +1,153 @@
+// Copyright 2014 Trimble Inc. All Rights Reserved.
+
+/**
+ * @file
+ * @brief Interfaces for SUGuidePointRef.
+ */
+#ifndef SKETCHUP_MODEL_GUIDE_POINT_H_
+#define SKETCHUP_MODEL_GUIDE_POINT_H_
+
+#include <SketchUpAPI/common.h>
+#include <SketchUpAPI/geometry.h>
+#include <SketchUpAPI/model/defs.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+@struct SUGuidePointRef
+@extends SUDrawingElementRef
+@brief  A guide point that has a position.
+@since SketchUp 2014 M1, API 2.1
+*/
+
+/**
+@brief Converts from an \ref SUGuidePointRef to an \ref SUEntityRef. This is
+       essentially an upcast operation.
+@since SketchUp 2014 M1, API 2.1
+@param[in] guide_point The guide point object.
+@related SUGuidePointRef
+@return
+- The converted \ref SUEntityRef if guide_point is a valid object
+- If not, the returned reference will be invalid
+*/
+SU_EXPORT SUEntityRef SUGuidePointToEntity(SUGuidePointRef guide_point);
+
+/**
+@brief Converts from an \ref SUEntityRef to an \ref SUGuidePointRef.
+       This is essentially a downcast operation so the given \ref SUEntityRef
+       must be convertible to an \ref SUGuidePointRef.
+@since SketchUp 2014 M1, API 2.1
+@param[in] entity The entity object.
+@related SUGuidePointRef
+@return
+- The converted \ref SUGuidePointRef if the downcast operation succeeds
+- If the downcast operation fails, the returned reference will be invalid
+*/
+SU_EXPORT SUGuidePointRef SUGuidePointFromEntity(SUEntityRef entity);
+
+/**
+@brief Converts from an \ref SUGuidePointRef to an \ref SUDrawingElementRef.
+       This is essentially an upcast operation.
+@since SketchUp 2015 M0, API 3.0
+@param[in] guide_point The given guide point reference.
+@related SUGuidePointRef
+@return
+- The converted \ref SUEntityRef if guide_point is a valid guide point.
+- If not, the returned reference will be invalid.
+*/
+SU_EXPORT SUDrawingElementRef SUGuidePointToDrawingElement(SUGuidePointRef guide_point);
+
+/**
+@brief Converts from an \ref SUDrawingElementRef to an \ref SUGuidePointRef.
+       This is essentially a downcast operation so the given element must be
+       convertible to an SUGuidePointRef.
+@since SketchUp 2015 M0, API 3.0
+@param[in] drawing_elem The given element reference.
+@related SUGuidePointRef
+@return
+- The converted \ref SUGuidePointRef if the downcast operation succeeds
+- If not, the returned reference will be invalid
+*/
+SU_EXPORT SUGuidePointRef SUGuidePointFromDrawingElement(SUDrawingElementRef drawing_elem);
+
+/**
+@brief Creates a guide point object. The guide point object must be subsequently
+       deallocated with \ref SUGuidePointRelease() unless it is associated with
+       a parent object.
+@since SketchUp 2014 M1, API 2.1
+@param[in]  guide_point The guide point object.
+@param[out] position    The guide point position.
+@related SUGuidePointRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if guide_point is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if guide_point references a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if position is NULL
+*/
+SU_RESULT SUGuidePointCreate(SUGuidePointRef* guide_point, const struct SUPoint3D* position);
+
+/**
+@brief Releases a guide point object. The guide point object must have been
+       created with SUGuidePointCreate() and not subsequently associated
+       with a parent object (e.g. SUEntitiesAddGuidePoints()).
+@since SketchUp 2014 M1, API 2.1
+@param[in] guide_point The guide point object.
+@related SUGuidePointRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if guide_point is NULL
+- \ref SU_ERROR_INVALID_INPUT if guide_point does not reference a valid object
+*/
+SU_RESULT SUGuidePointRelease(SUGuidePointRef* guide_point);
+
+/**
+@brief Retrieves the position of a guide point object.
+@since SketchUp 2014 M1, API 2.1
+@param[in]  guide_point The guide point object.
+@param[out] position    The guide point position.
+@related SUGuidePointRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if guide point is an invalid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if position is NULL
+*/
+SU_RESULT SUGuidePointGetPosition(SUGuidePointRef guide_point, struct SUPoint3D* position);
+
+/**
+@brief Retrieves the anchor position of a guide point object. If the point was
+       created in SketchUp then the anchor is the position that was first
+       clicked during the point creation. If the point was created with \ref
+       SUGuidePointCreate the anchor is the origin.
+@since SketchUp 2016, API 4.0
+@param[in]  guide_point The guide point object.
+@param[out] position    The guide point anchor position.
+@related SUGuidePointRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if guide point is an invalid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if position is NULL
+*/
+SU_RESULT SUGuidePointGetFromPosition(SUGuidePointRef guide_point, struct SUPoint3D* position);
+
+/**
+@brief Retrieves the boolean indicating if the point should be displayed as a
+       line.
+@since SketchUp 2016, API 4.0
+@param[in]  guide_point The guide point object.
+@param[out] as_line     Return true if the point is set to be displayed as a
+                        line.
+@related SUGuidePointRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if guide point is an invalid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if as_line is NULL
+*/
+SU_RESULT SUGuidePointGetDisplayAsLine(SUGuidePointRef guide_point, bool* as_line);
+
+#ifdef __cplusplus
+}  // extern "C"
+#endif
+
+#endif  // SKETCHUP_MODEL_GUIDE_POINT_H_