Rename teeth property to num_teeth

TODO.md

@@ -1,6 +1,6 @@
-#TODO:
+# TODO
 
 ## refactoring
 
-- [ ] fp.gear.z -> fp.gear.num_teeth
-- [ ] fp.teeth  -> fp.gear.num_teeth
+- [X] fp.gear.z -> fp.gear.num_teeth
+- [X] fp.teeth  -> fp.gear.num_teeth

freecad/gears/basegear.py

@@ -124,6 +124,23 @@ def execute(self, fp):
         if not hasattr(fp, "positionBySupport"):
             self.make_attachable(fp)
         fp.positionBySupport()
+
+        # Backward compatibility for old files
+        if hasattr(fp, "teeth"):
+            fp.addProperty(
+                "App::PropertyInteger",
+                "num_teeth",
+                "base",
+                "number of teeth",
+            )
+            app.Console.PrintLog(
+                app.Qt.translate(
+                    "Log", "Migrating 'teeth' property to 'num_teeth' on {} part\n"
+                ).format(fp.Name)
+            )
+            fp.num_teeth = fp.teeth  # Copy old value to new property
+            fp.removeProperty("teeth")  # Remove the old property
+
         gear_shape = self.generate_gear_shape(fp)
         if hasattr(fp, "BaseFeature") and fp.BaseFeature != None:
             # we're inside a PartDesign Body, thus need to fuse with the base feature

freecad/gears/bevelgear.py

@@ -28,7 +28,6 @@
 
 
 class BevelGear(BaseGear):
