[Problem] User Models break when topological entities change name (Topological Naming Issue) #8432

sliptonic · 2023-02-11T15:07:19Z

luzpaz · 2023-02-11T16:20:16Z

JFTR, original Toponaming issue was #6317 which was #922 on Mantis by Jurgen in 2012.

Edit: Ive cleaned up the bbcode and added a link to the FC wiki Toponaming page in sliptonic's OP
Edit2: further refinements to OP

JohnAD · 2023-02-22T02:08:05Z

An almost on-topic question: any recommendations for a good way to do breakpoint-style debugging the C++ code in FreeCAD. I figured I'd ask before I started diving in head-first. Up to this point I've just been analyzing code and mapping out connections.

My normal flow for cpp work is JetBrains CLion for my editor and a newish 16-core laptop running PopOS! (an Ubuntu variant). But I've got lots of tools available including Visual Studio and a 4-core Win10 laptop; and I am happy to switch if there is an advantage.

berniev · 2023-02-23T10:15:44Z

any recommendations for a good way to do breakpoint-style debugging the C++ code

I'm concerned.

As someone who has been working with C++ for less than a year I was hoping to learn something from the methodology of the paid professional. I was surprised then to find him needing help to do something as trivial as setting a breakpoint. I looked at his YouTube channel, and nothing there is C++ related, and his only C++ github repository is FreeCAD.

sliptonic · 2023-02-23T12:50:25Z

any recommendations for a good way to do breakpoint-style debugging the C++ code

I'm concerned.

You just questioned the credentials of a new contributor to the project by misquoting him. You left off the in FreeCAD part of his question. This is a person you've never met and your first comment is meant to undermine him. You should be ashamed. The Github issue discussions should have a higher standard of professional discourse and courtesy. In the future, please try to keep your comments constructive.

chennes · 2023-02-23T14:41:33Z

Just so it's recorded someplace: the trick to getting CLion to work with FreeCAD is you need to explicitly "Build All" -- for some reason it doesn't get the "ALL_BUILD" target that you would have in Visual Studio.

berniev · 2023-02-24T06:58:17Z

I too use CLion and there was no trick when I did this a couple of weeks ago. Just do debug build and away you go. Breakpoints work immediately.

JohnAD · 2023-02-27T03:32:09Z

You all have a preferred place for a Gantt chart? If not, I'll throw something into a public repo using https://www.diagrams.net/ .

I should have a crude starting point up this coming week.

