typo: cycloide -> cycloid

README.md

@@ -24,7 +24,7 @@ __python > 3 (for python2 use branch py2)__
 * Helical
 * Double Helical
 
-![cycloide-gear](examples/cycloide-gear.png)
+![cycloid-gear](examples/cycloid-gear.png)
 
 ### Spherical Involute Bevel-Gear
 * Spiral  

freecad/gears/commands.py

@@ -23,7 +23,7 @@ import os
 import FreeCAD
 import FreeCADGui as Gui
 from .features import ViewProviderGear, InvoluteGear, InvoluteGearRack
-from .features import CycloideGear, BevelGear, CrownGear, WormGear, TimingGear, LanternGear, HypoCycloidGear
+from .features import CycloidGear, BevelGear, CrownGear, WormGear, TimingGear, LanternGear, HypoCycloidGear
 
 
 class BaseCommand(object):
@@ -95,12 +95,12 @@ class CreateCrownGear(BaseCommand):
     ToolTip = 'Create a Crown gear'
 
 
-class CreateCycloideGear(BaseCommand):
+class CreateCycloidGear(BaseCommand):
     NAME = "cycloidgear"
-    GEAR_FUNCTION = CycloideGear
-    Pixmap = os.path.join(BaseCommand.ICONDIR, 'cycloidegear.svg')
-    MenuText = 'Cycloide gear'
-    ToolTip = 'Create a Cycloide gear'
+    GEAR_FUNCTION = CycloidGear
+    Pixmap = os.path.join(BaseCommand.ICONDIR, 'cycloidgear.svg')
+    MenuText = 'Cycloid gear'
+    ToolTip = 'Create a Cycloid gear'
 
 
 class CreateBevelGear(BaseCommand):

freecad/gears/features.py

@@ -25,7 +25,7 @@ import os
 import numpy as np
 import math
 from pygears.involute_tooth import InvoluteTooth, InvoluteRack
-from pygears.cycloide_tooth import CycloideTooth
+from pygears.cycloid_tooth import CycloidTooth
 from pygears.bevel_tooth import BevelTooth
 from pygears._functions import rotation3D, rotation, reflection, arc_from_points_and_center
 
@@ -38,9 +38,12 @@ from Part import BSplineCurve, Shape, Wire, Face, makePolygon, \
 
 
 __all__ = ["InvoluteGear",
-           "CycloideGear",
+           "CycloidGear",
            "BevelGear",
            "InvoluteGearRack",
+           "CrownGear",
+           "WormGear",
+           "HypoCycloidGear"
            "ViewProviderGear"]
 
 
@@ -402,19 +405,19 @@ class CrownGear(object):
         pass
 
 
-class CycloideGear(object):
+class CycloidGear(object):
     """FreeCAD gear"""
 
     def __init__(self, obj):
-        self.cycloide_tooth = CycloideTooth()
+        self.cycloid_tooth = CycloidTooth()
         obj.addProperty("App::PropertyInteger",
                         "teeth", "gear_parameter", "number of teeth")
         obj.addProperty(
             "App::PropertyLength", "module", "gear_parameter", "module")
         obj.addProperty(
-            "App::PropertyLength", "inner_diameter", "cycloid_parameter", "inner_diameter")
+            "App::PropertyLength", "inner_diameter", "cycloid_parameter", "inner_diameter (hypocycloid)")
         obj.addProperty(
-            "App::PropertyLength", "outer_diameter", "cycloid_parameter", "outer_diameter")
+            "App::PropertyLength", "outer_diameter", "cycloid_parameter", "outer_diameter (epicycloid)")
         obj.addProperty(
             "App::PropertyLength", "height", "gear_parameter", "height")
         obj.addProperty(
@@ -428,7 +431,7 @@ class CycloideGear(object):
             "App::PropertyLength", "backlash", "gear_parameter", "backlash in mm")
         obj.addProperty("App::PropertyPythonObject", "gear",
                         "gear_parameter", "the python object")
-        obj.gear = self.cycloide_tooth
+        obj.gear = self.cycloid_tooth
         obj.teeth = 15
         obj.module = '1. mm'
         obj.inner_diameter = '5 mm'

freecad/gears/icons/cycloidgear.svg

@@ -15,7 +15,7 @@
    id="svg3799"
    version="1.1"
    inkscape:version="0.48.4 r9939"
-   sodipodi:docname="cycloidegear.svg">
+   sodipodi:docname="cycloidgear.svg">
   <defs
      id="defs3801">
     <inkscape:path-effect

freecad/gears/icons/involutegear.svg

@@ -15,7 +15,7 @@
    id="svg3799"
    version="1.1"
    inkscape:version="0.48.4 r9939"
