Merge pull request #252 from cwapi3d/feature/add-missing-types

Add rgb_color class and update type hints in various functions

Author: Brunner246

pyproject.toml

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

src/cadwork/__init__.pyi

@@ -1,3 +1,4 @@
+from cadwork.rgb_color import rgb_color
 from .attribute_display_settings import attribute_display_settings
 from .bim_team_upload_result import bim_team_upload_result
 from .bim_team_upload_result_code import bim_team_upload_result_code
@@ -112,6 +113,7 @@ hit_result = hit_result
 dimension_base_format = dimension_base_format
 dxf_layer_format_type = dxf_layer_format_type
 dxf_export_version = dxf_export_version
+rgb_color = rgb_color
 
 
 def get_auto_attribute_elements() -> List[int]:

src/cadwork/facet_list.pyi

@@ -11,7 +11,7 @@ class facet_list:
             int
         """
 
-    def at(self, index: int) -> point_3d:
+    def at(self, index: int) -> vertex_list:
         """at
 
         Parameters:

src/cadwork/point_3d.pyi

@@ -63,3 +63,99 @@ class point_3d:
             'point_3d'
         """
 
+    def __sub__(self, other: 'point_3d') -> 'point_3d':
+        """sub
+
+        Parameters:
+            other: other
+
+        Returns:
+            'point_3d'
+        """
+
+    def __truediv__(self, other: float) -> 'point_3d':
+        """truediv
+
+        Parameters:
+            other: other
+
+        Returns:
+            'point_3d'
+        """
+
+    def __iadd__(self, other: 'point_3d') -> 'point_3d':
+        """iadd
+
+        Parameters:
+            other: other
+
+        Returns:
+            'point_3d'
+        """
+
+    def __isub__(self, other: 'point_3d') -> 'point_3d':
+        """isub
+
+        Parameters:
+            other: other
+
+        Returns:
+            'point_3d'
+        """
+
+    def __imul__(self, other: float) -> 'point_3d':
+        """imul
+
+        Parameters:
+            other: other
+
+        Returns:
+            'point_3d'
+        """
+
+    def __itruediv__(self, other: float) -> 'point_3d':
+        """itruediv
+
+        Parameters:
+            other: other
+
+        Returns:
+            'point_3d'
+        """
+
+    def __neg__(self) -> 'point_3d':
+        """neg
+
+        Returns:
+            'point_3d'
+        """
+
+    def __eq__(self, other: object) -> bool:
+        """eq
+
+        Parameters:
+            other: other
+
+        Returns:
+            bool
+        """
+
+    def __ne__(self, other: object) -> bool:
+        """neg
+
+        Parameters:
+            other: other
+
+        Returns:
+            bool
+        """
+
+    def __add__(self, other: 'point_3d') -> 'point_3d':
+        """add
+
+        Parameters:
+            other: other
+
+        Returns:
+            'point_3d'
+        """

src/cadwork/rgb_color.py

@@ -0,0 +1,5 @@
+class rgb_color:
+    def __init__(self, r, g, b):
+        self.r = r
+        self.g = g
+        self.b = b

src/utility_controller/__init__.pyi

@@ -72,11 +72,12 @@ def get_language() -> str:
     """
 
 
-def print_message(message: str, column: int) -> None:
+def print_message(message: str, row: int, column: int) -> None:
     """Prints a message
 
     Parameters:
         message: message
+        row: row
         column: column
 
     Returns:

src/visualization_controller/__init__.pyi

@@ -453,7 +453,7 @@ def get_material(element_id: int) -> int:
     """
 
 
-def get_rgb_from_cadwork_color_id(color_id: None) -> 'rgb_color':
+def get_rgb_from_cadwork_color_id(color_id: int) -> 'rgb_color':
     """get rgb from cadwork color id
 
     Parameters: