scriptup 0.0.0

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

@@ -0,0 +1,266 @@
+// Copyright 2016 Trimble Inc. All Rights Reserved.
+
+/**
+ * @file
+ * @brief Interfaces for SUInstancePathRef.
+ */
+#ifndef SKETCHUP_MODEL_INSTANCEPATH_H_
+#define SKETCHUP_MODEL_INSTANCEPATH_H_
+
+#include <SketchUpAPI/common.h>
+#include <SketchUpAPI/transformation.h>
+#include <SketchUpAPI/unicodestring.h>
+#include <SketchUpAPI/model/defs.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+@struct SUInstancePathRef
+@brief  An instance path type that provides a wrapping of a data structure
+        of component instances.
+*/
+
+/**
+@brief Creates an instance path object.
+@param[out] instance_path The instance path object created.
+@related SUInstancePathRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if instance_path is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *instance_path refers to a valid object
+*/
+SU_RESULT SUInstancePathCreate(SUInstancePathRef* instance_path);
+
+/**
+@brief Creates a copy of an instance path object.
+@param[out] instance_path The copy of instance path object.
+@param[in]  source_path   The instance path to be copied.
+@related SUInstancePathRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if instance_path is NULL
+- \ref SU_ERROR_INVALID_INPUT if source_path is not a valid object
+- \ref SU_ERROR_OVERWRITE_VALID if *instance_path refers to a valid object
+*/
+SU_RESULT SUInstancePathCreateCopy(SUInstancePathRef* instance_path, SUInstancePathRef source_path);
+
+/**
+@brief Releases an instance path object.
+@param[in] instance_path The instance path being released.
+@related SUInstancePathRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if instance_path is NULL
+*/
+SU_RESULT SUInstancePathRelease(SUInstancePathRef* instance_path);
+
+/**
+@brief Pushes a \ref SUComponentInstanceRef to an \ref SUInstancePathRef.
+@param[in] instance_path      The instance path object.
+@param[in] component_instance The component instance object.
+@related SUInstancePathRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if instance_path or component_instance is not a
+  valid object
+*/
+SU_RESULT SUInstancePathPushInstance(
+    SUInstancePathRef instance_path, SUComponentInstanceRef component_instance);
+
+/**
+@brief Pops the last \ref SUComponentInstanceRef from an \ref SUInstancePathRef.
+@param[in] instance_path The instance path object.
+@related SUInstancePathRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if instance_path is NULL
+*/
+SU_RESULT SUInstancePathPopInstance(SUInstancePathRef instance_path);
+
+/**
+@brief Sets a \ref SUEntityRef to an \ref SUInstancePathRef.
+@param[in] instance_path The instance path object.
+@note Since SketchUp 2023.1, API version 11.1 you can unset the leaf entity by passing an SU_INVALID
+        entity ref.
+@param[in] entity        The entity to be set as a leaf in instance path or SU_INVALID if the
+        leaf should be removed.
+@related SUInstancePathRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if instance_path is NULL
+*/
+SU_RESULT SUInstancePathSetLeaf(SUInstancePathRef instance_path, SUEntityRef entity);
+
+/**
+@brief Gets a path depth for \ref SUInstancePathRef.
+       It only counts the component instances in the path, so the leaf node is
+       not counted.
+@param[in]  instance_path The instance path object.
+@param[out] depth         The depth of instance path object.
+@related SUInstancePathRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if instance_path is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if depth is NULL
+*/
+SU_RESULT SUInstancePathGetPathDepth(SUInstancePathRef instance_path, size_t* depth);
+
+/**
+@brief Gets the full path depth (including the leaf) for \ref SUInstancePathRef.
+@param[in]  instance_path The instance path object.
+@param[out] full_depth    The depth of instance path object including the leaf
+                          (if it exists).
+@related SUInstancePathRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if instance_path is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if full_depth is NULL
+*/
+SU_RESULT SUInstancePathGetFullDepth(SUInstancePathRef instance_path, size_t* full_depth);
+
+/**
+@brief Gets the transform for \ref SUInstancePathRef.
+@param[in]  instance_path The instance path object.
+@param[out] transform     The transform from instance path.
+@related SUInstancePathRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if instance_path is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if transform is NULL
+*/
+SU_RESULT SUInstancePathGetTransform(
+    SUInstancePathRef instance_path, struct SUTransformation* transform);
+
+/**
+@brief Gets the transform up to depth level for \ref SUInstancePathRef.
+@param[in]  instance_path The instance path object.
+@param[in]  depth         The depth for getting transforms up to.
+@param[out] transform     The transform from instance path.
+@related SUInstancePathRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if instance_path is not a valid object
+- \ref SU_ERROR_OUT_OF_RANGE if depth exceeds the depth of instance_path
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if transform is NULL
+*/
+SU_RESULT SUInstancePathGetTransformAtDepth(
+    SUInstancePathRef instance_path, size_t depth, struct SUTransformation* transform);
+
+/**
+@brief Gets a component instance up to path depth level.
+@param[in]  instance_path The instance path object.
+@param[in]  depth         The depth for getting drawing element up to.
+@param[out] instance      The component instance from instance path.
+@related SUInstancePathRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if instance_path is not a valid object
+- \ref SU_ERROR_OUT_OF_RANGE if depth exceeds the depth of instance_path
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if instance is NULL
+*/
+SU_RESULT SUInstancePathGetInstanceAtDepth(
+    SUInstancePathRef instance_path, size_t depth, SUComponentInstanceRef* instance);
+
+/**
+@brief Gets a leaf from an instance path as an entity object.
+@param[in]  instance_path The instance path object.
+@param[out] entity        The leaf from an instance path.
+@related SUInstancePathRef
+@return
+- The leaf from instance path on success
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if instance_path is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if entity is NULL
+*/
+SU_RESULT SUInstancePathGetLeafAsEntity(SUInstancePathRef instance_path, SUEntityRef* entity);
+
+/**
+@brief Gets a leaf from an entity path as a drawing element object.
+@param[in]  instance_path   The instance path object.
+@param[out] drawing_element The leaf from an instance path.
+@related SUInstancePathRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if instance_path is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if entity is NULL
+*/
+SU_RESULT SUInstancePathGetLeaf(
+    SUInstancePathRef instance_path, SUDrawingElementRef* drawing_element);
+
+/**
+@brief Validates an instance path.
+@param[in]  instance_path The instance path object.
+@param[out] valid         Whether the instance path is valid or not.
+@related SUInstancePathRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if instance_path is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if valid is NULL
+*/
+SU_RESULT SUInstancePathIsValid(SUInstancePathRef instance_path, bool* valid);
+
+/**
+@brief Checks if an instance path is empty.
+@param[in]  instance_path The instance path object.
+@param[out] empty         Whether the instance path is empty or not.
+@related SUInstancePathRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if instance_path_ref is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if empty is NULL
+*/
+SU_RESULT SUInstancePathIsEmpty(SUInstancePathRef instance_path, bool* empty);
+
+/**
+@brief Checks if instance path contains a particular entity.
+@param[in]  instance_path The instance path object.
+@param[in]  entity        The entity object.
+@param[out] contains      Whether the instance path contains the entity or not.
+@related SUInstancePathRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if instance_path_ref
+                              or entity_ref is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if contains is NULL
+*/
+SU_RESULT SUInstancePathContains(
+    SUInstancePathRef instance_path, SUEntityRef entity, bool* contains);
+/**
+@brief Retrieves the full persistent id for a given instance path.
+@param[in]  instance_path  The instance path.
+@param[out] pid            The persistent id.
+@related SUInstancePathRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_UNSUPPORTED if persistent id functionality is unsupported
+- \ref SU_ERROR_INVALID_INPUT if instance_path is not a valid object
+- \ref SU_ERROR_INVALID_OUTPUT if pid is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if pid is NULL
+*/
+SU_RESULT SUInstancePathGetPersistentID(SUInstancePathRef instance_path, SUStringRef* pid);
+
+/**
+@brief Retrieves the persistent id of an entity up to depth level in a given
+       instance path.
+@param[in]  instance_path  The instance path.
+@param[in]  depth          The depth for getting persistent id up to.
+@param[out] pid            The persistent id.
+@related SUInstancePathRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_UNSUPPORTED if persistent id functionality is unsupported
+- \ref SU_ERROR_INVALID_INPUT if instance_path is not a valid object
+- \ref SU_ERROR_OUT_OF_RANGE if depth exceeds the depth of instance_path
+- \ref SU_ERROR_INVALID_OUTPUT if pid is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if pid is NULL
+*/
+SU_RESULT SUInstancePathGetPersistentIDAtDepth(
+    SUInstancePathRef instance_path, size_t depth, SUStringRef* pid);
+
+#ifdef __cplusplus
+}  // extern "C"
+#endif
+
+#endif  // SKETCHUP_MODEL_INSTANCEPATH_H_

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