-
     """parameters:
     pressure_angle:  pressureangle,   10-30°
     pitch_angle:  cone angle,      0 < pitch_angle < pi/4
@@ -39,7 +38,7 @@ def __init__(self, obj):
         self.bevel_tooth = BevelTooth()
         obj.addProperty(
             "App::PropertyInteger",
-            "teeth",
+            "num_teeth",
             "base",
             translate("BevelGear", "number of teeth"),
         )
@@ -116,7 +115,7 @@ def __init__(self, obj):
             translate("BevelGear", "The pitch diameter."),
         )
         obj.setExpression(
-            "dw", "teeth * module"
+            "dw", "num_teeth * module"
         )  # calculate via expression to ease usage for placement
         obj.setEditorMode(
             "dw", 1
@@ -136,9 +135,10 @@ def __init__(self, obj):
         obj.setEditorMode(
             "angular_backlash", 1
         )  # set read-only after setting the expression, else it won't be visible. bug?
+
         obj.gear = self.bevel_tooth
         obj.module = "1. mm"
-        obj.teeth = 15
+        obj.num_teeth = 15
         obj.pressure_angle = "20. deg"
         obj.pitch_angle = "45. deg"
         obj.height = "5. mm"
@@ -151,28 +151,30 @@ def __init__(self, obj):
         obj.Proxy = self
 
     def generate_gear_shape(self, fp):
-        fp.gear.z = fp.teeth
         fp.gear.module = fp.module.Value
         fp.gear.pressure_angle = (90 - fp.pressure_angle.Value) * np.pi / 180.0
         fp.gear.pitch_angle = fp.pitch_angle.Value * np.pi / 180
-        max_height = fp.gear.module * fp.teeth / 2 / np.tan(fp.gear.pitch_angle)
+        max_height = fp.gear.module * fp.num_teeth / 2 / np.tan(fp.gear.pitch_angle)
         if fp.height >= max_height:
             app.Console.PrintWarning(
                 "height must be smaller than {}".format(max_height)
             )
         fp.gear.backlash = fp.backlash.Value
         scale = (
-            fp.module.Value * fp.gear.z / 2 / np.tan(fp.pitch_angle.Value * np.pi / 180)
+            fp.module.Value
+            * fp.num_teeth
+            / 2
+            / np.tan(fp.pitch_angle.Value * np.pi / 180)
         )
         fp.gear.clearance = fp.clearance / scale
         fp.gear._update()
         pts = list(fp.gear.points(num=fp.numpoints))
-        rot = rotation3D(-2 * np.pi / fp.teeth)
+        rot = rotation3D(-2 * np.pi / fp.num_teeth)
         # if fp.beta.Value != 0:
         #     pts = [np.array([self.spherical_rot(j, fp.beta.Value * np.pi / 180.) for j in i]) for i in pts]
 
         rotated_pts = pts
-        for i in range(fp.gear.z - 1):
+        for i in range(fp.num_teeth - 1):
             rotated_pts = list(map(rot, rotated_pts))
             pts.append(np.array([pts[-1][-1], rotated_pts[0][0]]))
             pts += rotated_pts
@@ -211,20 +213,20 @@ def generate_gear_shape(self, fp):
             mat.move(fcvec([0, 0, scale_1]))
             shape = shape.transformGeometry(mat)
         return shape
-        # return self.create_teeth(pts, pos1, fp.teeth)
+        # return self.create_teeth(pts, pos1, fp.num_teeth)
 
     def create_tooth(self):
         w = []
         scal1 = (
             self.obj.m.Value
-            * self.obj.gear.z
+            * self.obj.num_teeth
             / 2
             / np.tan(self.obj.pitch_angle.Value * np.pi / 180)
             - self.obj.height.Value / 2
         )
         scal2 = (
             self.obj.m.Value
-            * self.obj.gear.z
+            * self.obj.num_teeth
             / 2
             / np.tan(self.obj.pitch_angle.Value * np.pi / 180)
             + self.obj.height.Value / 2

freecad/gears/crowngear.py

@@ -38,7 +38,7 @@ def __init__(self, obj):
         super(CrownGear, self).__init__(obj)
         obj.addProperty(
             "App::PropertyInteger",
-            "teeth",
+            "num_teeth",
             "base",
             translate("CrownGear", "number of teeth"),
         )
@@ -73,7 +73,7 @@ def __init__(self, obj):
             translate("CrownGear", "pressure angle"),
         )
         self.add_accuracy_properties(obj)
-        obj.teeth = 15
+        obj.num_teeth = 15
         obj.other_teeth = 15
         obj.module = "1. mm"
         obj.pressure_angle = "20. deg"
@@ -135,7 +135,7 @@ def profile(self, m, r, r0, t_c, t_i, alpha_w, y0, y1, y2):
         return pts
 
     def generate_gear_shape(self, fp):
-        inner_diameter = fp.module.Value * fp.teeth
+        inner_diameter = fp.module.Value * fp.num_teeth
         outer_diameter = inner_diameter + fp.height.Value * 2
         inner_circle = part.Wire(part.makeCircle(inner_diameter / 2.0))
         outer_circle = part.Wire(part.makeCircle(outer_diameter / 2.0))
@@ -148,7 +148,7 @@ def generate_gear_shape(self, fp):
         # cutting obj
         alpha_w = np.deg2rad(fp.pressure_angle.Value)
         m = fp.module.Value
-        t = fp.teeth
+        t = fp.num_teeth
         t_c = t
         t_i = fp.other_teeth
         rm = inner_diameter / 2

freecad/gears/cycloidgear.py

@@ -41,7 +41,7 @@ def __init__(self, obj):
         self.cycloid_tooth = CycloidTooth()
         obj.addProperty(
             "App::PropertyInteger",
-            "teeth",
+            "num_teeth",
             "base",
             translate("CycloidGear", "number of teeth"),
         )
@@ -76,11 +76,11 @@ def __init__(self, obj):
         self.add_cycloid_properties(obj)
         self.add_computed_properties(obj)
         obj.gear = self.cycloid_tooth
-        obj.teeth = 15
+        obj.num_teeth = 15
         obj.module = "1. mm"
         obj.setExpression(
-            "inner_diameter", "teeth / 2"
-        )  # teeth/2 makes the hypocycloid a straight line to the center
+            "inner_diameter", "num_teeth / 2"
+        )  # num_teeth/2 makes the hypocycloid a straight line to the center
         obj.outer_diameter = 7.5  # we don't know the mating gear, so we just set the default to mesh with our default
         obj.beta = "0. deg"
         obj.height = "5. mm"
@@ -174,7 +174,7 @@ def add_computed_properties(self, obj):
             translate("CycloidGear", "The pitch diameter."),
         )
         obj.setExpression(
-            "dw", "teeth * module"
+            "dw", "num_teeth * module"
         )  # calculate via expression to ease usage for placement
         obj.setEditorMode(
             "dw", 1
@@ -197,8 +197,7 @@ def add_computed_properties(self, obj):
 
     def generate_gear_shape(self, fp):
         fp.gear.m = fp.module.Value
-        fp.gear.z = fp.teeth
-        fp.dw = fp.module * fp.teeth
+        fp.dw = fp.module * fp.num_teeth
         fp.gear.z1 = fp.inner_diameter
         fp.gear.z2 = fp.outer_diameter
         fp.gear.clearance = fp.clearance
@@ -232,7 +231,7 @@ def generate_gear_shape(self, fp):
 
         tooth = part.Wire(edges)
 
-        profile = rotate_tooth(tooth, fp.teeth)
+        profile = rotate_tooth(tooth, fp.num_teeth)
         if fp.height.Value == 0:
             return profile
         base = part.Face(profile)

freecad/gears/cycloidgearrack.py

@@ -30,14 +30,13 @@
 
 
 class CycloidGearRack(BaseGear):
-
     """FreeCAD gear rack"""
 
     def __init__(self, obj):
         super(CycloidGearRack, self).__init__(obj)
         obj.addProperty(
             "App::PropertyInteger",
-            "teeth",
+            "num_teeth",
             "base",
             translate("CycloidGearRack", "number of teeth"),
         )
@@ -81,7 +80,7 @@ def __init__(self, obj):
         self.add_tolerance_properties(obj)
         self.add_cycloid_properties(obj)
         self.add_fillet_properties(obj)
-        obj.teeth = 15
+        obj.num_teeth = 15
         obj.module = "1. mm"
         obj.inner_diameter = 7.5
         obj.outer_diameter = 7.5
@@ -124,7 +123,7 @@ def add_computed_properties(self, obj):
             "base",
             translate(
                 "CycloidGearRack",
-                "if enabled the total length of the rack is teeth x pitch, otherwise the rack starts with a tooth-flank",
+                "if enabled the total length of the rack is num_teeth x pitch, otherwise the rack starts with a tooth-flank",
             ),
         )
 
@@ -224,7 +223,7 @@ def generate_gear_shape(self, obj):
         tooth = part.Wire(tooth_edges[1:-1] + edge)
         teeth = [tooth]
 
-        for i in range(obj.teeth - 1):
+        for i in range(obj.num_teeth - 1):
             tooth = tooth.copy()
             tooth.translate(app.Vector(0, np.pi * m, 0))
             teeth.append(tooth)
@@ -234,7 +233,7 @@ def generate_gear_shape(self, obj):
         if obj.add_endings:
             teeth = [part.Wire(tooth_edges[0])] + teeth
             last_edge = tooth_edges[-1]
-            last_edge.translate(app.Vector(0, np.pi * m * (obj.teeth - 1), 0))
+            last_edge.translate(app.Vector(0, np.pi * m * (obj.num_teeth - 1), 0))
             teeth = teeth + [part.Wire(last_edge)]
 
         p_start = np.array(teeth[0].Edges[0].firstVertex().Point[:-1])

freecad/gears/internalinvolutegear.py

@@ -52,7 +52,7 @@ def __init__(self, obj):
         )
         obj.addProperty(
             "App::PropertyInteger",
-            "teeth",
+            "num_teeth",
             "base",
             translate("InternalInvoluteGear", "number of teeth"),
         )
@@ -99,7 +99,7 @@ def __init__(self, obj):
 
         obj.gear = self.involute_tooth
         obj.simple = False
-        obj.teeth = 15
+        obj.num_teeth = 15
         obj.module = "1. mm"
         obj.shift = 0.0
         obj.pressure_angle = "20. deg"
@@ -263,7 +263,6 @@ def add_helical_properties(self, obj):
     def generate_gear_shape(self, fp):
         fp.gear.double_helix = fp.double_helix
         fp.gear.m_n = fp.module.Value
-        fp.gear.z = fp.teeth
         fp.gear.undercut = False  # no undercut for internal gears
         fp.gear.shift = fp.shift
         fp.gear.pressure_angle = fp.pressure_angle.Value * np.pi / 180.0
@@ -327,7 +326,7 @@ def generate_gear_shape(self, fp):
             edges = [e for e in edges if e is not None]
 
             tooth = part.Wire(edges)
-            profile = rotate_tooth(tooth, fp.teeth)
+            profile = rotate_tooth(tooth, fp.num_teeth)
             if fp.height.Value == 0:
                 return part.makeCompound([outer_circle, profile])
             base = part.Face([outer_circle, profile])

freecad/gears/involutegear.py

@@ -36,7 +36,6 @@
 
 
 class InvoluteGear(BaseGear):
-
     """FreeCAD gear"""
 
     def __init__(self, obj):
@@ -60,7 +59,7 @@ def __init__(self, obj):
         obj.gear = self.involute_tooth
         obj.simple = False
         obj.undercut = False
-        obj.teeth = 15
+        obj.num_teeth = 15
         obj.module = "1. mm"
         obj.shift = 0.0
         obj.pressure_angle = "20. deg"
@@ -82,7 +81,7 @@ def __init__(self, obj):
     def add_gear_properties(self, obj):
         obj.addProperty(
             "App::PropertyInteger",
-            "teeth",
+            "num_teeth",
             "base",
             translate("InvoluteGear", "number of teeth"),
         )
@@ -280,7 +279,6 @@ def compute_traverse_properties(self, obj):
     def generate_gear_shape(self, obj):
         obj.gear.double_helix = obj.double_helix
         obj.gear.m_n = obj.module.Value
-        obj.gear.z = obj.teeth
         obj.gear.undercut = obj.undercut
         obj.gear.shift = obj.shift
         obj.gear.pressure_angle = obj.pressure_angle.Value * np.pi / 180.0
@@ -337,7 +335,7 @@ def generate_gear_shape(self, obj):
             edges = [e for e in edges if e is not None]
 
             tooth = part.Wire(edges)
-            profile = rotate_tooth(tooth, obj.teeth)
+            profile = rotate_tooth(tooth, obj.num_teeth)
 
             if obj.height.Value == 0:
                 return profile