-   sodipodi:docname="cycloidegear.svg">
+   sodipodi:docname="cycloidgear.svg">
   <defs
      id="defs3801">
     <inkscape:path-effect

freecad/gears/init_gui.py

@@ -41,7 +41,7 @@ class GearWorkbench(Workbench):
     commands = [
         "CreateInvoluteGear",
         "CreateInvoluteRack",
-        "CreateCycloideGear",
+        "CreateCycloidGear",
         "CreateBevelGear",
         "CreateCrownGear",
         "CreateWormGear",
@@ -53,7 +53,7 @@ class GearWorkbench(Workbench):
         return "Gui::PythonWorkbench"
 
     def Initialize(self):
-        from .commands import CreateCycloideGear, CreateInvoluteGear
+        from .commands import CreateCycloidGear, CreateInvoluteGear
         from .commands import CreateBevelGear, CreateInvoluteRack, CreateCrownGear
         from .commands import CreateWormGear, CreateTimingGear, CreateLanternGear
         from .commands import CreateHypoCycloidGear
@@ -62,7 +62,7 @@ class GearWorkbench(Workbench):
         self.appendMenu("Gear", self.commands)
         # Gui.addIconPath(App.getHomePath()+"Mod/gear/icons/")
         Gui.addCommand('CreateInvoluteGear', CreateInvoluteGear())
-        Gui.addCommand('CreateCycloideGear', CreateCycloideGear())
+        Gui.addCommand('CreateCycloidGear', CreateCycloidGear())
         Gui.addCommand('CreateBevelGear', CreateBevelGear())
         Gui.addCommand('CreateInvoluteRack', CreateInvoluteRack())
         Gui.addCommand('CreateCrownGear', CreateCrownGear())

pygears/cycloid_tooth.py

@@ -24,7 +24,7 @@ from numpy import cos, sin, arccos, pi, array, linspace, transpose, vstack
 from ._functions import rotation, reflection
 
 
-class CycloideTooth():
+class CycloidTooth():
     def __init__(self, z1=5, z2=5, z=14, m=5, clearance=0.12, backlash=0.00):
         self.m = m
         self.z = z
@@ -43,22 +43,22 @@ class CycloideTooth():
         self.di = self.d - 2*self.m - self.clearance * self.m
         self.phipart = 2 * pi / self.z
 
-    def epicycloide_x(self):
+    def epicycloid_x(self):
         def func(t):
             return(((self.d2 + self.d) * cos(t))/2. - (self.d2 * cos((1 + self.d / self.d2) * t))/2.)
         return(func)
 
-    def epicycloide_y(self):
+    def epicycloid_y(self):
         def func(t):
             return(((self.d2 + self.d) * sin(t))/2. - (self.d2 * sin((1 + self.d / self.d2) * t))/2.)
         return(func)
 
-    def hypocycloide_x(self):
+    def hypocycloid_x(self):
         def func(t):
             return((self.d - self.d1)*cos(t)/2 + self.d1/2 * cos((self.d / self.d1 - 1) * t))
         return(func)
 
-    def hypocycloide_y(self):
+    def hypocycloid_y(self):
         def func(t):
             return((self.d - self.d1)*sin(t)/2 - self.d1/2 * sin((self.d/self.d1 - 1)*t))
         return(func)
@@ -79,10 +79,10 @@ class CycloideTooth():
 
     def points(self, num=10):
 
-        inner_x = self.hypocycloide_x()
-        inner_y = self.hypocycloide_y()
-        outer_x = self.epicycloide_x()
-        outer_y = self.epicycloide_y()
+        inner_x = self.hypocycloid_x()
+        inner_y = self.hypocycloid_y()
+        outer_x = self.epicycloid_x()
+        outer_y = self.epicycloid_y()
         t_inner_end = self.inner_end()
         t_outer_end = self.outer_end()
         t_vals_outer = linspace(0, t_outer_end, num)

pygears/profile.py

@@ -1,7 +1,7 @@
 import numpy as np
 from .involute_tooth import InvoluteTooth, InvoluteRack
 from .bevel_tooth import BevelTooth
-from .cycloide_tooth import CycloideTooth
+from .cycloid_tooth import CycloidTooth
 from ._functions import rotation, rotation3D
 
 
@@ -23,7 +23,7 @@ class _GearProfile(object):
 class InvoluteProfile(InvoluteTooth, _GearProfile):
     pass
 
-class CycloideProfile(CycloideTooth, _GearProfile):
+class CycloidProfile(CycloidTooth, _GearProfile):
     pass
 
 class BevelProfile(BevelTooth, _GearProfile):