scriptup 0.0.0

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

@@ -0,0 +1,186 @@
+// Copyright 2017 Trimble Inc. All Rights Reserved.
+
+/**
+ * @file
+ * @brief Interfaces for SUEntityRef.
+ */
+#ifndef SKETCHUP_MODEL_ENTITY_H_
+#define SKETCHUP_MODEL_ENTITY_H_
+
+#include <SketchUpAPI/common.h>
+#include <SketchUpAPI/model/defs.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+@struct SUEntityRef
+@brief  References an entity, which is an abstract base type for most API types.
+*/
+
+/**
+@brief Returns the concrete type of the given entity.
+@param[in] entity The entity.
+@related SUEntityRef
+@return
+- The concrete type of the given entity reference.
+- \ref SURefType_Unknown if entity is not valid.
+*/
+SU_EXPORT enum SURefType SUEntityGetType(SUEntityRef entity);
+
+/**
+@brief Retrieves the id of the entity.
+@param[in]  entity    The entity.
+@param[out] entity_id The id retrieved.
+@related SUEntityRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if entity is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if entity_id is NULL.
+*/
+SU_RESULT SUEntityGetID(SUEntityRef entity, int32_t* entity_id);
+
+/**
+@brief Retrieves the persistent id of the entity.
+
+@note Only a subset of entity types support PIDs. Refer to the list
+      below for which and when support was added.
+
+SketchUp 2020.1
+  - SUComponentDefinitionRef
+  - SUFontRef
+  - SUStyleRef
+  - SUMaterialRef
+SketchUp 2020.0
+  - SULayerRef
+  - SULineStyleRef
+SketchUp 2018
+  - SUSceneRef
+SketchUp 2017
+  - SUAxesRef
+  - SUComponentInstanceRef
+  - SUGuideLineRef
+  - SUGuidePointRef
+  - SUCurveRef
+  - SUDimensionRef
+  - SUEdgeRef
+  - SUFaceRef
+  - SUPolyline3dRef
+  - SUSectionPlaneRef
+  - SUTextRef
+  - SUVertexRef
+
+@param[in]  entity      The entity.
+@param[out] entity_pid  The persistent id retrieved.
+@related SUEntityRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if entity is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if entity_pid is NULL.
+*/
+SU_RESULT SUEntityGetPersistentID(SUEntityRef entity, int64_t* entity_pid);
+
+/**
+@brief Retrieves the number of attribute dictionaries of an entity.
+
+@bug Prior to SDK version 9.1 (SketchUp 2021.1) this function might return a
+  count higher than what SUEntityGetNumAttributeDictionaries() will actually
+  return. For example with faces with a positioned material.
+
+@param[in]  entity The entity.
+@param[out] count  The number of attribute dictionaries.
+@related SUEntityRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if entity is not a valid entity
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if count is NULL
+*/
+SU_RESULT SUEntityGetNumAttributeDictionaries(SUEntityRef entity, size_t* count);
+
+/**
+@brief Retrieves the attribute dictionaries of an entity.
+@param[in]  entity       The entity.
+@param[in]  len          The number of attribute dictionaries to retrieve.
+@param[out] dictionaries The dictionaries retrieved.
+@param[out] count        The number of dictionaries retrieved.
+@related SUEntityRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if entity is not a valid entity
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if dictionaries or count is NULL
+*/
+SU_RESULT SUEntityGetAttributeDictionaries(
+    SUEntityRef entity, size_t len, SUAttributeDictionaryRef dictionaries[], size_t* count);
+
+/**
+@brief Adds the attribute dictionary to an entity. The given dictionary object
+       must not belong to another entity. In other words, each dictionary should
+       be added to one entity only.
+@since SketchUp 2018 M0, API 6.0
+@param[in] entity     The entity.
+@param[in] dictionary The dictionary object to be added. If the function is
+                      successful, don't call SUAttributeDictionaryRelease on the
+                      dictionary because the new entity will take ownership.
+@related SUEntityRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if entity or dictionary are not valid entities
+- \ref SU_ERROR_DUPLICATE if another attribute already exists with the
+       same name.
+- \ref SU_ERROR_INVALID_ARGUMENT if dictionary's name is empty or it's a name
+       that is reserved for internal use.
+*/
+SU_RESULT SUEntityAddAttributeDictionary(SUEntityRef entity, SUAttributeDictionaryRef dictionary);
+
+/**
+@brief Retrieves the attribute dictionary of an entity that has the given name.
+
+If a dictionary with the given name does not exist, one is added to the entity.
+@param[in]  entity The entity.
+@param[in]  name   The name of the retrieved attribute dictionary.
+                   Assumed to be UTF-8 encoded.
+@param[out] dictionary The destination of the retrieved dictionary object.
+@related SUEntityRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if entity is not a valid entity
+- \ref SU_ERROR_NULL_POINTER_INPUT if name is NULL
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if dictionary is NULL
+*/
+SU_RESULT SUEntityGetAttributeDictionary(
+    SUEntityRef entity, const char* name, SUAttributeDictionaryRef* dictionary);
+
+/**
+@brief Retrieves the model object associated with the entity.
+@since SketchUp 2018 M0, API 6.0
+@param[in]  entity The entity.
+@param[out] model  The model object retrieved.
+@related SUEntityRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if entity is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if model is NULL
+- \ref SU_ERROR_NO_DATA if the entity is not associated with a model
+*/
+SU_RESULT SUEntityGetModel(SUEntityRef entity, SUModelRef* model);
+
+/**
+@brief Retrieves the entities object which contains the entity.
+@since SketchUp 2018 M0, API 6.0
+@param[in]  entity   The entity.
+@param[out] entities The entities object retrieved.
+@related SUEntityRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if entity is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if entities is NULL
+- \ref SU_ERROR_NO_DATA if the entity is not contained by an entities object
+*/
+SU_RESULT SUEntityGetParentEntities(SUEntityRef entity, SUEntitiesRef* entities);
+
+#ifdef __cplusplus
+}  // extern "C"
+#endif
+
+#endif  // SKETCHUP_MODEL_ENTITY_H_

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