(I actually have done one, but I already see holes and errors. I'm going to dive into some more code first.)

jbaehr · 2023-02-27T20:28:41Z

You all have a preferred place for a Gantt chart?

I don't know whether it fits your needs, but you can embedded Gantt charts directly in markdown files on github via mermaid, see https://github.com/mermaidjs/mermaid-gitbook/blob/master/content/gantt.md
This way you have all the benefits you love git for source code for your gantt charts as well.

As a lokal playground, https://kroki.io works great.

JohnAD · 2023-03-01T01:12:56Z

@realthunder

Does the following table and interpretation from the code look correct to you:

postfix (elementMap key)	meaning
`:H`	tag (local)
`:C`	child element
`:X`	external tag
`:I`	index
`D`	duplicate
`:T`	deprecated tag (uses decimal)
`:M`	mod
`:MG`	modgen
`:G`	gen
`:U`	upper
`:L`	lower

(above edited based on RealThunder's feedback)

And anything else is most likely an operation.

(for ref: look through code in ComplexGeoData.cpp, TopoShapeEx.cpp, and src/Mod/Part/App/TopoShapeOpCode.h)

And so, the interpretation of the simple Unnamed#Fusion.;Face6;:M2;FUS;:H1ab:8,F.Face10 (asuming Hashing turned off) would be

Unnamed = the documents name

# = doc / object separator

Fusion = object name

. = object / elementMap name separator

MappedName portion begins

; = elementMap entry prefix

Face6 = the item's historic parent element name

; = elementMap entry prefix

:M = marker of modification
2 = the object at index 2 (the third object)

; = elementMap entry prefix

FUS = modification was a fusion operation; see src/Mod/Part/App/TopoShapeOpCode.h

; = elementMap entry prefix

:H = This is a TAG
1ab = the tag's id in hex (would be '-' if it didn't have one)
:8 = marker indicating length of _previous_prefix, in decimal
, = comma separator for next parameter for ':H'
F = This is a "Face"; literally the first letter of the actual name

MappedName portion stops

. = MappedName / element's name separator

Face10 = the actual name for this element

JohnAD · 2023-03-01T01:37:31Z

@berniev

I apologize for not responding sooner. I am a generalist. While it is true that I've been using C++ since version 2.0 in the late 90s; that isn't enough. I've learned that most large systems; especially ones written in non-idiomatic languages like C++, C, and assembler, are never in a predictable pattern. Each system has a team that has learned behaviors, formatting, tools, and institutional knowledge. So, I'm happy to ask basic questions like "what is the recommended way of doing such and such". Not just because it can help (it can), but the questions usually bring in more insight.

Any more, I also like to pair program for a bit with a new client, but I'm not sure I can pull that off with an open source group :-)

As to the need to do ALL_BUILD at least once. On my machine, it seems to be a requirement as CLion is not detecting that a lot of the supporting elements have not been generated/moved/etc (such as SVG files, etc.) until it is run at least once. After that, I can simply use the 'Debug FreeCadMain` icon on the toolbar and away it goes.

realthunder · 2023-03-02T00:07:44Z

@JohnAD In my code, I call those elementMap key that you listed as postfix, which includes the elementMapPrefix(), i.e. ;.

Correction: the modgen postfix is ;:MG, because in the code, it is defined as modPostfix() + "G".

;:T is an deprecated version of the tag postfix, serving the same purpose of ;:H. dec in the code means decimal because it encodes object ID using decimal digits instead of hex. The postfix is only used in one of my old branch. It is included for backward compatibility.

Just some quick notes. I'll add more later.

Zolko-123 · 2023-03-02T12:31:49Z

Wouldn't the first step of investigating this TopoNaming issue be to trace the usage and whereabouts of the 2 functions setElementName() and getElementName() in realthunder's branch ?

https://github.com/realthunder/FreeCAD/blob/LinkDaily/src/App/ComplexGeoData.cpp#L1587
https://github.com/realthunder/FreeCAD/blob/LinkDaily/src/App/ComplexGeoData.cpp#L1456

at least that's where I would begin the journey

JohnAD · 2023-03-02T22:50:27Z

Breaking this into to planning parts. First, the general pattern:

flowchart TD
    id1([Prepare])
    id2([Implement])
    id3([Integrate])
    id4>Enable]
    id5(Optimize)
    id1 --> id2
    id2 --> id3
    id3 --> id4
    id4 --> id5
    id5 --> id5

(Prepare)
Create the supporting functions needed by element naming and the algorithm.
These are simply libraries with good unit testing to ensure they are accurate when used later.
FreeCAD behavior is unchanged for users
(Implement)
Create the naming-of-elements algorithm.
Create the ElementMap class.
Using the previous libraries, import the general algorithm that will eventually be called by ComplexGeoData.cpp to have the more advanced naming.
Add the members to the ComplexGeoData.cpp class but don't use them. Simply add support for visibility in the Selection View and support for the manual call via Python Console.
Using unit tests, verify that the naming is very predictable and reliable.
FreeCAD behavior is unchanged for users
(Integrate)
Migrate to v.22; contact other workbench maintainers.
Add the naming, but do not use it yet.
While the member values are set, they are not actually used.
This stage will slow down FreeCAD and will make the naming visible on an element when selected.
(Enable)
Use the toponaming so that the model is more resilient to upstream object changes.
Users will start seeing increased stability. Performance is still impacted
(Optimize)
Selectively add optimizations to speed FreeCAD up again.
This could include: MappedName-hashing and IndexedName-int:string-caching.
Repeat

