/temp_toponaming_gannt_chart

MIT LicenseMIT

General pattern (make this a linear flowchart-like thing)

  1. Create the supporting functions needed by element naming and the algorithm.

    This stage does not yet change the behavior of FreeCAD.

    These are simply libraries with good unit testing to ensure they are accurate when used later.

    • IndexedName

      see indexedname.md

    • MappedName

      see mappedname.md

    • ElementMap.h

      see elementmap-h.md

    Are there any other clean libraries we could write to help with the following steps?

  2. Create the naming-of-elements algorithm.

    Create the ElementMap class.

    This stage does not yet change the behavior of FreeCAD

    Using the previous libraries, import the general algorithm that will eventually be called by ComplexGeoData.cpp to have the more advanced naming.

    Using unit tests, verify that the naming is very predictable and reliable.

    • Add the members to the ComplexGeoData.cpp class. They are not actually used yet. Nor are they set unless called by hand via Python console.

    • Basics and members added to ComplexGeoData.cpp/.h; Add visibility in Selection View of current name

    • ElementMap.cpp (importing RealThunder algo)

      see elementmap-cpp.md

    • Support user-defined element-name mapping override (add to Algo)

  3. Add the naming.

    Create a new v.22 branch first as this will cause slow downs.

    Contact all the Workbench devs to encourage them to also make changes.

    Call the algorithmm for naming, but do not use it yet.

    This stage will slow down FreeCAD and will make the naming visible on an element when selected.

    • Adjustments to Sketcher workbench

    • Adjustments to Part workbench

    • Adjustments to ComplexGeoDataPy

  4. Use it.

    Use the toponaming so that the model is more resilient to upstream object changes.

    This is the big step.

    • Adjustments to Save / Restore processes

    • Adjustments to Sketcher workbench

    • Adjustments to Part workbench

  5. Optimize.

    Selectively add optimizations to speed FreeCAD up again.

    This could include:

    • MappedName hashing

    • IndexedName int:string map cache per-project or system-wide.

    What is actually done is TBD after step 4 is finished