scriptup 0.0.0

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

@@ -0,0 +1,1663 @@
+// Copyright 2013-2020 Trimble Inc Ltd. All Rights Reserved.
+
+/**
+ * @file
+ * @brief Interfaces for SUModelRef.
+ */
+#ifndef SKETCHUP_MODEL_MODEL_H_
+#define SKETCHUP_MODEL_MODEL_H_
+
+#include <SketchUpAPI/common.h>
+#include <SketchUpAPI/unicodestring.h>
+#include <SketchUpAPI/model/defs.h>
+#include <SketchUpAPI/model/model_version.h>
+
+#pragma pack(push, 8)
+
+#if defined(__APPLE__)
+  // This is added to remove the missing declarations warning on the mac
+  // for an enum defined inside a structure. [SUEntityType]
+  #pragma GCC diagnostic push
+  #pragma GCC diagnostic ignored "-Wmissing-declarations"
+#endif
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+@struct SUModelRef
+@brief A SketchUp model.
+*/
+
+/**
+@struct SUModelStatistics
+@brief Contains an array of entity counts that can be indexed per entity type.
+*/
+struct SUModelStatistics {
+  /**
+  @enum SUEntityType
+  @brief Types of \ref SUEntityRef objects.
+  */
+  enum SUEntityType {
+    SUEntityType_Edge = 0,             ///< SUEdgeRef entities
+    SUEntityType_Face,                 ///< SUFaceRef entities
+    SUEntityType_ComponentInstance,    ///< SUComponentInstanceRef entities
+    SUEntityType_Group,                ///< SUGroupRef entities
+    SUEntityType_Image,                ///< SUImageRef entities
+    SUEntityType_ComponentDefinition,  ///< SUComponentDefinitionRef entities
+    SUEntityType_Layer,                ///< SULayerRef entities
+    SUEntityType_Material,             ///< SUMaterialRef entities
+    SUNumEntityTypes                   ///< Number of entity types
+  };
+  int entity_counts[SUNumEntityTypes];  ///< Count of each entity type.
+};
+
+/**
+@enum SUModelUnits
+@brief Units options settings
+*/
+enum SUModelUnits {
+  SUModelUnits_Inches,
+  SUModelUnits_Feet,
+  SUModelUnits_Millimeters,
+  SUModelUnits_Centimeters,
+  SUModelUnits_Meters
+};
+
+/**
+@enum SUModelLoadStatus
+@brief Provides additional status information after loading a model successfully.
+@since SketchUp 2021, API 9.0
+*/
+enum SUModelLoadStatus {
+  SUModelLoadStatus_Success = 0,        ///< Model was loaded successfully.
+  SUModelLoadStatus_Success_MoreRecent  ///< Model was loaded successfully,
+                                        ///< however it was saved by a newer
+                                        ///< version of SketchUp. We strongly
+                                        ///< recommended that you update your SDK
+                                        ///< to the latest version.
+};
+
+/**
+@brief Creates an empty model object for the purposes of writing a SketchUp
+        document. This model object must be released with \ref SUModelRelease().
+@param[out] model The model object created.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if model is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if model is already a valid object
+*/
+SU_RESULT SUModelCreate(SUModelRef* model);
+
+/**
+@brief Creates a model from a SketchUp file on local disk.  This model object
+       must be released with \ref SUModelRelease().
+@deprecated This method will be removed in SketchUp 2022.0. It is replaced by
+            SUModelCreateFromFileWithStatus() which can read models
+            saved by newer versions of SketchUp.
+@param[out] model     The model object created.
+@param[in]  file_path The source file path of the SketchUp file. Assumed to be
+                      UTF-8 encoded.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if \p file_path is NULL
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if \p model is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if \p model is already a valid object
+- \ref SU_ERROR_SERIALIZATION if an error occurs during reading of the file
+- \ref SU_ERROR_MODEL_INVALID if the file specified by \p file_path is an
+  invalid model. (since SketchUp 2014, API 2.0)
+- \ref SU_ERROR_MODEL_VERSION if the model file has a newer version
+  than is supported by the current build of the SDK. (since SketchUp 2014, API 2.0)
+*/
+SU_DEPRECATED_FUNCTION("SketchUp API 9.0")
+SU_RESULT SUModelCreateFromFile(SUModelRef* model, const char* file_path);
+
+/**
+@brief Creates a model from a SketchUp file on local disk. This model object
+       must be released with \ref SUModelRelease().
+@since SketchUp 2021, API 9.0
+
+@note  As of SketchUp 2021.0, SketchUp can open .skp files created with newer versions of SketchUp.
+       However, opening newer versions with an older SDK might omit model data. Use the load
+       \p status value to check if the file was created with a newer version of SketchUp.
+
+@warning When reading a file created with a newer version of SketchUp, you may lose data
+         if you write over the same file.
+
+@param[out] model     The model object created.
+@param[in]  file_path The source file path of the SketchUp file. Assumed to be
+                      UTF-8 encoded.
+@param[out] status    Returns additional information on the status of a
+                      successful operation. Valid when the return value is
+                      \ref SU_ERROR_NONE.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if \p file_path is NULL
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if \p model is NULL
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if \p status is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if \p model is already a valid object
+- \ref SU_ERROR_SERIALIZATION if an error occurs during reading of the file
+- \ref SU_ERROR_MODEL_INVALID if the file specified by \p file_path is an
+  invalid model.
+- \ref SU_ERROR_MODEL_VERSION if the model file has a newer version
+  than is supported by the current build of the SDK.
+*/
+SU_RESULT SUModelCreateFromFileWithStatus(
+    SUModelRef* model, const char* file_path, enum SUModelLoadStatus* status);
+
+/**
+@brief Creates a model from a SketchUp skp file buffer.  This model object must
+       be released with \ref SUModelRelease().
+@since SketchUp 2017 M2, API 5.2
+@deprecated This method will be removed in SketchUp 2022.0. It is replaced by
+            SUModelCreateFromBufferWithStatus() which can read models saved by newer
+            versions of SketchUp.
+@param[out] model       The model object created.
+@param[in]  buffer      The SketchUp file buffer.
+@param[in]  buffer_size The SketchUp file buffer size.
+@related SUModelRef
+@return
+ - \ref SU_ERROR_NONE on success
+ - \ref SU_ERROR_NULL_POINTER_INPUT if \p buffer is NULL
+ - \ref SU_ERROR_NULL_POINTER_OUTPUT if \p model is NULL
+ - \ref SU_ERROR_OVERWRITE_VALID if \p model is already a valid object
+ - \ref SU_ERROR_SERIALIZATION if an error occurs during reading of the file
+ - \ref SU_ERROR_MODEL_INVALID if the file specified by \p buffer is an
+   invalid model.
+ - \ref SU_ERROR_MODEL_VERSION if the model buffer has a newer version
+  than is supported by the current build of the SDK.
+ */
+SU_DEPRECATED_FUNCTION("SketchUp API 9.0")
+SU_RESULT SUModelCreateFromBuffer(
+    SUModelRef* model, const unsigned char* buffer, size_t buffer_size);
+
+/**
+@brief Creates a model from a SketchUp skp file buffer.  This model object must
+       be released with \ref SUModelRelease().
+@since SketchUp 2021, API 9.0
+
+@note  As of SketchUp 2021.0, SketchUp can open .skp files created with newer versions of SketchUp.
+       However, opening newer versions with an older SDK might omit model data. Use the load
+       \p status value to check if the file was created with a newer version of SketchUp.
+
+@warning When reading a file created with a newer version of SketchUp, you may lose data
+         if you write over the same file.
+
+@param[out] model       The model object created.
+@param[in]  buffer      The SketchUp file buffer.
+@param[in]  buffer_size The SketchUp file buffer size.
+@param[out] status      Returns additional information on the status of a
+                        successful operation. Valid when the return value is
+                        \ref SU_ERROR_NONE.
+@related SUModelRef
+@return
+ - \ref SU_ERROR_NONE on success
+ - \ref SU_ERROR_NULL_POINTER_INPUT if \p buffer is NULL
+ - \ref SU_ERROR_NULL_POINTER_OUTPUT if \p model is NULL
+ - \ref SU_ERROR_NULL_POINTER_OUTPUT if \p status is NULL
+ - \ref SU_ERROR_OVERWRITE_VALID if model is already a valid object
+ - \ref SU_ERROR_SERIALIZATION if an error occurs during reading of the file
+ - \ref SU_ERROR_MODEL_INVALID if the file specified by \p buffer is an invalid
+ model.
+ - \ref SU_ERROR_MODEL_VERSION if the model buffer has a newer version
+  than is supported by the current build of the SDK.
+ */
+SU_RESULT SUModelCreateFromBufferWithStatus(
+    SUModelRef* model, const unsigned char* buffer, size_t buffer_size,
+    enum SUModelLoadStatus* status);
+
+/**
+@brief Releases a model object and its associated resources. The root component
+       of the model object and all its child objects must not be released
+       explicitly
+@param[in] model The model object.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is an invalid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if model is NULL
+*/
+SU_RESULT SUModelRelease(SUModelRef* model);
+
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
+/**
+@brief Returns a model reference for a given internal model representation.
+        This model object must NOT be released with \ref SUModelRelease().
+@param[in] data Internal model representation.
+@related SUModelRef
+@return The created model reference.
+*/
+SU_EXPORT SUModelRef SUModelFromExisting(uintptr_t data);
+#endif  // DOXYGEN_SHOULD_SKIP_THIS
+
+/**
+@brief Retrieves the root model entities.
+@param[in]  model    The model object.
+@param[out] entities The entities retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is an invalid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if entities is NULL
+*/
+SU_RESULT SUModelGetEntities(SUModelRef model, SUEntitiesRef* entities);
+
+/**
+@brief Retrieves the model entities of the active context
+       (open group or component).
+@since SketchUp 2020.2, API 8.2
+@param[in]  model    The model object.
+@param[out] entities The entities retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if \p model is an invalid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if \p entities is `NULL`
+*/
+SU_RESULT SUModelGetActiveEntities(SUModelRef model, SUEntitiesRef* entities);
+
+/**
+@brief Retrieves the instance path of the active context
+       (open group or component).
+@note This method only works from within the SketchUp application.
+@param[in]  model         The model object.
+@param[out] instance_path The instance path retrieved. This must be released to
+                          avoid memory leak.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if \p model is an invalid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if \p instance_path is `NULL`
+- \ref SU_ERROR_OVERWRITE_VALID if \p instance_path is already a valid object
+- \ref SU_ERROR_NO_DATA if there is no active path open.
+- \ref SU_ERROR_NO_DATA if this isn't called from within SketchUp
+*/
+SU_RESULT SUModelGetActivePath(SUModelRef model, SUInstancePathRef* instance_path);
+
+/**
+@brief Retrieves the number of materials in a model object.
+@param[in]  model The model object.
+@param[out] count The number of material objects available.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if count is NULL
+*/
+SU_RESULT SUModelGetNumMaterials(SUModelRef model, size_t* count);
+
+/**
+@brief Retrieves all the materials associated with a model object.
+@param[in]  model     The model object.
+@param[in]  len       The number of material objects to retrieve.
+@param[out] materials The material objects retrieved.
+@param[out] count     The number of material objects retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if materials or count is NULL
+*/
+SU_RESULT SUModelGetMaterials(
+    SUModelRef model, size_t len, SUMaterialRef materials[], size_t* count);
+
+/**
+@brief Adds materials to a model object. Note that the materials cannot be
+       already owned.
+@param[in] model     The model object.
+@param[in] len       The number of material objects to add.
+@param[in] materials The array of material objects to add.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if materials is NULL
+- \ref SU_ERROR_PARTIAL_SUCCESS if any of the materials are already owned
+*/
+SU_RESULT SUModelAddMaterials(SUModelRef model, size_t len, const SUMaterialRef materials[]);
+
+/**
+@brief Loads a material from a SKM file.
+
+If a matching material exists in the model it will be returned instead.
+
+@since SketchUp 2021.1, API 9.1
+@param[in]  model      The model object.
+@param[in]  file_path  The location to load the material from. Assumed to be
+                       UTF-8 encoded.
+@param[out] material   The material object.
+@related SUMaterialRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if \p model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if \p file_path is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if \p material is already a valid object
+- \ref SU_ERROR_SERIALIZATION if the serialization operation itself fails
+*/
+SU_RESULT SUModelLoadMaterial(SUModelRef model, const char* file_path, SUMaterialRef* material);
+
+/**
+@brief Retrieves the number of components associated with a model.
+@param[in]  model The model object.
+@param[out] count The number of components available.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if count is NULL
+*/
+SU_RESULT SUModelGetNumComponentDefinitions(SUModelRef model, size_t* count);
+
+/**
+@brief Retrieves the component definitions that define component instances but
+        not groups.
+@param[in]  model       The model object.
+@param[in]  len         The number of component definitions to retrieve.
+@param[out] definitions The component definitions retrieved.
+@param[out] count       The number of component definitions retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if definitions or count is NULL
+*/
+SU_RESULT SUModelGetComponentDefinitions(
+    SUModelRef model, size_t len, SUComponentDefinitionRef definitions[], size_t* count);
+
+/**
+@brief Retrieves the number of component definitions that define groups.
+@since SketchUp 2016, API 4.0
+@param[in]  model The model object.
+@param[out] count The number of component definitions available.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if count is NULL
+*/
+SU_RESULT SUModelGetNumGroupDefinitions(SUModelRef model, size_t* count);
+
+/**
+@brief Retrieves the component definitions that define groups.
+@since SketchUp 2016, API 4.0
+@param[in]  model       The model object.
+@param[in]  len         The number of component definitions to retrieve.
+@param[out] definitions The component definitions retrieved.
+@param[out] count       The number of component definitions retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if definitions or count is NULL
+*/
+SU_RESULT SUModelGetGroupDefinitions(
+    SUModelRef model, size_t len, SUComponentDefinitionRef definitions[], size_t* count);
+
+/**
+@brief Retrieves the number of component definitions that define images.
+@since SketchUp 2019, API 7.0
+@param[in]  model The model object.
+@param[out] count The number of component definitions available.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if count is NULL
+*/
+SU_RESULT SUModelGetNumImageDefinitions(SUModelRef model, size_t* count);
+
+/**
+@brief Retrieves the component definitions that define images.
+@since SketchUp 2019, API 7.0
+@param[in]  model       The model object.
+@param[in]  len         The number of component definitions to retrieve.
+@param[out] definitions The component definitions retrieved.
+@param[out] count       The number of component definitions retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if definitions or count is NULL
+*/
+SU_RESULT SUModelGetImageDefinitions(
+    SUModelRef model, size_t len, SUComponentDefinitionRef definitions[], size_t* count);
+
+/**
+@brief Adds component definitions to a model object.
+@param[in] model      The model object.
+@param[in] len        The number of component definitions to add.
+@param[in] components The array of component definitions to add.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if components is NULL
+*/
+SU_RESULT SUModelAddComponentDefinitions(
+    SUModelRef model, size_t len, const SUComponentDefinitionRef components[]);
+
+/**
+@brief Remove definitions of components, images, and groups from a model object.
+       All component definitions, their geometry, and attached instances will be
+       released.
+@since SketchUp 2019.2, API 7.1
+@param[in] model      The model object.
+@param[in] len        The number of component definitions to remove.
+@param[in] components The array of component definitions to remove.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_OUT_OF_RANGE if the number of components is less than one
+- \ref SU_ERROR_NULL_POINTER_INPUT if components is NULL
+- \ref SU_ERROR_PARTIAL_SUCCESS if removing a component definition fails
+  mid-process
+*/
+SU_RESULT SUModelRemoveComponentDefinitions(
+    SUModelRef model, size_t len, SUComponentDefinitionRef components[]);
+
+/**
+@brief Saves the model to a file.
+@note Prior to SketchUp 2019.2, API 7.1 this function did not generate a new
+      model GUID.
+@param[in] model     The model object.
+@param[in] file_path The file path destination of the serialization operation.
+                     Assumed to be UTF-8 encoded.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if file_path is NULL
+- \ref SU_ERROR_SERIALIZATION if the serialization operation itself fails
+*/
+SU_RESULT SUModelSaveToFile(SUModelRef model, const char* file_path);
+
+/**
+@brief Saves the model to a file using a specific SketchUp version format.
+@note Prior to SketchUp 2019.2, API 7.1 this function did not generate a new
+      model GUID.
+@since SketchUp 2014, API 2.0
+@param[in] model     The model object.
+@param[in] file_path The file path destination of the serialization operation.
+                     Assumed to be UTF-8 encoded.
+@param[in] version   The SKP file format version to use when saving.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_MODEL_VERSION if version is invalid
+- \ref SU_ERROR_NULL_POINTER_INPUT if file_path is NULL
+- \ref SU_ERROR_SERIALIZATION if the serialization operation itself fails
+*/
+SU_RESULT SUModelSaveToFileWithVersion(
+    SUModelRef model, const char* file_path, enum SUModelVersion version);
+
+/**
+@brief Retrieves the camera of a model object. The returned camera object
+        points to model's internal camera. So it must not be released via
+        SUCameraRelease().
+@param[in]  model  The model object.
+@param[out] camera The camera object retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if camera is NULL
+*/
+SU_RESULT SUModelGetCamera(SUModelRef model, SUCameraRef* camera);
+
+/**
+@brief Sets the current camera of a model object.
+@since SketchUp 2016, API 4.0
+@param[in] model  The model object.
+@param[in] camera The camera object. This reference will become invalid when
+                  this function returns.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_INVALID_INPUT if camera is not a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if camera is NULL
+*/
+SU_RESULT SUModelSetCamera(SUModelRef model, SUCameraRef* camera);
+
+/**
+@brief Retrieves the number of scene cameras of a model object.
+@param[in]  model      The model object.
+@param[out] num_scenes The number of scenes available.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if num_scenes is NULL
+*/
+SU_RESULT SUModelGetNumScenes(SUModelRef model, size_t* num_scenes);
+
+/**
+@brief Retrieves the number of layers in a model object.
+@note This counts all layers regardless of whether or not they are contained
+in a \ref SULayerFolderRef.
+@param[in]  model The model object.
+@param[out] count The number of layers available.
+@related SUModelRef
+@see SUModelGetNumTopLevelLayers()
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT of model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if count is NULL
+*/
+SU_RESULT SUModelGetNumLayers(SUModelRef model, size_t* count);
+
+/**
+@brief Retrieves the layers in a model object.
+@note This retrieves all layers regardless of whether or not they are contained
+in a \ref SULayerFolderRef.
+@param[in]  model  The model object.
+@param[in]  len    The number of layers to retrieve.
+@param[out] layers The layers retrieved.
+@param[out] count  The number of layers retrieved.
+@related SUModelRef
+@see SUModelGetTopLevelLayers()
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT of model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if layers or count is NULL
+*/
+SU_RESULT SUModelGetLayers(SUModelRef model, size_t len, SULayerRef layers[], size_t* count);
+
+/**
+@brief Adds layer objects to a model object.
+@param[in] model  The model object.
+@param[in] len    The number of layers to add.
+@param[in] layers The layers to add.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT of model is not a valid object
+- \ref SU_ERROR_INVALID_INPUT if any item in layers is not a valid object
+*/
+SU_RESULT SUModelAddLayers(SUModelRef model, size_t len, const SULayerRef layers[]);
+
+/**
+@brief Retrieves the default layer object of a model object.
+@param[in]  model The model object.
+@param[out] layer The layer object retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT of model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if layer is NULL
+*/
+SU_RESULT SUModelGetDefaultLayer(SUModelRef model, SULayerRef* layer);
+
+/**
+@brief Removes all layers provided in the array. The default layer cannot be
+removed. All entities on the deleted layers will be moved to the default layer.
+@since SketchUp 2019.2 API 7.1
+@param[in]  model    The model object.
+@param[in]  len      The length of the array.
+@param[in]  layers   The layers to be deleted.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if layers is NULL
+- \ref SU_ERROR_OUT_OF_RANGE if len is less than one.
+- \ref SU_ERROR_PARTIAL_SUCCESS if removing the layers failed mid-process
+*/
+SU_RESULT SUModelRemoveLayers(SUModelRef model, size_t len, SULayerRef layers[]);
+
+/**
+@brief Retrieves the active layer object of a model object.
+@since SketchUp 2020, API 8.0
+@param[in]  model The model object.
+@param[out] layer The layer object retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if layer is NULL
+*/
+SU_RESULT SUModelGetActiveLayer(SUModelRef model, SULayerRef* layer);
+
+/**
+ @brief Sets the active layer object of a model object.
+ @since SketchUp 2020, API 8.0
+ @param[in] model The model object.
+ @param[in] layer The layer object to be set as the active layer.
+ @related SUModelRef
+ @return
+ - \ref SU_ERROR_NONE on success
+ - \ref SU_ERROR_INVALID_ARGUMENT if layer doesn't belong to model
+ - \ref SU_ERROR_INVALID_INPUT if model or layer is not a valid object
+ */
+SU_RESULT SUModelSetActiveLayer(SUModelRef model, SULayerRef layer);
+
+/**
+@brief Retrieves the version of a model object.  The version consists of three
+numbers: major version number, minor version number, and the build number.
+@param[in]  model The model object.
+@param[out] major The major version number retrieved.
+@param[out] minor The minor version number retrieved.
+@param[out] build The build version number retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if major, minor, or build is NULL
+*/
+SU_RESULT SUModelGetVersion(SUModelRef model, int* major, int* minor, int* build);
+
+/**
+@brief Retrieves the number of attribute dictionaries of a model object.
+@param[in]  model The model object.
+@param[out] count The number of attribute dictionaries available.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if count is NULL
+*/
+SU_RESULT SUModelGetNumAttributeDictionaries(SUModelRef model, size_t* count);
+
+/**
+@brief Retrieves the attribute dictionaries of a model object.
+@param[in]  model        The model object.
+@param[in]  len          The number of attribute dictionaries to retrieve.
+@param[out] dictionaries The dictionaries retrieved.
+@param[out] count        The number of attribute dictionaries retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if dictionaries or count is NULL
+*/
+SU_RESULT SUModelGetAttributeDictionaries(
+    SUModelRef model, size_t len, SUAttributeDictionaryRef dictionaries[], size_t* count);
+
+/**
+@brief Retrieves the attribute dictionary of a model object that has the given
+        name. If a dictionary with the given name does not exist, one is added
+        to the model object.
+@param[in] model       The model object.
+@param[in] name        The name of the attribute dictionary to retrieve. Assumed
+                       to be UTF-8 encoded.
+@param[out] dictionary The dictionary object retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if name is NULL
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if dictionary is NULL
+*/
+SU_RESULT SUModelGetAttributeDictionary(
+    SUModelRef model, const char* name, SUAttributeDictionaryRef* dictionary);
+
+/**
+@brief Retrieves whether the model is georeferenced.
+@since SketchUp 2017, API 5.0
+@param[in]  model      The model object.
+@param[out] is_geo_ref The flag retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if is_used is NULL
+*/
+SU_RESULT SUModelIsGeoReferenced(SUModelRef model, bool* is_geo_ref);
+
+/**
+@brief Retrieves the location information of a given model.
+@param[in]  model    The model object.
+@param[out] location The location retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if location is NULL
+*/
+SU_RESULT SUModelGetLocation(SUModelRef model, SULocationRef* location);
+
+/**
+@brief Calculates the sum of all entities by type in the model.
+@param[in]  model      The model object.
+@param[out] statistics The SUModelStatistics() struct that will be populated
+                       with the number of each entity type in the model.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if statistics is NULL
+*/
+SU_RESULT SUModelGetStatistics(SUModelRef model, struct SUModelStatistics* statistics);
+
+/**
+@brief Georeferences the model.
+@param[in] model               The model object.
+@param[in] latitude            Latitude of the model.
+@param[in] longitude           Longitude of the model.
+@param[in] altitude            Altitude of the model.
+@param[in] is_z_value_centered Indicates if z value should be centered.
+@param[in] is_on_ocean_floor   Indicates whether the model is on the ocean
+                               floor.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object or if latitude or
+  longitude does not lie within a valid range
+*/
+SU_RESULT SUModelSetGeoReference(
+    SUModelRef model, double latitude, double longitude, double altitude, bool is_z_value_centered,
+    bool is_on_ocean_floor);
+
+/**
+@brief Retrieves the rendering options of a model object.
+@param[in]  model             The model object.
+@param[out] rendering_options The rendering options object retrieved. This
+                              object is owned by the model and must not be
+                              explicitly released.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if rendering_options is NULL
+- \ref SU_ERROR_NO_DATA if no rendering options is available
+*/
+SU_RESULT SUModelGetRenderingOptions(SUModelRef model, SURenderingOptionsRef* rendering_options);
+
+/**
+@brief Retrieves the shadow info of a model object.
+@since SketchUp 2015, API 3.0
+@param[in]  model       The model object.
+@param[out] shadow_info The shadow info object retrieved. This object is owned
+                        by the model and must not be explicitly released.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if shadow_info is NULL
+- \ref SU_ERROR_NO_DATA if no shadow info is available
+*/
+SU_RESULT SUModelGetShadowInfo(SUModelRef model, SUShadowInfoRef* shadow_info);
+
+/**
+@brief Retrieves options manager associated with the model.
+@param[in]  model           The model object.
+@param[out] options_manager The options manager object retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if options_manager is NULL
+*/
+SU_RESULT SUModelGetOptionsManager(SUModelRef model, SUOptionsManagerRef* options_manager);
+
+/**
+@brief Retrieves the angle which will rotate the north direction to the y-axis
+        for a given model.
+@param[in]  model            The model object.
+@param[out] north_correction The north correction angle retrieved (in degrees).
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if north_angle is NULL
+*/
+SU_RESULT SUModelGetNorthCorrection(SUModelRef model, double* north_correction);
+
+/**
+@brief Merges all adjacent, coplanar faces in the model.
+@param[in] model The model object.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid
+*/
+SU_RESULT SUModelMergeCoplanarFaces(SUModelRef model);
+
+/**
+@brief Retrieves all the scenes associated with a model object.
+@param[in]  model  The model object.
+@param[in]  len    The number of scene objects to retrieve.
+@param[out] scenes The scene objects retrieved.
+@param[out] count  The number of scene objects retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if scenes or count is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if any element of scenes is already a valid
+  object
+- \ref SU_ERROR_NO_DATA if there are no scene objects to retrieve.
+*/
+SU_RESULT SUModelGetScenes(SUModelRef model, size_t len, SUSceneRef scenes[], size_t* count);
+
+/**
+@brief Retrieves the scenes with the given name associated with a model object.
+@param[in]  model The model object.
+@param[in]  name  The name of scene object to retrieve.
+@param[out] scene The scene object retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if name is NULL
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if scene is NULL
+- \ref SU_ERROR_NO_DATA if there are no scene objects to retrieve.
+*/
+SU_RESULT SUModelGetSceneWithName(SUModelRef model, const char* name, SUSceneRef* scene);
+
+/**
+@brief Adds scenes to a model object.
+
+@warning Breaking Change: The behavior of SUModelAddScenes changed in
+         SketchUp SDK 2018 API 6.0 to return SU_ERROR_INVALID_ARGUMENT if at
+         least one scene name already exists in the model or if there are
+         duplicated names in the scenes array.
+
+@param[in] model  The model object.
+@param[in] len    The number of scene objects to add.
+@param[in] scenes The array of scene objects to add.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if scenes is NULL
+- \ref SU_ERROR_INVALID_ARGUMENT if the names of the given scenes are not unique
+       among themselves or among existing scenes
+*/
+SU_RESULT SUModelAddScenes(SUModelRef model, size_t len, const SUSceneRef scenes[]);
+
+/**
+@brief Adds scenes to a model object.
+
+@warning Breaking Change: The behavior of SUModelAddScene changed in
+         SketchUp SDK 2018 API 6.0 to return SU_ERROR_INVALID_ARGUMENT if the
+         given scene name already exists in the model.
+
+@param[in]  model     The model object.
+@param[in]  index     Where in the list to add the scene. -1 to place at the end.
+@param[in]  scene     The scene object to add.
+@param[out] out_index The index that the scene was added at.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model or scene are not a valid object
+- \ref SU_ERROR_INVALID_ARGUMENT if a scene with the same name already exists
+*/
+SU_RESULT SUModelAddScene(SUModelRef model, int index, SUSceneRef scene, int* out_index);
+
+/**
+@brief Retrieves the active scene associated with a model object.
+@since SketchUp 2016, API 4.0
+@param[in]  model The model object.
+@param[out] scene The scene object retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if scene is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if scene is already a valid object
+- \ref SU_ERROR_NO_DATA if there is no active scene to retrieve
+*/
+SU_RESULT SUModelGetActiveScene(SUModelRef model, SUSceneRef* scene);
+
+/**
+@brief Sets the provided scene as the active scene.
+@since SketchUp 2016, API 4.0
+@param[in] model The model object.
+@param[in] scene The scene object to be set as the active scene.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model or scene is not a valid object
+- \ref SU_ERROR_GENERIC if try to activate a scene which is not in the model
+*/
+SU_RESULT SUModelSetActiveScene(SUModelRef model, SUSceneRef scene);
+
+/**
+@brief Adds a single matched photo scene to a model object.
+@since SketchUp 2015, API 3.0
+@param[in]  model      The model object.
+@param[in]  image_file The full path of the image associated with this scene.
+@param[in]  camera     The camera associated with this scene.
+@param[in]  scene_name The name of the scene to add.
+@param[out] scene      The scene object created.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model or camera is not a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if scene_name or image_file is NULL
+- \ref SU_ERROR_INVALID_OUTPUT if scene is NULL
+- \ref SU_ERROR_GENERIC if image_file is invalid or not found
+*/
+SU_RESULT SUModelAddMatchPhotoScene(
+    SUModelRef model, const char* image_file, SUCameraRef camera, const char* scene_name,
+    SUSceneRef* scene);
+
+/**
+@brief Retrieves the name of a model object.
+@param[in]  model The model object.
+@param[out] name  The destination of the retrieved name object.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model 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 SUModelGetName(SUModelRef model, SUStringRef* name);
+
+/**
+@brief Sets the name of a model object.
+@param[in] model The model object.
+@param[in] name  The name of the model object. Assumed to be UTF-8 encoded.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is an invalid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if name is NULL
+*/
+SU_RESULT SUModelSetName(SUModelRef model, const char* name);
+
+/**
+@brief Retrieves the file path of a model object.
+@since SketchUp 2018, API 6.0
+@param[in]  model  The model object.
+@param[out] path   The destination of the retrieved path object.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is an invalid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if path is NULL
+- \ref SU_ERROR_INVALID_OUTPUT if path does not point to a valid \ref
+  SUStringRef object
+*/
+SU_RESULT SUModelGetPath(SUModelRef model, SUStringRef* path);
+
+/**
+@brief Retrieves the title of a model object.
+@since SketchUp 2018, API 6.0
+@param[in]  model  The model object.
+@param[out] title  The destination of the retrieved title object.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is an invalid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if title is NULL
+- \ref SU_ERROR_INVALID_OUTPUT if title does not point to a valid \ref
+  SUStringRef object
+*/
+SU_RESULT SUModelGetTitle(SUModelRef model, SUStringRef* title);
+
+/**
+@brief Retrieves the description of a model object.
+@param[in]  model        The model object.
+@param[out] description  The destination of the retrieved description object.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is an invalid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if description is NULL
+- \ref SU_ERROR_INVALID_OUTPUT if description does not point to a valid \ref
+  SUStringRef object
+*/
+SU_RESULT SUModelGetDescription(SUModelRef model, SUStringRef* description);
+
+/**
+@brief Sets the description of a model object.
+@param[in] model        The model object.
+@param[in] description  The description of the model object. Assumed to be UTF-8
+                        encoded.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is an invalid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if description is NULL
+*/
+SU_RESULT SUModelSetDescription(SUModelRef model, const char* description);
+
+/**
+@brief Returns the units associated with the given model.
+@param[in]  model The model object.
+@param[out] units The units retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is an invalid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if the units argument is invalid
+*/
+SU_RESULT SUModelGetUnits(SUModelRef model, enum SUModelUnits* units);
+
+/**
+@brief Retrieves the classifications of a model object.
+@param[in]  model            The model object.
+@param[out] classifications  The classifications object retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if classifications is NULL
+*/
+SU_RESULT SUModelGetClassifications(SUModelRef model, SUClassificationsRef* classifications);
+
+/**
+@brief Retrieves the axes of a model object.
+@param[in]  model The model object.
+@param[out] axes  The axes object retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if axes is NULL
+*/
+SU_RESULT SUModelGetAxes(SUModelRef model, SUAxesRef* axes);
+
+/**
+@brief Retrieves the styles of a model object.
+@since SketchUp 2017, API 5.0
+@param[in]  model  The model object.
+@param[out] styles The styles object retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if manager is NULL
+*/
+SU_RESULT SUModelGetStyles(SUModelRef model, SUStylesRef* styles);
+
+/**
+@brief Retrieves the instance path (including an entity) corresponding
+       to a given persistent id.
+@param[in]  model             The model object.
+@param[in]  pid_ref            Persistent id of the entity.
+@param[out] instance_path_ref  Instance path to the entity.
+@related SUModelRef
+@note  Starting in SketchUp 2020.1, API 8.1, SU_ERROR_NO_DATA will be returned
+       if pid_ref isn't a valid instance path in the model.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model or pid_ref are not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if instance_path_ref is NULL
+- \ref SU_ERROR_NO_DATA if the persistent id path didn't exist in the model
+- \ref SU_ERROR_INVALID_OUTPUT if instance_path_ref is not a valid object
+- \ref SU_ERROR_PARTIAL_SUCCESS if an instance path can not be is fully traced
+- \ref SU_ERROR_GENERIC on general failure
+*/
+SU_RESULT SUModelGetInstancePathByPid(
+    SUModelRef model, SUStringRef pid_ref, SUInstancePathRef* instance_path_ref);
+
+/**
+@brief Retrieves the number of fonts in a model object.
+@since SketchUp 2017, API 5.0
+@param[in]  model The model object.
+@param[out] count The number of font objects available.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if count is NULL
+*/
+SU_RESULT SUModelGetNumFonts(SUModelRef model, size_t* count);
+
+/**
+@brief Retrieves all the fonts associated with a model object.
+@since SketchUp 2017, API 5.0
+@param[in]  model The model object.
+@param[in]  len   The number of font objects to retrieve.
+@param[out] fonts The font objects retrieved.
+@param[out] count The number of font objects retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if fonts or count is NULL
+*/
+SU_RESULT SUModelGetFonts(SUModelRef model, size_t len, SUFontRef fonts[], size_t* count);
+
+/**
+@brief Retrieves the dimension style associated with a model object.
+@since SketchUp 2017, API 5.0
+@param[in]  model The model object.
+@param[out] style The dimension style retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if style is NULL
+*/
+SU_RESULT SUModelGetDimensionStyle(SUModelRef model, SUDimensionStyleRef* style);
+
+/**
+@brief Retrieves length formatter settings from the model. The given length
+       formatter object must have been constructed using
+       SULengthFormatterCreate(). It must be released using
+       SULengthFormatterRelease().
+@since SketchUp 2018, API 6.0
+@param[in]  model     The model object.
+@param[out] formatter The formatter used to retrieve the settings.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if formatter is NULL
+- \ref SU_ERROR_INVALID_OUTPUT if formatter does not point to a valid \ref
+       SULengthFormatterRef object
+*/
+SU_RESULT SUModelGetLengthFormatter(SUModelRef model, SULengthFormatterRef* formatter);
+
+/**
+@brief Retrieves a unique material name from the model that is based on the
+       provided one. If the provided name is unique it will be returned,
+       otherwise any trailing indices will be replaced by a new index.
+@since SketchUp 2018, API 6.0
+@param[in]  model    The model object.
+@param[in]  in_name  The suggested name.
+@param[out] out_name The returned name.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if in_name is NULL
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if out_name is NULL
+- \ref SU_ERROR_INVALID_OUTPUT if out_name does not point to a valid \ref
+       SUStringRef object
+*/
+SU_RESULT SUModelGenerateUniqueMaterialName(
+    SUModelRef model, const char* in_name, SUStringRef* out_name);
+
+/**
+@brief Fixes any errors found in the given model.
+@since SketchUp 2018, API 6.0
+@param[in]  model  The model object.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+*/
+SU_RESULT SUModelFixErrors(SUModelRef model);
+
+/**
+@brief Updates the faces in the model so that they are oriented
+       consistently.
+@since SketchUp 2018, API 6.0
+@param[in]  model              The model object.
+@param[in]  recurse_components Orient components of the model.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+*/
+SU_RESULT SUModelOrientFacesConsistently(SUModelRef model, bool recurse_components);
+
+
+/**
+@brief Retrieves line styles from the model.
+@since SketchUp 2019, API 7.0
+@param[in]  model       The model object.
+@param[out] line_styles The line styles of the model.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if line_styles is NULL
+*/
+SU_RESULT SUModelGetLineStyles(SUModelRef model, SULineStylesRef* line_styles);
+
+/**
+@brief Loads a component from a file.
+@deprecated This method will be removed in SketchUp 2022.0. It is replaced by
+            SUModelLoadDefinitionWithStatus() which can load components
+            saved by newer versions of SketchUp.
+@since SketchUp 2019.2, API 7.1
+@param[in]  model       The model object.
+@param[in]  filename    The full path and filename to a SkethchUp model.
+@param[out] definition  The component definition that is created after load.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if \p model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if \p filename is NULL
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if \p definition is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if \p definition is already a valid object
+- \ref SU_ERROR_SERIALIZATION if loading the file failed
+*/
+SU_DEPRECATED_FUNCTION("SketchUp API 9.0")
+SU_RESULT SUModelLoadDefinition(
+    SUModelRef model, const char* filename, SUComponentDefinitionRef* definition);
+
+/**
+@brief Loads a component from a file.
+@since SketchUp 2021, API 9.0
+
+@note  As of SketchUp 2021.0, SketchUp can open .skp files created with newer versions of SketchUp.
+       However, opening newer versions with an older SDK might omit model data. Use the load
+       \p status value to check if the file was created with a newer version of SketchUp.
+
+@warning When reading a file created with a newer version of SketchUp, you may lose data
+         if you write over the same file.
+
+@param[in]  model       The model object.
+@param[in]  filename    The full path and filename to a SkethchUp model.
+@param[out] definition  The component definition that is created after load.
+@param[out] status      Returns additional information on the status of a
+                        successful operation. Valid when the return value is
+                        \ref SU_ERROR_NONE.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if \p model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if \p filename is NULL
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if \p definition is NULL
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if \p status is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if \p definition is already a valid object
+- \ref SU_ERROR_MODEL_VERSION if the component file has a newer version
+  than is supported by the current build of the SDK.
+- \ref SU_ERROR_SERIALIZATION if loading the file failed
+*/
+SU_RESULT SUModelLoadDefinitionWithStatus(
+    SUModelRef model, const char* filename, SUComponentDefinitionRef* definition,
+    enum SUModelLoadStatus* status);
+
+/**
+@brief Removes all materials provided in the array.
+@since SketchUp 2019.2, API 7.1
+@param[in]  model       The model object.
+@param[in]  len         The length of the array.
+@param[in]  materials   The materials to be deleted.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if materials is NULL
+- \ref SU_ERROR_OUT_OF_RANGE if len is zero
+- \ref SU_ERROR_PARTIAL_SUCCESS if removing the materials failed mid-process
+- \ref SU_ERROR_NO_DATA if materials provided are invalid
+*/
+SU_RESULT SUModelRemoveMaterials(SUModelRef model, size_t len, SUMaterialRef materials[]);
+
+/**
+@brief Removes selected scenes from a model.
+@since SketchUp 2019.2, API 7.1
+@param[in] model  The model object.
+@param[in] len    The number of scenes in the array for removal.
+@param[in] scenes The scenes to be deleted from the model.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_OUT_OF_RANGE if len is zero
+- \ref SU_ERROR_PARTIAL_SUCCESS if the deletion process failed mid-process or
+    if not all of scenes for deletion were found in the model
+- \ref SU_ERROR_NO_DATA if none of the requested scenes could be found for deletion
+*/
+SU_RESULT SUModelRemoveScenes(SUModelRef model, size_t len, SUSceneRef scenes[]);
+
+/**
+@brief Retrieves the number of all the materials in a model including those
+       belonging to SUImageRef and SULayerRef.
+
+@warning Materials from SUImageRef and SULayerRef should not be applied to
+         any other entity in the model. They are uniquely owned by the image
+         or layer.
+
+@since SketchUp 2019.2, API 7.1
+@param[in]  model The model object.
+@param[out] count The number of material objects available.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if count is NULL
+*/
+SU_RESULT SUModelGetNumAllMaterials(SUModelRef model, size_t* count);
+
+/**
+@brief Retrieves all the materials associated with a model object including
+       those belonging to SUImageRef and SULayerRef.
+
+@warning Materials from SUImageRef and SULayerRef should not be applied to
+         any other entity in the model. They are uniquely owned by the image
+         or layer.
+
+@since SketchUp 2019.2, API 7.1
+@param[in]  model     The model object.
+@param[in]  len       The number of material objects to retrieve.
+@param[out] materials The material objects retrieved.
+@param[out] count     The number of material objects retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if materials or count is NULL
+*/
+SU_RESULT SUModelGetAllMaterials(
+    SUModelRef model, size_t len, SUMaterialRef materials[], size_t* count);
+
+/**
+@since SketchUp 2019.2, API 7.1
+
+@brief Retrieves the guid of a model object.
+
+@see SUComponentDefinitionGetGuid
+@see SUSkpReadGuid
+
+@param[in]  model The model object.
+@param[out] guid  The guid string.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is an invalid 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 SUModelGetGuid(SUModelRef model, SUStringRef* guid);
+
+/**
+@brief Retrieves layers by their persistent ids. The layers retrieved will be in
+       the same order as to the peristent ids passed in. If a persistent id
+       doesn't belong to a layer, then a \ref SU_INVALID element will be
+       returned along with \ref SU_ERROR_PARTIAL_SUCCESS.
+@since SketchUp 2020.0, API 8.0
+@see SUModelGetEntitiesOfTypeByPersistentIDs()
+@deprecated Prefer the more flexible SUModelGetEntitiesOfTypeByPersistentIDs()
+            which lets you narrow the search scope.
+@param[in]  model       The model object.
+@param[in]  num_pids    The number of persistent ids.
+@param[in]  pids        The persistent ids.
+@param[out] layers      The retrieved layer objects.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success or if num_pids is zero
+- \ref SU_ERROR_INVALID_INPUT if model is an invalid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if pids is NULL
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if layer is NULL
+- \ref SU_ERROR_PARTIAL_SUCCESS if one or more layers could not be found
+- \ref SU_ERROR_OVERWRITE_VALID if layers contains a valid \ref SULayerRef
+ */
+SU_DEPRECATED_FUNCTION("SketchUp API 8.2")
+SU_RESULT SUModelGetLayersByPersistentIDs(
+    SUModelRef model, size_t num_pids, const int64_t pids[], SULayerRef layers[]);
+
+/**
+@brief Reports whether the given \ref SUDrawingElementRef in an
+       \ref SUInstancePathRef is visible given the model's rendering options.
+       This will take into account "DrawHiddenGeometry" and "DrawHiddenObjects"
+       to determine if the drawing element is visible in the viewport.
+@since SketchUp 2020.0, API 8.0
+@param[in]  model    The model object.
+@param[in]  path     The instance path to resolve visibility for.
+@param[out] visible  The retrieved layer objects.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is an invalid object
+- \ref SU_ERROR_INVALID_INPUT if path is an invalid object
+- \ref SU_ERROR_INVALID_ARGUMENT if the instance path is not valid in the model
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if visible is NULL
+ */
+SU_RESULT SUModelIsDrawingElementVisible(SUModelRef model, SUInstancePathRef path, bool* visible);
+
+/**
+@brief Retrieves entities by their persistent ids. The entities retrieved will
+       be in the same order as to the peristent ids passed in. If a persistent
+       id doesn't belong to a entity, then a \ref SU_INVALID element will be
+       returned along with \ref SU_ERROR_PARTIAL_SUCCESS.
+@since SketchUp 2020.0, API 8.0
+@see SUModelGetEntitiesOfTypeByPersistentIDs()
+@deprecated Prefer the more flexible SUModelGetEntitiesOfTypeByPersistentIDs()
+            which lets you narrow the search scope.
+@param[in]  model       The model object.
+@param[in]  num_pids    The number of persistent ids.
+@param[in]  pids        The persistent ids.
+@param[out] entities    The retrieved entity objects.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success or if num_pids is zero
+- \ref SU_ERROR_INVALID_INPUT if model is an invalid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if pids is NULL
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if model is NULL
+- \ref SU_ERROR_PARTIAL_SUCCESS if one or more entities could not be found
+- \ref SU_ERROR_OVERWRITE_VALID if entities contains a valid \ref SUEntityRef
+ */
+SU_DEPRECATED_FUNCTION("SketchUp API 8.2")
+SU_RESULT SUModelGetEntitiesByPersistentIDs(
+    SUModelRef model, size_t num_pids, const int64_t pids[], SUEntityRef entities[]);
+
+/**
+@brief Retrieves the selection object for a model.
+@note This method only works from within the SketchUp application.
+@since SketchUp 2020.2, API 8.2
+@param[in]  model       The model object.
+@param[out] selection   The retrieved selection object.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if model is an invalid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if selection is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if selection is already a valid object
+- \ref SU_ERROR_NO_DATA if this isn't called from within SketchUp
+ */
+SU_RESULT SUModelGetSelection(SUModelRef model, SUSelectionRef* selection);
+
+/**
+ @brief Gets the number of \ref SULayerFolderRef objects owned by the given
+        model.
+ @since SketchUp 2021.0, API 9.0
+ @param[in]  model        The model object.
+ @param[out]  count       The number of layer folder objects.
+ @related SUModelRef
+ @return
+ - \ref SU_ERROR_NONE on success
+ - \ref SU_ERROR_INVALID_INPUT if \p model is an invalid object
+ - \ref SU_ERROR_NULL_POINTER_OUTPUT if \p count is NULL
+*/
+SU_RESULT SUModelGetNumLayerFolders(SUModelRef model, size_t* count);
+
+/**
+ @brief Gets the \ref SULayerFolderRef objects that are owned by the given model.
+ @since SketchUp 2021.0, API 9.0
+ @param[in]  model           The model object.
+ @param[in]  len             The number of elements in \p layer_folders.
+ @param[out]  layer_folders  An array of layer folder objects.
+ @param[out]  count          The number of elements written into \p layer_folders.
+ @related SUModelRef
+ @return
+ - \ref SU_ERROR_NONE on success
+ - \ref SU_ERROR_INVALID_INPUT if \p model is an invalid object
+ - \ref SU_ERROR_NULL_POINTER_OUTPUT if \p layer_folders or \p count is NULL
+ */
+SU_RESULT SUModelGetLayerFolders(
+    SUModelRef model, size_t len, SULayerFolderRef* layer_folders, size_t* count);
+
+/**
+ @brief Removes empty \ref SULayerFolderRef objects from the model.
+ @since SketchUp 2021.0, API 9.0
+ @param[in]  model          The model object.
+ @param[out]  count         The number of empty layer folders removed. If NULL,
+                            count will not be retrieved.
+ @related SUModelRef
+ @return
+ - \ref SU_ERROR_NONE on success
+ - \ref SU_ERROR_INVALID_INPUT if \p model is an invalid object
+*/
+SU_RESULT SUModelPurgeEmptyLayerFolders(SUModelRef model, size_t* count);
+
+/**
+ @brief Adds a \ref SULayerFolderRef object to the model.
+ @since SketchUp 2021.0, API 9.0
+ @param[in]  model          The model object.
+ @param[in]  layer_folder   The layer folder to add.
+ @related SUModelRef
+ @return
+ - \ref SU_ERROR_NONE on success
+ - \ref SU_ERROR_INVALID_INPUT if \p model or \p layer_folder is an invalid
+   object
+ - \ref SU_ERROR_INVALID_ARGUMENT if \p layer_folder fails to be added or is
+   already part of the model.
+*/
+SU_RESULT SUModelAddLayerFolder(SUModelRef model, SULayerFolderRef layer_folder);
+
+/**
+ @brief Removes unused \ref SULayerRef objects from the model.
+ @since SketchUp 2020.2, API 8.2
+ @param[in]  model          The model object.
+ @param[out]  count         The number of layers deleted. If NULL, count
+                            will not be retrieved.
+ @related SUModelRef
+ @return
+ - \ref SU_ERROR_NONE on success
+ - \ref SU_ERROR_INVALID_INPUT if \p model is an invalid object
+*/
+SU_RESULT SUModelPurgeUnusedLayers(SUModelRef model, size_t* count);
+
+/**
+ @brief Retrieves the number of layers in a model object that have not been
+ added to any layer folder.
+ @since SketchUp 2021.0, API 9.0
+ @param[in]  model The model object.
+ @param[out] count The number of top-level layers available.
+ @related SUModelRef
+ @see SUModelGetNumLayers()
+ @return
+ - \ref SU_ERROR_NONE on success
+ - \ref SU_ERROR_INVALID_INPUT if \p model is not a valid object
+ - \ref SU_ERROR_NULL_POINTER_OUTPUT if \p count is NULL
+*/
+SU_RESULT SUModelGetNumTopLevelLayers(SUModelRef model, size_t* count);
+
+/**
+ @brief Retrieves the layers in a model that have not been added to a
+ layer folder.
+ @since SketchUp 2021.0, API 9.0
+ @param[in]  model  The model object.
+ @param[in]  len    The number of layers to retrieve.
+ @param[out] layers The layers retrieved.
+ @param[out] count  The number of layers retrieved.
+ @related SUModelRef
+ @see SUModelGetLayers()
+ @return
+ - \ref SU_ERROR_NONE on success
+ - \ref SU_ERROR_INVALID_INPUT if \p model is not a valid object
+ - \ref SU_ERROR_NULL_POINTER_OUTPUT if \p layers or \p count is NULL
+*/
+SU_RESULT SUModelGetTopLevelLayers(
+    SUModelRef model, size_t len, SULayerRef layers[], size_t* count);
+
+/**
+ @brief Removes all layer folders provided in the array. All children of the
+ deleted layer folders will be moved to the parent of the deleted folder.
+ @since SketchUp 2021.0, API 9.0
+ @param[in]  model          The model object.
+ @param[in]  len            The length of the array.
+ @param[in]  layer_folders  The layer folders to be deleted.
+ @related SUModelRef
+ @return
+ - \ref SU_ERROR_NONE on success
+ - \ref SU_ERROR_INVALID_INPUT if \p model is not a valid object.
+ - \ref SU_ERROR_NULL_POINTER_INPUT if \p layer_folders is NULL
+ - \ref SU_ERROR_OUT_OF_RANGE if \p len is less than one.
+ - \ref SU_ERROR_INVALID_ARGUMENT if the number of successfully removed items
+ in \p layer_folders is 0.
+ - \ref SU_ERROR_PARTIAL_SUCCESS if we successfully remove at least 1 of the
+ items provided in \p layer_folders but fail to remove others.
+ */
+SU_RESULT SUModelRemoveLayerFolders(SUModelRef model, size_t len, SULayerFolderRef layer_folders[]);
+
+/**
+ * @anchor SUModelGetEntitiesType
+ * @since SketchUp 2020.2, API 8.2
+ * @name Entity Type Flags
+ * @brief Flags for SUModelGetEntitiesOfTypeByPersistentIDs(). These can be
+ *        combined bitwise.
+ * @see SUModelRef
+ * @{
+ */
+/// Any entities inside the root or another definition's entities.
+#define FLAG_GET_ENTITIES_TYPE_DEFINITION_ENTITIES 0x0001
+/// SULayerRef entities.
+#define FLAG_GET_ENTITIES_TYPE_LAYERS 0x0002
+/// SULayerFolderRef entities.
+#define FLAG_GET_ENTITIES_TYPE_LAYER_FOLDERS 0x0004
+/// SUMaterialRef entities.
+#define FLAG_GET_ENTITIES_TYPE_MATERIALS 0x0008
+/// SUSceneRef entities.
+#define FLAG_GET_ENTITIES_TYPE_SCENES 0x0010
+/// SUStyleRef entities.
+#define FLAG_GET_ENTITIES_TYPE_STYLES 0x0020
+/// SUComponentDefinitionRef entities.
+#define FLAG_GET_ENTITIES_TYPE_DEFINITIONS 0x0040
+/// Search all types.
+#define FLAG_GET_ENTITIES_TYPE_ALL 0xffff
+/**@}*/
+
+/**
+ @brief Retrieves entities of a given type by their persistent ids. The
+ entities retrieved will be in the same order as to the peristent ids passed
+ in. If a persistent id doesn't belong to an entity, then a \ref SU_INVALID
+ element will be returned along with \ref SU_ERROR_PARTIAL_SUCCESS.
+ @note This method allows the user to search for specific types of entities
+ which allows us to ignore parts of the model for faster results.
+ @since SketchUp 2020.2, API 8.2
+ @param[in]  model       The model object.
+ @param[in]  type_flags  An integer made up by combining \ref SUModelGetEntitiesType
+                         "Entity Type Flag" values together with bitwise 'or'. This
+                         determines what types of entities to look for.
+ @param[in]  num_pids    The number of persistent ids.
+ @param[in]  pids        The persistent ids.
+ @param[out] entities    The retrieved entity objects.
+ @related SUModelRef
+ @return
+ - \ref SU_ERROR_NONE on success or if num_pids is zero
+ - \ref SU_ERROR_INVALID_INPUT if model is an invalid object
+ - \ref SU_ERROR_NULL_POINTER_INPUT if pids is NULL
+ - \ref SU_ERROR_NULL_POINTER_OUTPUT if entities is NULL
+ - \ref SU_ERROR_PARTIAL_SUCCESS if one or more entities could not be found
+ - \ref SU_ERROR_OVERWRITE_VALID if entities contains a valid \ref SUEntityRef
+*/
+SU_RESULT SUModelGetEntitiesOfTypeByPersistentIDs(
+    SUModelRef model, const uint32_t type_flags, const size_t num_pids, const int64_t pids[],
+    SUEntityRef entities[]);
+
+/**
+@brief Retrieves the component behavior of a SketchUp model.
+@since SketchUp 2021.1, API 9.1
+@param[in]  model    The model object.
+@param[out] behavior The behavior retrieved.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if \p behavior is invalid
+*/
+SU_RESULT SUModelGetBehavior(SUModelRef model, struct SUComponentBehavior* behavior);
+
+/**
+@brief Sets the component behavior of a SketchUp model.
+@since SketchUp 2021.1, API 9.1
+@param[in] model    The model object.
+@param[in] behavior The behavior to set.
+@related SUModelRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if \p model is invalid
+- \ref SU_ERROR_NULL_POINTER_INPUT if \p behavior is NULL
+*/
+SU_RESULT SUModelSetBehavior(SUModelRef model, const struct SUComponentBehavior* behavior);
+
+#ifdef __cplusplus
+}
+#endif
+
+#if defined(__APPLE__)
+  #pragma GCC diagnostic pop
+#endif
+
+#pragma pack(pop)
+
+#endif  // SKETCHUP_MODEL_MODEL_H_