Add active_point_result class and getter function

Signed-off-by: Michael Brunner <brunner@cadwork.swiss>

Author: Brunner246

docs/documentation/active_point_result.md

@@ -0,0 +1,6 @@
+# active_point_result
+
+::: cadwork.active_point_result
+rendering:
+show_root_heading: false
+show_source: true

mkdocs.yml

@@ -64,6 +64,7 @@ nav:
           - Element Map Query: documentation/element_map_query.md
           - Hit Result: documentation/hit_result.md
           - Coordinate System Data: documentation/coordinate_system_data.md
+          - Active Point Result: documentation/active_point_result.md
       - Connector Axis Controller: documentation/connector_axis_controller.md
       - Dimension Controller: documentation/dimension_controller.md
       - Element Controller: documentation/element_controller.md

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cwapi3d"
-version = "32.402.0"
+version = "32.443.0"
 authors = [{ name = "Cadwork", email = "it@cadwork.ca" }]
 requires-python = ">= 3.12"
 description = 'Python bindings for CwAPI3D'

src/cadwork/active_point_result.py

@@ -0,0 +1,12 @@
+from dataclasses import dataclass
+from typing import Optional
+from cadwork import point_3d
+
+
+@dataclass(frozen=True)
+class active_point_result:
+    has_point: bool
+    point: Optional["point_3d"] = None
+
+    def __bool__(self) -> bool:
+        return self.has_point

src/element_controller/__init__.pyi

@@ -9,6 +9,7 @@ from cadwork.coordinate_system_data import coordinate_system_data
 from cadwork.element_map_query import element_map_query
 from cadwork.element_filter import element_filter
 from cadwork.hit_result import hit_result
+from cadwork.active_point_result import active_point_result
 from cadwork.vertex_list import vertex_list
 from cadwork.shoulder_options import shoulder_options
 from cadwork.heel_shoulder_options import heel_shoulder_options
@@ -2278,3 +2279,24 @@ def cast_ray_and_get_element_intersections(element_id_list: List[ElementId], ray
     Returns:
         Contains list of elements that were hit by the ray and list of vertices that are queried via ElementID.
     """
+
+
+def get_element_active_point(element_id: ElementId) -> active_point_result:
+    """Gets the active point associated with an element.
+
+    Parameters:
+        element_id: The element id.
+
+    Examples:
+        >>> import cadwork
+        >>> import element_controller as ec
+        >>> [element_id] = ec.get_active_identifiable_element_ids()
+        >>> result = ec.get_element_active_point(element_id)
+        >>> if result:
+        ...     ec.create_node(result.point)
+        ... else:
+        ...     print("No active point set for element.")
+
+    Returns:
+        True/False plus point data when available.
+    """