scriptup 0.0.0

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

@@ -0,0 +1,161 @@
+// Copyright 2013-2020 Trimble Inc.  All Rights Reserved
+
+/**
+ * @file
+ * @brief Interfaces for SUAttributeDictionaryRef.
+ */
+#ifndef SKETCHUP_MODEL_ATTRIBUTE_DICTIONARY_H_
+#define SKETCHUP_MODEL_ATTRIBUTE_DICTIONARY_H_
+
+#include <SketchUpAPI/common.h>
+#include <SketchUpAPI/unicodestring.h>
+#include <SketchUpAPI/model/defs.h>
+#include <SketchUpAPI/model/typed_value.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+@brief Creates an attributes dictionary object.
+@since SketchUp 2018 M0, API 6.0
+@param[out] dictionary The attributes dictionary object created.
+@param[in]  name       The name of the attribute dictionary. Assumed to be UTF-8
+                       encoded.
+@related SUAttributeDictionaryRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if name is NULL
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if dictionary is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if dictionary already references a valid object
+*/
+SU_RESULT SUAttributeDictionaryCreate(SUAttributeDictionaryRef* dictionary, const char* name);
+
+/**
+@brief Releases an attributes dictionary object and its associated attributes.
+       If this dictionary has a parent, it will be removed from it.
+@since SketchUp 2018 M0, API 6.0
+@param[in,out] dictionary The attributes dictionary object.
+@related SUAttributeDictionaryRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if dictionary is NULL
+- \ref SU_ERROR_INVALID_INPUT if dictionary does not reference a valid object
+*/
+SU_RESULT SUAttributeDictionaryRelease(SUAttributeDictionaryRef* dictionary);
+
+/**
+@brief Converts from an \ref SUAttributeDictionaryRef to an \ref SUEntityRef.
+       This is essentially an upcast operation.
+@since SketchUp 2014, API 2.0
+@param[in] dictionary The attribute dictionary object.
+@related SUAttributeDictionaryRef
+@return
+- The converted \ref SUEntityRef if dictionary is a valid object
+- If not, the returned reference will be invalid
+*/
+SU_EXPORT SUEntityRef SUAttributeDictionaryToEntity(SUAttributeDictionaryRef dictionary);
+
+/**
+@brief Converts from an \ref SUEntityRef to an \ref SUAttributeDictionaryRef.
+       This is essentially a downcast operation so the given \ref SUEntityRef
+       must be convertible to an \ref SUAttributeDictionaryRef.
+@since SketchUp 2014, API 2.0
+@param[in] entity The given entity reference.
+@related SUAttributeDictionaryRef
+@return
+- The converted \ref SUAttributeDictionaryRef if the downcast operation succeeds
+- If not, the returned reference will be invalid
+*/
+SU_EXPORT SUAttributeDictionaryRef SUAttributeDictionaryFromEntity(SUEntityRef entity);
+
+/**
+@struct SUAttributeDictionaryRef
+@extends SUEntityRef
+@brief  A dictionary type with SUStringRef objects as keys and SUTypedValueRef
+        objects as values.
+*/
+
+/**
+@brief Retrieves the name of an attribute dictionary object.
+@param[in]  dictionary The attribute dictionary object.
+@param[out] name       The name retrieved.
+@related SUAttributeDictionaryRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if dictionary is an invalid 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 SUAttributeDictionaryGetName(SUAttributeDictionaryRef dictionary, SUStringRef* name);
+
+/**
+@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.
+@related SUAttributeDictionaryRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if dictionary or value_in is an invalid object.
+- \ref SU_ERROR_NULL_POINTER_INPUT if key is NULL
+- \ref SU_ERROR_INVALID_OPERATION if dictionary is read-only.
+*/
+SU_RESULT SUAttributeDictionarySetValue(
+    SUAttributeDictionaryRef dictionary, const char* key, SUTypedValueRef value_in);
+
+/**
+@brief Retrieves the value associated with a given key from an attribute
+       dictionary.
+@param[in] dictionary The attribute dictionary object.
+@param[in] key        The key of the key-value pair. Assumed to be UTF-8
+                      encoded.
+@param[out] value_out The value retrieved. Must be a valid object, i.e.
+                      must have been allocated via SUTypedValueCreate().
+@related SUAttributeDictionaryRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if dictionary is an invalid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if key is NULL
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if value_out is NULL
+- \ref SU_ERROR_INVALID_OUTPUT if value_out is an invalid object
+- \ref SU_ERROR_NO_DATA if there is no value associated with the given key in
+  the dictionary
+*/
+SU_RESULT SUAttributeDictionaryGetValue(
+    SUAttributeDictionaryRef dictionary, const char* key, SUTypedValueRef* value_out);
+
+/**
+@brief Retrieves the number of keys in an attribute dictionary object.
+@param[in]  dictionary The attribute dictionary object.
+@param[out] count      The number of keys.
+@related SUAttributeDictionaryRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if dictionary is an invalid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if count is NULL
+*/
+SU_RESULT SUAttributeDictionaryGetNumKeys(SUAttributeDictionaryRef dictionary, size_t* count);
+
+/**
+@brief Retrieves the array of keys of an attribute dictionary object.
+@param[in]  dictionary The attribute dictionary object.
+@param[in]  len        The number of keys to retrieve.
+@param[out] keys       The keys retrieved.
+@param[out] count      The number of keys retrieved.
+@related SUAttributeDictionaryRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if dictionary is an invalid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if keys or count is NULL
+*/
+SU_RESULT SUAttributeDictionaryGetKeys(
+    SUAttributeDictionaryRef dictionary, size_t len, SUStringRef keys[], size_t* count);
+
+#ifdef __cplusplus
+}  //  extern "C" {
+#endif
+
+#endif  // SKETCHUP_MODEL_ATTRIBUTE_DICTIONARY_H_

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