@@ -0,0 +1,265 @@
+// Copyright 2013-2019 Trimble, Inc. All Rights Reserved.
+
+/**
+ * @file
+ * @brief Interfaces for SULayerRef.
+ */
+#ifndef SKETCHUP_MODEL_LAYER_H_
+#define SKETCHUP_MODEL_LAYER_H_
+
+#include <SketchUpAPI/common.h>
+#include <SketchUpAPI/unicodestring.h>
+#include <SketchUpAPI/model/defs.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+@struct SULayerRef
+@extends SUEntityRef
+@brief References a Tag object.
+@note 'Layer' is a legacy term that is being used for consistency within the API.
+*/
+
+/**
+ @enum SULayerVisibilityDefaultType
+ @brief Indicates whether to set the layer visible by default. Used for
+ \ref SULayerGetSceneBehavior() and \ref SULayerSetSceneBehavior().
+ */
+enum SULayerVisibilityDefaultType {
+  SULayerVisibilityDefaultType_Visible = 0x0000,
+  SULayerVisibilityDefaultType_Hidden = 0x0001
+};
+
+/**
+ @enum SULayerVisibilityNewSceneType
+ @brief Indicates whether to set the layer visible on new scenes. Used for
+ \ref SULayerGetSceneBehavior() and \ref SULayerSetSceneBehavior().
+ */
+enum SULayerVisibilityNewSceneType {
+  SULayerVisibilityNewSceneType_LayerDefault = 0x0000,
+  SULayerVisibilityNewSceneType_Visible = 0x0010,
+  SULayerVisibilityNewSceneType_Hidden = 0x0020
+};
+
+/**
+@brief Converts from an \ref SULayerRef to an \ref SUEntityRef.
+       This is essentially an upcast operation.
+@param[in] layer  The given layer reference.
+@related SULayerRef
+@return
+- The converted \ref SUEntityRef if layer is a valid layer
+- If not, the returned reference will be invalid
+*/
+SU_EXPORT SUEntityRef SULayerToEntity(SULayerRef layer);
+
+/**
+@brief Converts from an \ref SUEntityRef to an \ref SULayerRef.
+       This is essentially a downcast operation so the given
+       SUEntityRef must be convertible to an \ref SULayerRef.
+@param[in] entity The given entity reference.
+@related SULayerRef
+@return
+- The converted \ref SULayerRef if the downcast operation succeeds
+- If not, the returned reference will be invalid
+*/
+SU_EXPORT SULayerRef SULayerFromEntity(SUEntityRef entity);
+
+/**
+@brief Creates a new layer object.
+
+Layers associated with a SketchUp model must not be explicitly deallocated.
+Layers that are not associated with a SketchUp model must be deallocated with
+\ref SULayerRelease().
+@param[out] layer The layer object created.
+@related SULayerRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if layer is NULL
+*/
+SU_RESULT SULayerCreate(SULayerRef* layer);
+
+/**
+@brief Deallocates a layer object.
+
+The layer object to be deallocated must not be associated with a SketchUp model.
+@param[in] layer The layer object.
+@related SULayerRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if layer points to an invalid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if layer is NULL
+*/
+SU_RESULT SULayerRelease(SULayerRef* layer);
+
+/**
+@brief Retrieves the name of a layer object.
+@param[in]  layer The layer object.
+@param[out] name  The name retrieved.
+@related SULayerRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if layer is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if name is NULL
+- \ref SU_ERROR_INVALID_OUTPUT if name does not point to a valid \ref
+  SUStringRef object
+*/
+SU_RESULT SULayerGetName(SULayerRef layer, SUStringRef* name);
+
+/**
+@brief Retrieves the display name of a layer object.
+@since SketchUp 2020.0, API version 8.0
+
+The display name is the name you see in the product.  In SketchUp 2020 the
+display name for the default layer changed from "Layer0" to "Untagged".
+For all other layers the name and display name are identical.
+
+@param[in]  layer The layer object.
+@param[out] name  The display name retrieved.
+@related SULayerRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if layer is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if name is NULL
+- \ref SU_ERROR_INVALID_OUTPUT if name does not point to a valid \ref
+  SUStringRef object
+*/
+SU_RESULT SULayerGetDisplayName(SULayerRef layer, SUStringRef* name);
+
+/**
+@brief Assigns the name of a layer object.
+@param[in] layer The layer object.
+@param[in] name  The new name of the layer object. Assumed to be UTF-8 encoded.
+@related SULayerRef
+@return
+- \ref SU_ERROR_NONE if layer is not a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if name is NULL
+*/
+SU_RESULT SULayerSetName(SULayerRef layer, const char* name);
+
+/**
+@brief Retrieves the material object associated with a layer object.
+
+The retrieved material object must not be deallocated by the caller since it is
+owned by the layer object.
+@param[in]  layer    The layer object.
+@param[out] material The material object retrieved.
+@related SULayerRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if layer is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if material is NULL
+*/
+SU_RESULT SULayerGetMaterial(SULayerRef layer, SUMaterialRef* material);
+
+/**
+@brief Retrieves the boolean flag indicating whether a layer object is visible.
+@param[in]  layer   The layer object.
+@param[out] visible The visibility flag retrieved.
+@related SULayerRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if layer is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if visibility is NULL
+*/
+SU_RESULT SULayerGetVisibility(SULayerRef layer, bool* visible);
+
+/**
+@brief Sets the boolean flag indicating whether a layer object is visible.
+@param[in] layer   The layer object.
+@param[in] visible The visibility flag to set.
+@related SULayerRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if layer is not a valid object.
+*/
+SU_RESULT SULayerSetVisibility(SULayerRef layer, bool visible);
+
+/**
+@brief Get the line style of a layer.
+@since SketchUp 2019, API 7.0
+@param[in]  layer      The layer object.
+@param[out] line_style The line style reference.
+@related SULayerRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if layer is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if line_style is NULL
+- \ref SU_ERROR_NO_DATA if the layer has no custom line style.
+*/
+SU_RESULT SULayerGetLineStyle(SULayerRef layer, SULineStyleRef* line_style);
+
+/**
+@brief Set the line style of a layer.
+@since SketchUp 2019, API 7.0
+@param[in] layer      The layer object.
+@param[in] line_style The line style to set.
+@related SULayerRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if layer or line_style is not a valid object.
+*/
+SU_RESULT SULayerSetLineStyle(SULayerRef layer, SULineStyleRef line_style);
+
+/**
+@brief Clear the line style of a layer.
+@since SketchUp 2019, API 7.0
+@param[in] layer The layer object.
+@related SULayerRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if layer is not a valid object.
+ */
+SU_RESULT SULayerClearLineStyle(SULayerRef layer);
+
+/**
+@brief Get the scene behavior on the layer.
+@since SketchUp 2020.0, API 8.0
+@param[in]    layer          The layer object.
+@param[out]   default_type   The retrieved default scene behavior.
+@param[out]   new_scene_type The retrieved behavior for new scenes.
+@related SULayerRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if the layer is not a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if default_type or new_scene_type is NULL
+*/
+SU_RESULT SULayerGetSceneBehavior(
+    SULayerRef layer, enum SULayerVisibilityDefaultType* default_type,
+    enum SULayerVisibilityNewSceneType* new_scene_type);
+
+/**
+@brief Set the scene behavior on the layer.
+@since SketchUp 2020.0, API 8.0
+@param[in]  layer           The layer object.
+@param[in]  default_type    The default scene behavior.
+@param[in]  new_scene_type  The behavior to set for new scenes.
+@related SULayerRef
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if the layer is not a valid object
+*/
+SU_RESULT SULayerSetSceneBehavior(
+    SULayerRef layer, enum SULayerVisibilityDefaultType default_type,
+    enum SULayerVisibilityNewSceneType new_scene_type);
+
+/**
+ @brief Gets the \ref SULayerFolderRef object that contains the given layer.
+ @since SketchUp 2020.2, API 8.2
+ @param[in]  layer            The layer object.
+ @param[out]  layer_folder    The retrieved layer folder object.
+ @related SULayerRef
+ @return
+ - \ref SU_ERROR_NONE on success
+ - \ref SU_ERROR_INVALID_INPUT if \p layer is not a valid object
+ - \ref SU_ERROR_NULL_POINTER_OUTPUT if \p layer_folder is NULL
+ - \ref SU_ERROR_NO_DATA if \p layer is not contained within a layer folder
+*/
+SU_RESULT SULayerGetParentLayerFolder(SULayerRef layer, SULayerFolderRef* layer_folder);
+
+#ifdef __cplusplus
+}  // extern "C"
+#endif
+
+#endif  // SKETCHUP_MODEL_LAYER_H_