scriptup 2024.0.5 → 2024.0.6

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

@@ -0,0 +1,107 @@
+// Copyright 2015 Trimble Navigation Ltd. All rights reserved.
+// This file is intended for public distribution.
+
+#ifndef LAYOUT_MODEL_CONNECTIONPOINT_H_
+#define LAYOUT_MODEL_CONNECTIONPOINT_H_
+
+#include <LayOutAPI/common.h>
+#include <LayOutAPI/geometry/geometry.h>
+#include <LayOutAPI/model/defs.h>
+
+/**
+@struct LOConnectionPointRef
+@brief References a connection point. A connection point defines a target
+       point to which a label or dimension can connect.
+*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif  // __cplusplus
+
+/**
+@brief Creates a new connection point object for the given entity at the given
+       2D point.
+@param[out] connection_point The connection point object.
+@param[in]  entity           The entity object.
+@param[in]  point            The position of the connection point.
+@param[in]  aperture         The search radius to use when looking for geometry
+                             to connect to.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if connection_point is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *connection_point already refers to a valid
+  object
+- \ref SU_ERROR_INVALID_INPUT if entity does not refer to a valid object
+- \ref SU_ERROR_OUT_OF_RANGE if aperture is less than or equal to 0
+- \ref SU_ERROR_NULL_POINTER_INPUT if point is NULL
+- \ref SU_ERROR_GENERIC if the entity is not in a document
+- \ref SU_ERROR_NO_DATA if no connection point could be made
+*/
+LO_RESULT LOConnectionPointCreate(
+    LOConnectionPointRef* connection_point, LOEntityRef entity, const LOPoint2D* point,
+    double aperture);
+
+/**
+@brief Creates a new connection point object for the given SketchUp model entity
+       at the given 3D point in model space. Note that connection points created
+       via this function will have no persistent ID assigned to them, resulting
+       in a connection point that does not update when geometry is modified.
+@param[out] connection_point The connection point object.
+@param[in]  model            The SketchUp model object.
+@param[in]  point3d          The 3D position of the connection point in model
+                             space.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if connection_point is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *connection_point already refers to a valid
+  object
+- \ref SU_ERROR_INVALID_INPUT if model does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if point3d is NULL
+- \ref SU_ERROR_GENERIC if the model is not in a document
+*/
+LO_RESULT LOConnectionPointCreateFromPoint3D(
+    LOConnectionPointRef* connection_point, LOSketchUpModelRef model, const LOPoint3D* point3d);
+
+/**
+@brief Creates a new connection point object for the given SketchUp model entity
+       at the given 3D point in model space. Note that connection points created
+       via this function have a persistent ID assigned to them, resulting in a
+       connection point that updates when the geometry is modified.
+@note  Starting in LayOut 2020.1, API 5.1, SU_ERROR_NO_DATA will be returned if
+       persistent_id isn't valid for the given model.
+@since LO 2017, API 2.0
+@param[out] connection_point The connection point object.
+@param[in]  model            The SketchUp model object.
+@param[in]  point3d          The 3D position of the connection point in model.
+@param[in]  persistent_id    The PID of the entity.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if connection_point is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *connection_point already refers to a valid
+  object
+- \ref SU_ERROR_INVALID_INPUT if model does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if point3d or persistent_id is NULL
+- \ref SU_ERROR_GENERIC if the model is not in a document
+- \ref SU_ERROR_NO_DATA if persistent_id does not refer to a valid path
+*/
+LO_RESULT LOConnectionPointCreateFromPID(
+    LOConnectionPointRef* connection_point, LOSketchUpModelRef model, const LOPoint3D* point3d,
+    const char* persistent_id);
+
+/**
+@brief Releases a connection point object. The object will be invalidated if
+       releasing the last reference.
+@param[in] connection_point The connection point object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if connection_point is NULL
+- \ref SU_ERROR_INVALID_INPUT if *connection_point does not refer to a valid
+  object
+*/
+LO_RESULT LOConnectionPointRelease(LOConnectionPointRef* connection_point);
+
+#ifdef __cplusplus
+}  // end extern "C"
+#endif  // __cplusplus
+
+#endif  // LAYOUT_MODEL_CONNECTIONPOINT_H_

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