@@ -0,0 +1,242 @@
+// Copyright 2015-2020 Trimble Inc. All Rights Reserved.
+
+/**
+ * @file
+ * @brief Interfaces for SUAxesRef.
+ */
+#ifndef SKETCHUP_MODEL_AXES_H_
+#define SKETCHUP_MODEL_AXES_H_
+
+#include <SketchUpAPI/common.h>
+#include <SketchUpAPI/geometry.h>
+#include <SketchUpAPI/transformation.h>
+#include <SketchUpAPI/model/defs.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+@struct SUAxesRef
+@extends SUEntityRef
+@brief  An axes entity reference.
+@since SketchUp 2016, API 4.0
+*/
+
+/**
+@brief Converts from an \ref SUAxesRef to an \ref SUEntityRef. This is
+       essentially an upcast operation.
+@since SketchUp 2016, API 4.0
+@param[in] axes The axes object.
+@related SUAxesRef
+@return
+- The converted \ref SUEntityRef if axes is a valid object
+- If not, the returned reference will be invalid
+*/
+SU_EXPORT SUEntityRef SUAxesToEntity(SUAxesRef axes);
+
+/**
+@brief Converts from an \ref SUEntityRef to an \ref SUAxesRef.
+       This is essentially a downcast operation so the given \ref SUEntityRef
+       must be convertible to an \ref SUAxesRef.
+@since SketchUp 2016, API 4.0
+@param[in] entity The entity object.
+@related SUAxesRef
+@return
+- The converted \ref SUAxesRef if the downcast operation succeeds
+- If the downcast operation fails, the returned reference will be invalid
+*/
+SU_EXPORT SUAxesRef SUAxesFromEntity(SUEntityRef entity);
+
+/**
+@brief Converts from an \ref SUAxesRef to an \ref SUDrawingElementRef.
+       This is essentially an upcast operation.
+@since SketchUp 2016, API 4.0
+@param[in] axes The given axes reference.
+@related SUAxesRef
+@return
+- The converted \ref SUEntityRef if axes is a valid axes
+- If not, the returned reference will be invalid
+*/
+SU_EXPORT SUDrawingElementRef SUAxesToDrawingElement(SUAxesRef axes);
+
+/**
+@brief Converts from an \ref SUDrawingElementRef to an \ref SUAxesRef.
+       This is essentially a downcast operation so the given element must be
+       convertible to an \ref SUAxesRef.
+@since SketchUp 2016, API 4.0
+@param[in] drawing_elem The given element reference.
+@related SUAxesRef
+@return
+- The converted \ref SUAxesRef if the downcast operation succeeds
+- If not, the returned reference will be invalid.
+*/
+SU_EXPORT SUAxesRef SUAxesFromDrawingElement(SUDrawingElementRef drawing_elem);
+
+/**
+@brief Creates a default constructed axes object. The axes object must be
+       subsequently deallocated with \ref SUAxesRelease() unless it is
+       associated with a parent object.
+@since SketchUp 2016, API 4.0
+@param[in] axes The axes object.
+@related SUAxesRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if axes is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if axes references a valid object
+*/
+SU_RESULT SUAxesCreate(SUAxesRef* axes);
+
+/**
+@brief Creates an axes object. The axes object must be
+subsequently deallocated with \ref SUAxesRelease() unless it is
+associated with a parent object.
+@since SketchUp 2016, API 4.0
+@param[in] axes The axes object.
+@param[in] origin The origin of the new axes.
+@param[in] xaxis The 1st axis for the custom 3D axes.
+@param[in] yaxis The 2nd axis for the custom 3D axes.
+@param[in] zaxis The 3rd axis for the custom 3D axes.
+@related SUAxesRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if axes is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if axes references a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if any of the input pointers (origin, xaxis
+  yaxis, and zaxis) are NULL
+- \ref SU_ERROR_GENERIC if the three vectors don't make an orthogonal axes
+*/
+SU_RESULT SUAxesCreateCustom(
+    SUAxesRef* axes, const struct SUPoint3D* origin, const struct SUVector3D* xaxis,
+    const struct SUVector3D* yaxis, const struct SUVector3D* zaxis);
+
+/**
+@brief Releases aa axes object. The axes object must have been created with
+       \ref SUAxesCreate() and not subsequently associated with a parent object
+       (e.g. \ref SUEntitiesRef).
+@since SketchUp 2016, API 4.0
+@param[in] axes The axes object.
+@related SUAxesRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if axes is NULL
+- \ref SU_ERROR_INVALID_INPUT if axes does not reference a valid object
+*/
+SU_RESULT SUAxesRelease(SUAxesRef* axes);
+
+/**
+@brief  Retrieves the origin point value, not a reference.
+@since SketchUp 2016, API 4.0
+@param[in] axes The axes object.
+@param[out] origin Pointer to a \ref SUPoint3D struct for returning the origin.
+@related SUAxesRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if axes is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if origin is NULL
+*/
+SU_RESULT SUAxesGetOrigin(SUAxesRef axes, struct SUPoint3D* origin);
+
+/**
+@brief  Sets the origin point value for the provided axes.
+@since SketchUp 2016, API 4.0
+@param[in] axes The axes object.
+@param[in] origin Pointer to a \ref SUPoint3D struct for setting the origin.
+@related SUAxesRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if axes is not a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if origin is NULL
+*/
+SU_RESULT SUAxesSetOrigin(SUAxesRef axes, const struct SUPoint3D* origin);
+
+/**
+@brief  Retrieves the 1st axis vector value, not a reference.
+@since SketchUp 2016, API 4.0
+@param[in] axes The axes object.
+@param[out] axis Pointer to a \ref SUVector3D struct for getting the 1st axis.
+@related SUAxesRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if axes is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if axis is NULL
+*/
+SU_RESULT SUAxesGetXAxis(SUAxesRef axes, struct SUVector3D* axis);
+
+/**
+@brief  Retrieves the 2nd axis vector value, not a reference.
+@since SketchUp 2016, API 4.0
+@param[in] axes The axes object.
+@param[out] axis Pointer to a \ref SUVector3D struct for getting the 2nd axis.
+@related SUAxesRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if axes is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if axis is NULL
+*/
+SU_RESULT SUAxesGetYAxis(SUAxesRef axes, struct SUVector3D* axis);
+
+/**
+@brief  Retrieves the 3rd axis vector value, not a reference.
+@since SketchUp 2016, API 4.0
+@param[in] axes The axes object.
+@param[out] axis Pointer to a \ref SUVector3D struct for getting the 3rd axis.
+@related SUAxesRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if axes is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if axis is NULL
+*/
+SU_RESULT SUAxesGetZAxis(SUAxesRef axes, struct SUVector3D* axis);
+
+/**
+@brief  Sets the axes' vectors. Fails if vectors don't make an orthogonal axes.
+@since SketchUp 2016, API 4.0
+@param[in] axes The axes object.
+@param[in] xaxis Pointer to a \ref SUVector3D struct for setting the 1st axis.
+@param[in] yaxis Pointer to a \ref SUVector3D struct for setting the 2nd axis.
+@param[in] zaxis Pointer to a \ref SUVector3D struct for setting the 3rd axis.
+@related SUAxesRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if axes is not a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if xaxis, yaxis, or zaxis is NULL
+- \ref SU_ERROR_GENERIC if the three vectors don't make an orthogonal axes
+*/
+SU_RESULT SUAxesSetAxesVecs(
+    SUAxesRef axes, const struct SUVector3D* xaxis, const struct SUVector3D* yaxis,
+    const struct SUVector3D* zaxis);
+
+/**
+@brief  Retrieves a copy of the transformation.
+@since SketchUp 2016, API 4.0
+@param[in] axes The axes object.
+@param[out] transform Pointer to a \ref SUTransformation struct for getting the
+            transformation data.
+@related SUAxesRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if axes is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if transform is NULL
+*/
+SU_RESULT SUAxesGetTransform(SUAxesRef axes, struct SUTransformation* transform);
+
+/**
+@brief  Retrieves a copy of the plane.
+@since SketchUp 2016, API 4.0
+@param[in] axes The axes object.
+@param[out] plane Pointer to a \ref SUPlane3D struct for getting the
+plane data.
+@related SUAxesRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if axes is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if plane is NULL
+*/
+SU_RESULT SUAxesGetPlane(SUAxesRef axes, struct SUPlane3D* plane);
+
+#ifdef __cplusplus
+}  // extern "C"
+#endif
+
+#endif  // SKETCHUP_MODEL_AXES_H_