scriptup 2024.0.5 → 2024.0.6

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

@@ -0,0 +1,332 @@
+// Copyright 2015 Trimble Navigation Ltd. All rights reserved.
+// This file is intended for public distribution.
+
+#ifndef LAYOUT_MODEL_LABEL_H_
+#define LAYOUT_MODEL_LABEL_H_
+
+#include <LayOutAPI/common.h>
+#include <LayOutAPI/geometry/geometry.h>
+#include <LayOutAPI/model/defs.h>
+#include <LayOutAPI/model/formattedtext.h>
+
+/**
+@struct LOLabelRef
+@brief References a label entity. A label consists of the label text (formatted
+       text entity) and the label leader (path entity). A label may be
+       connected to another entity via a \ref LOConnectionPointRef object.
+*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif  // __cplusplus
+
+/**
+@enum LOLabelLeaderLineType
+@brief Defines the different types of leader lines for a label entity.
+*/
+typedef enum {
+  LOLabelLeaderLineType_SingleSegment = 0,  ///< Single segment leader line.
+  LOLabelLeaderLineType_TwoSegment,         ///< Two segment leader line.
+  LOLabelLeaderLineType_Bezier,             ///< Curved Bezier leader line.
+  LOLabelLeaderLineType_Unknown,            ///< Custom leader line.
+  LONumLabelLeaderLineTypes
+} LOLabelLeaderLineType;
+
+/**
+@enum LOLabelTextConnectionType
+@brief Defines the different types of label text connections for a label entity.
+*/
+typedef enum {
+  LOLabelTextConnectionType_NoConnection = 0,  ///< Label text behaves disconnected.
+  LOLabelTextConnectionType_Automatic,  ///< Automatically choses one of the other types based on
+                                        ///< current label geometry.
+  LOLabelTextConnectionType_ReverseAutomatic,  ///< Automatically choose the OPPOSITE of the type
+                                               ///< indicated by
+                                               ///< LOLabelTextConnectionType_Automatic.
+  LOLabelTextConnectionType_TopLeft,           ///< Top-left corner of text.
+  LOLabelTextConnectionType_CenterLeft,        ///< Vertical center of left side of text.
+  LOLabelTextConnectionType_BottomLeft,        ///< Bottom-left corner of text.
+  LOLabelTextConnectionType_TopRight,          ///< Top-right corner of text.
+  LOLabelTextConnectionType_CenterRight,       ///< Vertical center of right side of text.
+  LOLabelTextConnectionType_BottomRight,       ///< Bottom-right corner of text.
+  LONumLabelTextConnectionTypes
+} LOLabelTextConnectionType;
+
+/**
+@brief Creates a new disconnected label object whose text is unbounded.
+@param[out] label            The label object.
+@param[in]  anchor_point     The anchor point for the label text's position.
+@param[in]  anchor_type      Defines which point of the label text is set by
+                             anchor_point.
+@param[in]  plain_text       The plain text to use for the label text.
+@param[in]  leader_line_type The type of leader line this label will have.
+@param[in]  target_point     Where the label leader should point to.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if label is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *label already refers to a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if anchor_point is NULL
+- \ref SU_ERROR_NULL_POINTER_INPUT if plain_text is NULL
+- \ref SU_ERROR_NULL_POINTER_INPUT if target_point is NULL
+- \ref SU_ERROR_OUT_OF_RANGE if anchor_type is not a valid value
+- \ref SU_ERROR_OUT_OF_RANGE if leader_line_type is not a valid value
+- \ref SU_ERROR_GENERIC if plain_text is an empty string
+*/
+LO_RESULT LOLabelCreateAtPoint(
+    LOLabelRef* label, const LOPoint2D* anchor_point, LOFormattedTextAnchorType anchor_type,
+    const char* plain_text, LOLabelLeaderLineType leader_line_type, const LOPoint2D* target_point);
+
+/**
+@brief Creates a new disconnected label object whose text is bounded.
+@param[out] label            The label object.
+@param[in]  bounds           The label text bounds.
+@param[in]  plain_text       The plain text to use as the label text.
+@param[in]  leader_line_type The type of leader line this label will have.
+@param[in]  target_point     Where the label leader should point to.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if label is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *label already refers to a valid object
+- \ref SU_ERROR_NULL_POINTER_INPUT if bounds is NULL
+- \ref SU_ERROR_NULL_POINTER_INPUT if plain_text is NULL
+- \ref SU_ERROR_NULL_POINTER_INPUT if target_point is NULL
+- \ref SU_ERROR_GENERIC if plain_text is an empty string
+- \ref SU_ERROR_OUT_OF_RANGE if bounds is zero sized
+- \ref SU_ERROR_OUT_OF_RANGE if leader_line_type is not a valid value
+*/
+LO_RESULT LOLabelCreateWithBounds(
+    LOLabelRef* label, const LOAxisAlignedRect2D* bounds, const char* plain_text,
+    LOLabelLeaderLineType leader_line_type, const LOPoint2D* target_point);
+
+/**
+@brief Adds a reference to a label object.
+@param[in] label The label object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if label does not refer to a valid object
+*/
+LO_RESULT LOLabelAddReference(LOLabelRef label);
+
+/**
+@brief Releases a label object. The object will be invalidated if
+       releasing the last reference.
+@param[in] label The label object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_NULL_POINTER_INPUT if label is NULL
+- \ref SU_ERROR_INVALID_INPUT if *label does not refer to a valid object
+*/
+LO_RESULT LOLabelRelease(LOLabelRef* label);
+
+/**
+@brief Converts from a \ref LOEntityRef to a \ref LOLabelRef.
+       This is essentially a downcast operation so the given \ref LOEntityRef
+       must be convertible to a \ref LOLabelRef.
+@param[in] entity The entity object.
+@return
+- The converted \ref LOLabelRef if the downcast operation succeeds
+- If not, the returned reference will be invalid
+*/
+LO_EXPORT LOLabelRef LOLabelFromEntity(LOEntityRef entity);
+
+/**
+@brief Converts from a \ref LOLabelRef to a \ref LOEntityRef.
+       This is essentially an upcast operation.
+@param[in] label The label object.
+@return
+- The converted \ref LOEntityRef if label is a valid object
+- If not, the returned reference will be invalid
+*/
+LO_EXPORT LOEntityRef LOLabelToEntity(LOLabelRef label);
+
+/**
+@brief Creates the entities that represent the label in its exploded form and
+       adds them to a \ref LOEntityListRef. It is NOT necessary to explicitly
+       release these entities, since \ref LOEntityListRef itself adds a
+       reference to the entities and will release them when they are removed
+       from the list or when the list is released.
+@param[in] label             The label object.
+@param[in] entity_list       The entity list object to add the new entities to.
+@param[in] page_for_autotext The page that is currently being imported, exported,
+                             or displayed. This must be a valid object if
+                             auto-text tags should be substituted with their
+                             display representations in the text that is
+                             returned. Otherwise, this object may be invalid.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if label does not refer to a valid object
+- \ref SU_ERROR_INVALID_INPUT if entity_list does not refer to a valid object
+- \ref SU_ERROR_GENERIC if page_for_autotext is a valid object and does not
+  belong to the same document as label.
+*/
+LO_RESULT LOLabelGetExplodedEntities(
+    LOLabelRef label, LOEntityListRef entity_list, LOPageRef page_for_autotext);
+
+/**
+@brief Connects the label to the given connection point. The leader line will
+       be adjusted to point at the connection point. The label must be in the
+       same document as the connection point. If both the label and the
+       connection point's entity are on non-shared layers, they must be on the
+       same page.
+@param[in] label            The label object.
+@param[in] connection_point The connection point object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if label does not refer to a valid object
+- \ref SU_ERROR_INVALID_INPUT if connection_point does not refer to a valid
+  object
+- \ref SU_ERROR_LAYER_LOCKED if label is on a locked layer
+- \ref SU_ERROR_ENTITY_LOCKED if label is locked
+- \ref SU_ERROR_GENERIC if the label was unable to connect to the connection
+  point
+*/
+LO_RESULT LOLabelConnectTo(LOLabelRef label, LOConnectionPointRef connection_point);
+
+/**
+@brief Disconnects the label from its connection point. The leader line will
+       not be adjusted by disconnecting from a connection point.
+@param[in] label The label object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if label does not refer to a valid object
+- \ref SU_ERROR_LAYER_LOCKED if label is on a locked layer
+- \ref SU_ERROR_ENTITY_LOCKED if label is locked
+*/
+LO_RESULT LOLabelDisconnect(LOLabelRef label);
+
+/**
+@brief Creates a copy of the label text's \ref LOFormattedTextRef object.
+@param[in]  label The label object.
+@param[out] text  A copy of the formatted text object representing the label
+                  text.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if label does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if text is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *text already refers to a valid object
+*/
+LO_RESULT LOLabelCreateLabelTextCopy(LOLabelRef label, LOFormattedTextRef* text);
+
+/**
+@brief Creates a copy of the label text's \ref LOFormattedTextRef object. This
+       copy will have all auto-text tags substituted with the display text. A
+       valid page object must be provided for page name/number auto-text to
+       be correctly substituted.
+@param[in]  label The label object.
+@param[in]  page  The page object.
+@param[out] text  A copy of the formatted text object representing the label
+                  display text.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if label does not refer to a valid object
+- \ref SU_ERROR_GENERIC if page and label don't belong to the same document
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if text is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *text already refers to a valid object
+*/
+LO_RESULT LOLabelCreateLabelDisplayTextCopy(
+    LOLabelRef label, LOPageRef page, LOFormattedTextRef* text);
+
+/**
+@brief Sets the text of a label from a \ref LOFormattedTextRef object. The
+       leader line will be adjusted to connect to the new label text if its
+       bounds are different.
+@param[in] label The label object.
+@param[in] text  The formatted text object representing the label text.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if label does not refer to a valid object
+- \ref SU_ERROR_LAYER_LOCKED if label is on a locked layer
+- \ref SU_ERROR_ENTITY_LOCKED if label is locked
+- \ref SU_ERROR_INVALID_INPUT if text does not refer to a valid object
+*/
+LO_RESULT LOLabelSetLabelText(LOLabelRef label, LOFormattedTextRef text);
+
+/**
+@brief Creates a copy of the label leader's \ref LOPathRef object.
+@param[in]  label The label object.
+@param[out] path  A copy of the path object representing the label leader.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if label does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if path is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *path already refers to a valid object
+*/
+LO_RESULT LOLabelCreateLeaderLineCopy(LOLabelRef label, LOPathRef* path);
+
+/**
+@brief Sets the leader line of a label from a \ref LOPathRef object. The label
+       text position will change to remain connected to the end point of the
+       leader line. The leader line type may change based on number and types
+       of points in the path.
+@param[in] label The label object.
+@param[in] path  The path object representing the label leader.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if label does not refer to a valid object
+- \ref SU_ERROR_INVALID_INPUT if path does not refer to a valid object
+- \ref SU_ERROR_GENERIC if path contains less than two points
+- \ref SU_ERROR_LAYER_LOCKED if label is on a locked layer
+- \ref SU_ERROR_ENTITY_LOCKED if label is locked
+*/
+LO_RESULT LOLabelSetLeaderLine(LOLabelRef label, LOPathRef path);
+
+/**
+@brief Gets the type of leader line the label is using. If the leader line has
+       been customized, the type may be unknown.
+@param[in]  label            The label object.
+@param[out] leader_line_type The leader line type.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if label does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if leader_line_type is NULL
+*/
+LO_RESULT LOLabelGetLeaderLineType(LOLabelRef label, LOLabelLeaderLineType* leader_line_type);
+
+/**
+@brief Sets the type of leader line the label is using. New control points will
+       be generated if changing to a two segment or bezier leader line type.
+@param[in] label            The label object.
+@param[in] leader_line_type The leader line type.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if label does not refer to a valid object
+- \ref SU_ERROR_OUT_OF_RANGE if leader_line_type is
+  LOLabelLeaderLineType_Unknown or not a valid leader line type
+- \ref SU_ERROR_LAYER_LOCKED if label is on a locked layer
+- \ref SU_ERROR_ENTITY_LOCKED if label is locked
+*/
+LO_RESULT LOLabelSetLeaderLineType(LOLabelRef label, LOLabelLeaderLineType leader_line_type);
+
+/**
+@brief Gets the type of connection between the label text and leader line.
+@param[in]  label                The label object.
+@param[out] text_connection_type The text connection type.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if label does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if text_connection_type is NULL
+*/
+LO_RESULT LOLabelGetTextConnectionType(
+    LOLabelRef label, LOLabelTextConnectionType* text_connection_type);
+
+/**
+@brief Sets the type of connection between the label text and leader line. The
+       text position will change to account for a change in text connection
+       type.
+@param[in] label                The label object.
+@param[in] text_connection_type The text connection type.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if label does not refer to a valid object
+- \ref SU_ERROR_LAYER_LOCKED if label is on a locked layer
+- \ref SU_ERROR_ENTITY_LOCKED
+- \ref SU_ERROR_OUT_OF_RANGE if text_connection_type is not a valid value
+*/
+LO_RESULT LOLabelSetTextConnectionType(
+    LOLabelRef label, LOLabelTextConnectionType text_connection_type);
+
+#ifdef __cplusplus
+}
+#endif  // __cplusplus
+
+#endif  // LAYOUT_MODEL_LABEL_H_

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