@@ -0,0 +1,42 @@
+// Copyright 2017-2022 Trimble Inc. All Rights Reserved.
+
+#ifndef LAYOUT_MODEL_DEFS_H_
+#define LAYOUT_MODEL_DEFS_H_
+
+#include <SketchUpAPI/common.h>
+
+#pragma pack(push, 8)
+
+DEFINE_SU_TYPE(LOAngularDimensionRef)
+DEFINE_SU_TYPE(LOAutoTextDefinitionRef)
+DEFINE_SU_TYPE(LOAutoTextDefinitionListRef)
+DEFINE_SU_TYPE(LOConnectionPointRef)
+DEFINE_SU_TYPE(LODictionaryRef)
+DEFINE_SU_TYPE(LODocumentRef)
+DEFINE_SU_TYPE(LOEllipseRef)
+DEFINE_SU_TYPE(LOEntityRef)
+DEFINE_SU_TYPE(LOEntityIteratorRef)
+DEFINE_SU_TYPE(LOEntityListRef)
+DEFINE_SU_TYPE(LOFormattedTextRef)
+DEFINE_SU_TYPE(LOGridRef)
+DEFINE_SU_TYPE(LOGroupRef)
+DEFINE_SU_TYPE(LOImageRef)
+DEFINE_SU_TYPE(LOImageRepRef)
+DEFINE_SU_TYPE(LOLabelRef)
+DEFINE_SU_TYPE(LOLayerRef)
+DEFINE_SU_TYPE(LOLayerInstanceRef)
+DEFINE_SU_TYPE(LOLayerListRef)
+DEFINE_SU_TYPE(LOLinearDimensionRef)
+DEFINE_SU_TYPE(LOPageRef)
+DEFINE_SU_TYPE(LOPageInfoRef)
+DEFINE_SU_TYPE(LOPageListRef)
+DEFINE_SU_TYPE(LOPathRef)
+DEFINE_SU_TYPE(LORectangleRef)
+DEFINE_SU_TYPE(LOSketchUpModelRef)
+DEFINE_SU_TYPE(LOStyleRef)
+DEFINE_SU_TYPE(LOTableRef)
+DEFINE_SU_TYPE(LOTypedValueRef)
+DEFINE_SU_TYPE(LOReferenceEntityRef)
+
+#pragma pack(pop)
+#endif

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

@@ -0,0 +1,120 @@
+// Copyright 2015 Trimble Navigation Ltd. All rights reserved.
+// This file is intended for public distribution.
+
+#ifndef LAYOUT_MODEL_DICTIONARY_H_
+#define LAYOUT_MODEL_DICTIONARY_H_
+
+#include <LayOutAPI/common.h>
+#include <LayOutAPI/model/defs.h>
+
+/**
+@struct LODictionaryRef
+@brief References a dictionary. A dictionary maps string keys to
+       \ref LOTypedValueRef values.
+*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+@brief Creates an new empty dictionary object.
+@param[out] dictionary The newly created dictionary object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if dictionary is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *dictionary already refers to a valid object
+*/
+LO_RESULT LODictionaryCreate(LODictionaryRef* dictionary);
+
+/**
+@brief Releases a dictionary object. *dictionary will be set to invalid by
+       this function.
+@param[in] dictionary The dictionary object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if dictionary is NULL
+- \ref SU_ERROR_INVALID_INPUT if *dictionary references an invalid object
+*/
+LO_RESULT LODictionaryRelease(LODictionaryRef* dictionary);
+
+/**
+@brief Retrieves the value associated with a given key from a dictionary.
+@param[in] dictionary The dictionary object.
+@param[in] key        The key of the key-value pair. Assumed to be UTF-8
+                      encoded.
+@param[out] value     The value retrieved. Must be a valid object, i.e.
+                      must have been created via \ref LOTypedValueCreate.
+@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_INVALID_OUTPUT if value is an invalid object
+- \ref SU_ERROR_NO_DATA if there is no value associated with the given key in
+  the dictionary
+*/
+LO_RESULT LODictionaryGetValue(LODictionaryRef dictionary, const char* key, LOTypedValueRef value);
+
+/**
+@brief Inserts a key-value pair into a dictionary object.
+@param[in] dictionary The dictionary object.
+@param[in] key        The key of the key-value pair. Assumed to be UTF-8
+                      encoded.
+@param[in] value      The value of the key-value pair.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if dictionary or value is an invalid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if key is NULL
+*/
+LO_RESULT LODictionarySetValue(LODictionaryRef dictionary, const char* key, LOTypedValueRef value);
+
+/**
+@brief Removes all of the key-value pairs from a dictionary.
+@since LayOut 2018, API 3.0
+@param[in] dictionary The dictionary object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if dictionary is an invalid object
+*/
+LO_RESULT LODictionaryClear(LODictionaryRef dictionary);
+
+/**
+@brief Gets the number of entries in the dictionary.
+@since LayOut 2018, API 3.0
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if dictionary does not refer to a valid
+  object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if out_number_of_keys is NULL
+*/
+LO_RESULT LODictionaryGetNumberOfKeys(LODictionaryRef dictionary, size_t* out_number_of_keys);
+
+/**
+@brief Gets all the keys in the dictionary.
+@since LayOut 2018, API 3.0
+@return
+- \ref SU_ERROR_NONE on success.
+- \ref SU_ERROR_INVALID_INPUT if dictionary refers to an invalid reference
+- \ref SU_ERROR_OUT_OF_RANGE if key_array_length must be at least 1
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if out_key_array or
+  out_number_of_keys_copied is NULL
+- \ref SU_ERROR_INVALID_OUTPUT if keys contains one or more invalid objects
+*/
+LO_RESULT LODictionaryGetKeys(
+    LODictionaryRef dictionary, size_t key_array_length, SUStringRef keys[],
+    size_t* out_number_of_keys_copied);
+
+/**
+@brief Remove the entry in the dictionary for the given key.
+@since LayOut 2018, API 3.0
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if dictionary or key refer to invalid references
+- \ref SU_ERROR_NO_DATA if there is no value to delete for the given key
+*/
+LO_RESULT LODictionaryRemoveEntry(LODictionaryRef dictionary, const char* key);
+#ifdef __cplusplus
+}  // extern "C" {
+#endif
+
+#endif  // LAYOUT_MODEL_DICTIONARY_H_