Support setting workplane/axis x-direction

Author: frmdstryr

declaracad/occ/impl/occ_display.py

@@ -154,7 +154,7 @@ class OccDisplayArrow(OccDisplayItem, ProxyDisplayArrow):
 
     def create_item(self):
         d = self.declaration
-        axis = coerce_axis((d.position, d.direction, 0))
+        axis = coerce_axis((d.position, d.direction, None, 0))
         ais_item = AIS_Arrow(axis.Axis(), *d.tube_size, *d.cone_size)
         self.update_color(ais_item)
         self.item = ais_item

declaracad/occ/impl/occ_shape.py

@@ -11,7 +11,7 @@
 """
 
 import os
-from typing import ClassVar, Generator, Union
+from typing import ClassVar, Generator, Optional, Union
 
 from atom.api import Bool, Instance, List, Property, Str, Typed, observe
 from OCCT.AIS import AIS_MultipleConnectedInteractive, AIS_Shape, AIS_TexturedShape
@@ -53,9 +53,12 @@
 DEFAULT_AXIS = gp_Ax3(gp_Pnt(0, 0, 0), DZ, DX)
 
 
-def coerce_axis(value: tuple[Point, Direction, float]) -> gp_Ax2:
-    pos, dir, rotation = value
-    axis = gp_Ax2(pos.proxy, dir.proxy)
+def coerce_axis(value: tuple[Point, Direction, Optional[Direction], float]) -> gp_Ax2:
+    pos, dn, dx, rotation = value
+    if dx is None:
+        axis = gp_Ax2(pos.proxy, dn.proxy)  # dx is calculated
+    else:
+        axis = gp_Ax2(pos.proxy, dn.proxy, dx.proxy)
     axis.Rotate(axis.Axis(), rotation)
     return axis
 

declaracad/occ/shape.py

@@ -404,25 +404,33 @@ def _default_position(self) -> Point:
         return Point(0, 0, 0)
 
     #: A tuple or list of the (u, v, w) normal vector of this shape. This is
-    #: coerced into a Vector setting the orentation of the shape.
+    #: coerced into a Vector setting the orientation of the shape.
     #: This is effectively the working plane.
     direction = d_(Coerced(Direction, coercer=coerce_direction))
 
     def _default_direction(self) -> Direction:
         return Direction(0, 0, 1)
 
+    #: Sets the x-direction of the shape's axis. If None (default) it is calculated using
+    #: an axis perpendicular to the normal.
+    x_direction = d_(
+        Coerced(
+            (type(None), Direction),
+            coercer=lambda v: None if v is None else coerce_direction(v),
+        )
+    )
+
     #: Rotation about the normal vector in radians
     rotation = d_(Coerced(float, coercer=coerce_rotation))
 
     def _get_axis(self):
-        return (self.position, self.direction, self.rotation)
+        return (self.position, self.direction, self.x_direction, self.rotation)
 
     def _set_axis(self, axis):
-        self.position, self.direction, self.rotation = axis
+        self.position, self.direction, self.x_direction, self.rotation = axis
 
-    #: A tuple or list of the (u, v, w) axis of this shape. This is
-    #: coerced into a Vector that defines the x, y, and z orientation of
-    #: this shape.
+    #: A tuple of (position, normal direction, x-direction (optional), rotation) defining the
+    #: axis or "workplane" where this shape located.
     axis = d_(Property(_get_axis, _set_axis))
 
     def _get_topology(self):