@@ -0,0 +1,207 @@
+// Copyright 2015 Trimble Navigation Ltd. All rights reserved.
+// This file is intended for public distribution.
+
+#ifndef LAYOUT_MODEL_LAYER_H_
+#define LAYOUT_MODEL_LAYER_H_
+
+#include <LayOutAPI/common.h>
+#include <LayOutAPI/model/defs.h>
+
+/**
+@struct LOLayerRef
+@brief References a layer definition. A layer definition specifies the
+       document-wide information about a layer. To access the entities on a
+       layer for a given page, use \ref LOLayerInstanceRef.
+*/
+
+/**
+@enum LOShareLayerAction
+@brief Defines the different ways to manage entities when sharing a layer.
+*/
+typedef enum {
+  LOShareLayerAction_Clear,          ///< Delete all entities on the layer
+  LOShareLayerAction_KeepOnePage,    ///< Keep the entities on the specified page
+  LOShareLayerAction_MergeAllPages,  ///< Merge the entities from all pages
+
+  LONumShareLayerActions
+} LOShareLayerAction;
+
+/**
+@enum LOUnshareLayerAction
+@brief Defines the different ways to manage entities when making a layer
+       non-shared.
+*/
+typedef enum {
+  LOUnshareLayerAction_Clear,           ///< Delete all entities on the layer
+  LOUnshareLayerAction_CopyToOnePage,   ///< Copy entities to the specified page
+  LOUnshareLayerAction_CopyToAllPages,  ///< Copy entities to all pages
+
+  LONumUnshareLayerActions
+} LOUnshareLayerAction;
+
+#ifdef __cplusplus
+extern "C" {
+#endif  // __cplusplus
+
+/**
+@brief Gets the name of a layer.
+@param[in]  layer_definition The layer definition object.
+@param[out] name             The name of the layer.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if layer_definition does not refer to a valid
+  object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if name is NULL
+- \ref SU_ERROR_INVALID_OUTPUT if name does not refer to a valid object
+*/
+LO_RESULT LOLayerGetName(LOLayerRef layer_definition, SUStringRef* name);
+
+/**
+@brief Sets the name of a layer.
+@param[in] layer_definition The layer definition object.
+@param[in] name             The new name for the layer.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if layer_definition does not refer to a valid
+  object
+- \ref SU_ERROR_NULL_POINTER_INPUT if name is NULL
+- \ref SU_ERROR_UNSUPPORTED if name is an empty string
+*/
+LO_RESULT LOLayerSetName(LOLayerRef layer_definition, const char* name);
+
+/**
+@brief Gets whether or not a layer is locked.
+@param[in]  layer_definition The layer definition object.
+@param[out] is_locked        Whether the layer is locked or not.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if layer_definition does not refer to a valid
+  object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if is_locked is NULL
+*/
+LO_RESULT LOLayerGetLocked(LOLayerRef layer_definition, bool* is_locked);
+
+/**
+@brief Sets whether or not a layer is locked. When setting a layer to locked,
+       there must be at least one other unlocked and visible layer on every
+       page. If this is not the case, then the next layer will be automatically
+       unlocked and made visible on all pages as necessary to proceed with the
+       operation.
+@param[in] layer_definition The layer definition object.
+@param[in] is_locked        Whether the layer should be locked or not.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if layer_definition does not refer to a valid
+  object
+- \ref SU_ERROR_GENERIC if the layer could not be locked because it would
+  break the rule that there must be at least one unlocked, visible layer on
+  each page
+*/
+LO_RESULT LOLayerSetLocked(LOLayerRef layer_definition, bool is_locked);
+
+/**
+@brief Gets whether or not a layer is a shared layer.
+@param[in] layer_definition The layer definition object.
+@param[in] is_shared        Whether the layer is shared or not.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if layer_definition does not refer to a valid
+  object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if is_shared is NULL
+*/
+LO_RESULT LOLayerGetShared(LOLayerRef layer_definition, bool* is_shared);
+
+/**
+@brief Shares a layer. If action is \ref LOShareLayerAction_Clear or
+       \ref LOShareLayerAction_MergeAllPages, then page may be an invalid
+       object.
+@param[in] layer_definition The layer definition object.
+@param[in] page             The the page to use when action is \ref
+                            LOShareLayerAction_KeepOnePage.
+@param[in] action           The action to apply to existing entities on the
+                            layer that is being shared.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if layer_definition does not refer to a valid
+  object
+- \ref SU_ERROR_LAYER_LOCKED if layer_definition is a locked layer
+- \ref SU_ERROR_GENERIC if page does not refer to a valid object and the
+  desired action requires a page
+- \ref SU_ERROR_GENERIC if an error occured attempting to share the layer
+- \ref SU_ERROR_OUT_OF_RANGE if action is not a valid value
+*/
+LO_RESULT LOLayerSetShared(LOLayerRef layer_definition, LOPageRef page, LOShareLayerAction action);
+
+/**
+@brief Unshares a layer. If action is \ref LOUnshareLayerAction_Clear or
+       \ref LOUnshareLayerAction_CopyToAllPages, then page may be an invalid
+       object.
+@param[in] layer_definition The layer definition object.
+@param[in] page             The the page to use when action is
+                            \ref LOUnshareLayerAction_CopyToOnePage.
+@param[in] action           The action to apply to existing entities on the
+                            layer that is being unshared.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if layer_definition does not refer to a valid
+  object
+- \ref SU_ERROR_LAYER_LOCKED if layer_definition is a locked layer
+- \ref SU_ERROR_GENERIC if page does not refer to a valid object and the
+  desired action requires a page
+- \ref SU_ERROR_GENERIC if an error occured attempting to unshare the layer
+- \ref SU_ERROR_OUT_OF_RANGE if action is not a valid value
+*/
+LO_RESULT LOLayerSetNonShared(
+    LOLayerRef layer_definition, LOPageRef page, LOUnshareLayerAction action);
+
+/**
+@brief Gets the layer instance for the given layer definition on a given page.
+       If layer_definition specifies a shared layer, page may be an invalid
+       object.
+@param[in]  layer_definition The layer definition object.
+@param[in]  page             The page object.
+@param[out] layer_instance   The layer instance object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if layer_definition does not refer to a valid
+  object
+- \ref SU_ERROR_INVALID_INPUT if page does not refer to a valid object and
+  layer_definition is not a shared layer
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if layer_instance is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *layer_instance already refers to a valid object
+- \ref SU_ERROR_GENERIC if an error occurred attempting to get the layer
+  instance
+*/
+LO_RESULT LOLayerGetLayerInstance(
+    LOLayerRef layer_definition, LOPageRef page, LOLayerInstanceRef* layer_instance);
+
+/**
+@brief Returns the index of this layer in the document.
+@param[in]  layer_definition The layer definition object.
+@param[out] index            The index of the layer in the document.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if layer_definition does not refer to a valid
+  object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if index is NULL
+*/
+LO_RESULT LOLayerGetLayerIndex(LOLayerRef layer_definition, size_t* index);
+
+/**
+@brief Returns the document that this layer belongs to.
+@since LayOut 2018, API 3.0
+@param[in]  layer_definition The layer definition object.
+@param[out] document         The document object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if layer_definition does not refer to a valid
+  object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if document is NULL
+*/
+LO_RESULT LOLayerGetDocument(LOLayerRef layer_definition, LODocumentRef* document);
+
+#ifdef __cplusplus
+}  // end extern "C"
+#endif  // __cplusplus
+
+#endif  // LAYOUT_MODEL_LAYER_H_

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

@@ -0,0 +1,117 @@
+// Copyright 2015 Trimble Navigation Ltd. All rights reserved.
+// This file is intended for public distribution.
+
+#ifndef LAYOUT_MODEL_LAYER_INSTANCE_H_
+#define LAYOUT_MODEL_LAYER_INSTANCE_H_
+
+#include <LayOutAPI/common.h>
+#include <LayOutAPI/model/defs.h>
+
+/**
+@struct LOLayerInstanceRef
+@brief References a layer instance. A layer instance provides access to the
+       entities that are drawn on a given layer, as well as the draw order of
+       those entities. Groups are not included in the list of entities
+       associated with a layer instance, since the group hierarchy has no
+       effect on entity draw order. Each page has one layer instance for each
+       layer in the document. Non-shared layer instances are unique per page,
+       while shared layer instances are shared across all pages of the
+       document.
+*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif  // __cplusplus
+
+/**
+@brief Gets the number of entities associated with a layer instance.
+@param[in]  layer_instance     The layer instance object.
+@param[out] number_of_entities The number of entities associated with the layer
+            instance.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if layer_instance does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if number_of_entities is NULL
+*/
+LO_RESULT LOLayerInstanceGetNumberOfEntities(
+    LOLayerInstanceRef layer_instance, size_t* number_of_entities);
+
+/**
+@brief Gets the entity at the given index of a layer instance's draw order.
+@param[in]  layer_instance The layer instance object.
+@param[in]  index          The index of the entity to get.
+@param[out] entity         The entity object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if layer_instance does not refer to a valid object
+- \ref SU_ERROR_OUT_OF_RANGE if index out of range
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if entity is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *entity already refers to a valid object
+*/
+LO_RESULT LOLayerInstanceGetEntityAtIndex(
+    LOLayerInstanceRef layer_instance, size_t index, LOEntityRef* entity);
+
+/**
+@brief Gets the index of the given entity on the layer instance.
+@since LayOut 2018, API 3.0
+@param[in]  layer_instance The layer instance object.
+@param[in]  entity         The entity object.
+@param[out] index          The index of the entity.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if layer_instance does not refer to a valid object
+- \ref SU_ERROR_INVALID_ARGUMENT if entity is not on layer_instance
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if index is NULL
+*/
+LO_RESULT LOLayerInstanceGetIndexOfEntity(
+    LOLayerInstanceRef layer_instance, LOEntityRef entity, size_t* index);
+
+/**
+@brief Populates a \ref LOEntityListRef with all the entities associated with a
+       layer instance, ordered by their draw order.
+@param[in]  layer_instance The layer instance object.
+@param[out] entity_list    The entity list to populate.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if layer_instance does not refer to a valid object
+- \ref SU_ERROR_INVALID_INPUT if entity_list does not refer to a valid object
+*/
+LO_RESULT LOLayerInstanceGetEntities(
+    LOLayerInstanceRef layer_instance, LOEntityListRef entity_list);
+
+/**
+@brief Moves the entity to the specified index within a layer instance's draw
+       order. The entity must already belong to the layer instance that is
+       passed in.
+@param[in] layer_instance The layer instance object.
+@param[in] entity         The entity object.
+@param[in] index          The index to move the entity to.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if layer_instance does not refer to a valid object
+- \ref SU_ERROR_INVALID_INPUT if entity does not refer to a valid object
+- \ref SU_ERROR_INVALID_INPUT if entity does not belong to the given layer
+  instance
+- \ref SU_ERROR_OUT_OF_RANGE if index is out of range
+*/
+LO_RESULT LOLayerInstanceReorderEntity(
+    LOLayerInstanceRef layer_instance, LOEntityRef entity, size_t index);
+
+/**
+@brief Gets the layer definition that a layer instance is associated with.
+@param[in]  layer_instance   The layer instance object.
+@param[out] layer_definition The layer definition object.
+@return
+- \ref SU_ERROR_NONE on success
+- \ref SU_ERROR_INVALID_INPUT if layer_instance does not refer to a valid object
+- \ref SU_ERROR_NULL_POINTER_OUTPUT if layer_definition is NULL
+- \ref SU_ERROR_OVERWRITE_VALID if *layer_definition already refers to a valid object
+*/
+LO_RESULT LOLayerInstanceGetLayerDefinition(
+    LOLayerInstanceRef layer_instance, LOLayerRef* layer_definition);
+
+#ifdef __cplusplus
+}  // end extern "C"
+#endif  // __cplusplus
+
+#endif  // LAYOUT_MODEL_LAYER_INSTANCE_H_