@@ -0,0 +1,80 @@
+// Copyright 2017 Trimble Inc. All Rights Reserved.
+
+/**
+ * @file
+ * @brief Interfaces for SUEntityListRef.
+ */
+#ifndef SKETCHUP_MODEL_ENTITY_LIST_H_
+#define SKETCHUP_MODEL_ENTITY_LIST_H_
+
+#include <SketchUpAPI/model/defs.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+@struct SUEntityListRef
+@brief  References an entity list.
+@since SketchUp 2018, API 6.0
+*/
+
+/**
+@brief Creates an entity list object.
+@since SketchUp 2018, API 6.0
+@param[in,out] list The entity list object to be created.
+@related SUEntityListRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if list is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if list already references a valid object
+*/
+SU_RESULT SUEntityListCreate(SUEntityListRef* list);
+
+/**
+@brief Releases a list object.
+@since SketchUp 2018, API 6.0
+@param[in,out] list The list object to be released.
+@related SUEntityListRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if list is NULL
+- \ref SU_ERROR_INVALID_INPUT if list does not reference a valid object
+*/
+SU_RESULT SUEntityListRelease(SUEntityListRef* list);
+
+/**
+@brief Sets the iterator reference to the beginning of the list. The given
+       iterator object must have been constructed using
+       SUEntityListIteratorCreate(). The iterator must be released using
+       SUEntityListIteratorRelease() when it is no longer needed.
+@since SketchUp 2018, API 6.0
+@param[in]  list     The list.
+@param[out] iterator An iterator Ref reference the beginning of the list.
+@related SUEntityListRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if list is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if iterator is NULL
+- \ref SU_ERROR_INVALID_OUTPUT if *iterator is not a valid object
+*/
+SU_RESULT SUEntityListBegin(SUEntityListRef list, SUEntityListIteratorRef* iterator);
+
+/**
+@brief Gets the number of entities in the list.
+@since SketchUp 2018, API 6.0
+@param[in]  list  The list object.
+@param[out] count The list size.
+@related SUEntityListRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if list is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if count is NULL
+*/
+SU_RESULT SUEntityListSize(SUEntityListRef list, size_t* count);
+
+#ifdef __cplusplus
+}  // extern "C"
+#endif
+
+#endif  // SKETCHUP_MODEL_ENTITY_LIST_H_

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

@@ -0,0 +1,90 @@
+// Copyright 2017 Trimble Inc. All Rights Reserved.
+
+/**
+ * @file
+ * @brief Interfaces for SUEntityListIteratorRef.
+ */
+#ifndef SKETCHUP_MODEL_ENTITY_LIST_ITERATOR_H_
+#define SKETCHUP_MODEL_ENTITY_LIST_ITERATOR_H_
+
+#include <SketchUpAPI/model/defs.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+@struct SUEntityListIteratorRef
+@brief  References an entity list iterator object.
+@since SketchUp 2018, API 6.0
+*/
+
+/**
+@brief Creates an entity list iterator object.
+@since SketchUp 2018, API 6.0
+@param[in,out] iterator The entity list iterator object to be created.
+@related SUEntityListIteratorRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if iterator is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if iterator already references a valid object
+*/
+SU_RESULT SUEntityListIteratorCreate(SUEntityListIteratorRef* iterator);
+
+/**
+@brief Releases a iterator object.
+@since SketchUp 2018, API 6.0
+@param[in,out] iterator The iterator object to be released.
+@related SUEntityListIteratorRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if iterator is NULL
+- \ref SU_ERROR_INVALID_INPUT if iterator does not reference a valid object
+*/
+SU_RESULT SUEntityListIteratorRelease(SUEntityListIteratorRef* iterator);
+
+/**
+@brief Retrieves the specified entity pointer from the given iterator.
+@since SketchUp 2018, API 6.0
+@param[in]  iterator The iterator from which to retrieve the entity.
+@param[out] entity   The entity reference retrieved.
+@related SUEntityListIteratorRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if iterator is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if entity is NULL
+- \ref SU_ERROR_NO_DATA if the iterator references an invalid entity
+*/
+SU_RESULT SUEntityListIteratorGetEntity(SUEntityListIteratorRef iterator, SUEntityRef* entity);
+
+/**
+@brief Increments the provided iterator.
+@since SketchUp 2018, API 6.0
+@param[in,out] iterator The iterator to be incremented.
+@related SUEntityListIteratorRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if iterator is not a valid object
+- \ref SU_ERROR_OUT_OF_RANGE if reached the end of the collection
+*/
+SU_RESULT SUEntityListIteratorNext(SUEntityListIteratorRef iterator);
+
+/**
+@brief Checks if the iterator is still within range of the list.
+@since SketchUp 2018, API 6.0
+@param[in]  iterator The iterator to be queried.
+@param[out] in_range A boolean indicating if the iterator is in range.
+@related SUEntityListIteratorRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if iterator is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if in_range is NULL
+- \ref SU_ERROR_OUT_OF_RANGE if the iterator is at the end of the collection
+*/
+SU_RESULT SUEntityListIteratorIsInRange(SUEntityListIteratorRef iterator, bool* in_range);
+
+#ifdef __cplusplus
+}  // extern "C"
+#endif
+
+#endif  // SKETCHUP_MODEL_ENTITY_LIST_ITERATOR_H_