JohnAD · 2023-03-02T23:00:22Z

Only 13 individual steps so far, but I'm sure there will be more as we discuss things. Any and all insight/feedback is great as you all have much experience with the structure of FreeCAD.

The markdown file references below are from a scratch repo: https://github.com/JohnAD/temp_toponaming_gannt_chart

Much of this is mild reorganization since the basics are already written by RealThunder. But adding test cases and slower migration will help with organizing this stuff in our collective heads.

(Prepare)
- IndexedName [Issue] TopoNaming Phase 1 (card 1 of 4) - create IndexedName class #8765
  
  see indexedname.md
- MappedName [Issue] TopoNaming Phase 1 (card 2 of 4) - create MappedName class #8766
  
  see mappedname.md
- MappedElement [Issue] TopoNaming Phase 1 (card 3 of 4) - create MappedElement class #8767
  
  see mappedelement.md The previous two items must be completed first.
- ElementMap.h [Issue] TopoNaming Phase 1 (card 4 of 4) - ElementMap Header file #8768
  
  see elementmap-h.md
Are there any other clean libraries we could write to help with the following steps?
(Implement)
- [Issue] TopoNaming Phase 2 (card 1 of 5) - transfer StringHasher #9127 1 of 5 - Transfer StringHasher
- [Issue] [WIP] TopoNaming Phase 2 (card 2 of 5) - create ElementMap.cpp (and more to ElementMap.h) #9115 2 of 5 - create ElementMap.cpp (+ more to .h)
- [Issue] [WIP] TopoNaming Phase 2 (card 3 of 5) - ComplexGeoData dressing #9116 3 of 5 - ComplexGeoData Dressing
- [Issue] [WIP] TopoNaming Phase 2 (card 4 of 5) - SketchObject dressing #9119 4 of 5 - SketchObject Dressing
- [Issue] TopoNaming Phase 2 (card 5 of 5) - View naming in Selection View in Part #9122 5 of 5 - View naming in Selection View in Part
- ElementMap.cpp (importing RealThunder algo)
  
  see elementmap-cpp.md
- Support user-defined element-name mapping override (add to Algo)
(Integrate)
- Adjustments to Sketcher workbench
- Adjustments to Part workbench
- Adjustments to ComplexGeoDataPy
(Enable)
- Adjustments to Save / Restore processes
- Adjustments to Sketcher workbench
- Adjustments to Part workbench
(Optimize)
- consider MappedName hashing
- consider IndexedName int:string map cache per-project or system-wide.

JohnAD · 2023-03-02T23:04:40Z

The steps are not in a gantt chart yet as I'm still untangling order in my head for steps 3 and 4; but I'm not far.

sliptonic · 2023-03-02T23:59:06Z

Here's the start of a Gantt chart.

Start date was arbitrarily set to 3/15 just to work on the chart.
All task dates are currently set to 10d because better estimates aren't available yet.
Task concurrency is strictly by phase now. That will likely change.
This chart will undergo heavy editing in the future.

In other words, assuming anything about 'when' by reading this chart is foolish. It's guaranteed to be wrong.

gantt
    title Toponaming Fix Plan
    dateFormat  YYYY-MM-DD

    section Prepare
    start            : milestone, m1, 2023-03-15,2min
    IndexedName      :p1, after m1, 10d
    MappedName       :p2, after m1  , 10d
    ElementMap.h     :p3, after m1  , 10d
    end            : milestone, m2, after p3,2min

    section Implement
    ComplexGeoData.cpp classes :i1, after m2, 10d
    ComplexGeoData.cpp/h selection view visibility :i2, after i1, 10d
    ElementMap.cpp   :i3, after i2  , 10d
    user-defined element naming :i4, after i3, 10d

    end           : milestone, m3, after i4, 2min

    Release V0.21: milestone, R1, after m3, 2min

    section Integrate
    Adjustments to Sketcher workbench   :ii3, after R1  , 10d
    Adjustments to Part workbench       :ii2, after R1  , 10d
    Adjustments to ComplexGeoDataPy     :ii4, after R1  , 10d
    end            : milestone, m4, after ii4 ,2min

    section Enable
    Adjustments to Save / Restore processes    :e1, after ii4  , 10d
    Adjustments to Sketcher workbench          :e3, after ii4  , 10d
    Adjustments to Part workbench              :e2, after ii4  , 10d
    end            : milestone, m5, after e3, 2min

    section Optimize
    MappedName hashing?                                             :o1, after e3  , 10d
    IndexedName? int:string map cache per-project or system-wide.   :o2, after e3  , 10d
    end            : milestone, m6, after o2, 2min

adrianinsaval · 2023-03-03T02:34:20Z

Adjustments to Part workbench

Adjustments to Sketcher workbench

Considering that sketcher is the one that will get the strongest stability and already provides a lot of functionality outside of it, and in light of many previous comments from zolko, is it possible to do sketcher first and then Part? Or is the Part side an unavoidable prerequisite for doing it in sketcher?

adrianinsaval · 2023-03-03T02:37:54Z

3. Add support for visibility in the Selection View.
This stage will slow down FreeCAD and will make the naming visible on an element when selected.

This is very nice and desired (and I think not currently provided by rt's solution), but the mapped names seem very long and not too user friendly, is this what will be displayed? Can we find something else? Like unique numbers or something.

JohnAD · 2023-03-03T13:16:26Z

Add support for visibility in the Selection View.
This stage will slow down FreeCAD and will make the naming visible on an element when selected.

This is very nice and desired (and I think not currently provided by rt's solution), but the mapped names seem very
long and not too user friendly, is this what will be displayed? Can we find something else? Like unique numbers or
something.

The long mapped names would only be seen in the Selection View window. Elsewhere only the short name is seen. And, certainly, we can even change that behavior later during the optimization phase. There is no real need for the end user to see the mapped names; it is more of a developer convenience.

Perhaps during the optimization dev phase, we could have a global flag settable in the Python Console that lets developers see the mapped name, otherwise the simpler name is shown?

JohnAD · 2023-03-03T13:17:22Z

I've made edits to the charts above based on changes made in a meeting with other devs this morning.

JohnAD · 2023-03-07T03:40:05Z

I've added the first 4 cards as Issues and edited the above chart. I'll start generating Phase 2 cards next. Those get somewhat more complicated but shouldn't be too bad.

pinpox · 2023-03-07T09:24:32Z

I'm subscribed to this issue because I stumbled across the topo naming problem a few times and am excited for upcoming fixes for it. I read through this issue, but have trouble understanding if it will be fixed by this and what the fix will actually be.

Is the problem, current state and solution documented somewhere? As a newish user of freecad it would be helpful to know how likely this will solve the problem from a users perpective and what the connection to @realthunder 's branch is. Should I be using that? Should I just wait for the next official release?

I assume I'm not the only one stumbling over this issue, maybe someone can link an issue to read up on the plans

JohnAD · 2023-08-13T18:42:58Z

JohnAD · 2023-08-13T18:44:51Z

Please make comments and suggestions. I know more about the Part workbench than the Sketcher workbench; so all Sketcher help is extra appreciated 😄 .

JohnAD · 2023-08-24T20:39:15Z

Over the course of the next 24 hours, I will be creating 32-or-so Issues named in the form of:

[Issue] TopoNaming Phase 3 (card 1 of 32) - Add History Support/Part Workbench/PropertyTopoShape

They will be linked into the opening comment/description at the top of this issue; and they will be linked to the TopoNaming project.

JohnAD · 2023-10-23T01:11:37Z

After starting up the cards, it appears that the "TopoShape and TopoShapeEx (BIG card)" mentioned in Part 2 the list above must be done before the remaining parts of Part 1. So, I'm adding moving that card after card 1 and before card 2. Essentially:

card 1.4: Write unit tests covering Toposhape current behavior.
card 1.5: Add the 60+ new methods and private "wrapper" class to TopoShape. (See TopoShape Ex.)

AlexDaniel · 2023-12-12T06:39:23Z

Any updates? Phase 3 was planned some time ago, but the work wasn't started.

chennes · 2023-12-12T13:49:37Z

We are working on the TopoShape class -- it is massive (94 added methods in 10,000 lines of code). Right now we are waiting for some additional documentation about a caching mechanism from @realthunder.

Timothy-Ecc19 · 2023-12-12T17:12:38Z

Great to hear this is still being worked on!

furgo16 · 2024-02-19T13:22:34Z

Many thanks for the work everyone is doing towards solving this issue. For those of us who are following the progress, would it be possible for a maintainer to add the "Phase 3" issue list (in #8432 (comment) or by the list of issue references to the main issue description?

This is just a suggestion to make it easier to potential contributors to see what's being done and one left from a SSoT (Single Source of Truth) position without having to navigate through all the comments.

If it helps, here's the markdown to copy and paste the current list of issues

#### Phase 3

1. https://github.com/FreeCAD/FreeCAD/issues/10353
1. https://github.com/FreeCAD/FreeCAD/issues/10354
1. https://github.com/FreeCAD/FreeCAD/issues/10355
1. https://github.com/FreeCAD/FreeCAD/issues/10356
1. https://github.com/FreeCAD/FreeCAD/issues/10357
1. https://github.com/FreeCAD/FreeCAD/issues/10358
1. https://github.com/FreeCAD/FreeCAD/issues/10359
1. https://github.com/FreeCAD/FreeCAD/issues/10360
1. https://github.com/FreeCAD/FreeCAD/issues/10361
1. https://github.com/FreeCAD/FreeCAD/issues/10362
1. https://github.com/FreeCAD/FreeCAD/issues/10398
1. https://github.com/FreeCAD/FreeCAD/issues/10399
1. https://github.com/FreeCAD/FreeCAD/issues/10400
1. https://github.com/FreeCAD/FreeCAD/issues/10401
1. https://github.com/FreeCAD/FreeCAD/issues/10402

Thanks!

Pesc0 · 2024-02-19T16:48:34Z

this should be what you're looking for https://github.com/orgs/FreeCAD/projects/2, let me know if that helps

furgo16 · 2024-02-19T19:08:59Z

this should be what you're looking for https://github.com/orgs/FreeCAD/projects/2, let me know if that helps

I'm aware of the GitHub project, which is also mentioned in the issue description. But thanks for pointing it out in any case!

AlexDaniel · 2024-04-13T18:15:54Z

Wow, it looks like there has been a lot of progress lately! Keep it up! ❤️

sliptonic added Core Issue or PR touches core sections (App, Gui, Base) of FreeCAD Known issue Toponaming labels Feb 11, 2023

chennes changed the title ~~[Problem] User Models break when topological entities change name (Topologocial Naming Issue)~~ [Problem] User Models break when topological entities change name (Topological Naming Issue) Feb 11, 2023

This was referenced Oct 23, 2023

TopoNaming Phase 3 (card 1.4 of 35+) Write unit tests covering Toposhape current behavior #11148

Open

TopoNaming Phase 3 (card 1.5 of 35+) Add new methods and private "wrapper" class to TopoShape #11149

Open

luzpaz mentioned this issue Nov 13, 2023

When editing a sketch, it scrambles other sketches that use it as external geometry #11369

Closed

2 tasks

nm17 mentioned this issue Jan 27, 2024

[Problem] Topological Naming Problem Ondsel-Development/FreeCAD#16

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Problem] User Models break when topological entities change name (Topological Naming Issue) #8432

[Problem] User Models break when topological entities change name (Topological Naming Issue) #8432

sliptonic commented Feb 11, 2023 •

edited by luzpaz

luzpaz commented Feb 11, 2023 •

edited

JohnAD commented Feb 22, 2023

berniev commented Feb 23, 2023

sliptonic commented Feb 23, 2023

chennes commented Feb 23, 2023

berniev commented Feb 24, 2023

JohnAD commented Feb 27, 2023 •

edited

jbaehr commented Feb 27, 2023

JohnAD commented Mar 1, 2023 •

edited

JohnAD commented Mar 1, 2023 •

edited

realthunder commented Mar 2, 2023

Zolko-123 commented Mar 2, 2023

JohnAD commented Mar 2, 2023 •

edited

JohnAD commented Mar 2, 2023 •

edited

JohnAD commented Mar 2, 2023

sliptonic commented Mar 2, 2023 •

edited

adrianinsaval commented Mar 3, 2023 •

edited

adrianinsaval commented Mar 3, 2023

JohnAD commented Mar 3, 2023

JohnAD commented Mar 3, 2023

JohnAD commented Mar 7, 2023

pinpox commented Mar 7, 2023

JohnAD commented Aug 13, 2023 •

edited by chennes

JohnAD commented Aug 13, 2023

JohnAD commented Aug 24, 2023

JohnAD commented Oct 23, 2023 •

edited

AlexDaniel commented Dec 12, 2023

chennes commented Dec 12, 2023

Timothy-Ecc19 commented Dec 12, 2023

furgo16 commented Feb 19, 2024 •

edited

Pesc0 commented Feb 19, 2024

furgo16 commented Feb 19, 2024

AlexDaniel commented Apr 13, 2024

[Problem] User Models break when topological entities change name (Topological Naming Issue) #8432

[Problem] User Models break when topological entities change name (Topological Naming Issue) #8432

Comments

sliptonic commented Feb 11, 2023 • edited by luzpaz

Problem description

Anything else?

Related Issues

Implementation Plan

Phase 1

Phase 2

Other Communication Channels

Code of Conduct

luzpaz commented Feb 11, 2023 • edited

JohnAD commented Feb 22, 2023

berniev commented Feb 23, 2023

sliptonic commented Feb 23, 2023

chennes commented Feb 23, 2023

berniev commented Feb 24, 2023

JohnAD commented Feb 27, 2023 • edited

jbaehr commented Feb 27, 2023

JohnAD commented Mar 1, 2023 • edited

JohnAD commented Mar 1, 2023 • edited

realthunder commented Mar 2, 2023

Zolko-123 commented Mar 2, 2023

JohnAD commented Mar 2, 2023 • edited

JohnAD commented Mar 2, 2023 • edited

JohnAD commented Mar 2, 2023

sliptonic commented Mar 2, 2023 • edited

adrianinsaval commented Mar 3, 2023 • edited

adrianinsaval commented Mar 3, 2023

JohnAD commented Mar 3, 2023

JohnAD commented Mar 3, 2023

JohnAD commented Mar 7, 2023

pinpox commented Mar 7, 2023

JohnAD commented Aug 13, 2023 • edited by chennes

Phase 3: Integrate

Phase 3

JohnAD commented Aug 13, 2023

JohnAD commented Aug 24, 2023

JohnAD commented Oct 23, 2023 • edited

AlexDaniel commented Dec 12, 2023

chennes commented Dec 12, 2023

Timothy-Ecc19 commented Dec 12, 2023

furgo16 commented Feb 19, 2024 • edited

Pesc0 commented Feb 19, 2024

furgo16 commented Feb 19, 2024

AlexDaniel commented Apr 13, 2024

sliptonic commented Feb 11, 2023 •

edited by luzpaz

luzpaz commented Feb 11, 2023 •

edited

JohnAD commented Feb 27, 2023 •

edited

JohnAD commented Mar 1, 2023 •

edited

JohnAD commented Mar 1, 2023 •

edited

JohnAD commented Mar 2, 2023 •

edited

JohnAD commented Mar 2, 2023 •

edited

sliptonic commented Mar 2, 2023 •

edited

adrianinsaval commented Mar 3, 2023 •

edited

JohnAD commented Aug 13, 2023 •

edited by chennes

JohnAD commented Oct 23, 2023 •

edited

furgo16 commented Feb 19, 2024 •

edited