Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Feature Request] Extend PartDesign's python interface (API) #8345

Closed
2 tasks done
Jee-Bee opened this issue Feb 4, 2023 · 12 comments
Closed
2 tasks done

[Feature Request] Extend PartDesign's python interface (API) #8345

Jee-Bee opened this issue Feb 4, 2023 · 12 comments
Labels
Coding: Python Coding issue related to Python Feature FR for improvements or new features Help wanted WB Part Design Related to the Part Design Workbench

Comments

@Jee-Bee
Copy link

Jee-Bee commented Feb 4, 2023 •
edited

Is there an existing request for this?

  • I have searched the existing requests

Forums discussion

https://forum.freecad.org/viewtopic.php?t=75627

Subproject(s) affected?

PartDesign

Idea description

Currently the PartDesign Workbench is scriptable but not on a nice pythonic way.
There are only a few features directly accessible when import PD.

an example of what i have in mind(rough idea):

import PartDesign as pd

my_body = pd.add_body()
new_sketch = my_body.add_sketch(Some_plane, ...)
new_pad = my_body.add_pad(new_sketch, ..., ...)

Since it is some time ago that i checked the PD C++ code i'm not sure if my rough idea is the best way to go.
In my opinion every feature that is accessible from python is an improvement

Anything else?

Print screen of current in python available PD features

Screenshot 2023-01-29 at 13 00 23

Screenshot 2023-01-29 at 19 21 19

Code of Conduct

  • I agree to follow this project's Code of Conduct
@luzpaz luzpaz added WB Part Design Related to the Part Design Workbench Feature FR for improvements or new features Coding: Python Coding issue related to Python labels Feb 4, 2023
@luzpaz luzpaz changed the title [Feature Request] Extend PD's python interface [Feature Request] Extend PartDesign's python interface (API) Mar 15, 2023
@luzpaz
Copy link
Contributor

luzpaz commented Mar 15, 2023

@Jee-Bee can you make a list of requested python functions (that we can track in this ticket) ?

@Jee-Bee
Copy link
Author

Jee-Bee commented Mar 26, 2023 •
edited by luzpaz

I tried to create a list of features i want to acces. I don't care about the naming. I think that is not my role even if i created the FR.

  • Create body
  • Create Sketch
  • Map sketch
  • Create Datum Plane
  • Create Datum Axis (line)
  • Create Datum CS
  • Create Datum point
  • Create Shape Binder
  • Create Sub object
  • Create Clone
  • Pad
  • Revolution
  • additive Loft
  • additive Pipe
  • additive Helix
  • Pocket
  • Hole
  • Groove
  • subtractive loft
  • subtractive pipe
  • subtractive helix
  • Mirror
  • Linear Pattern
  • Polar Pattern
  • Multi Transform
  • Fillet
  • Chamfer
  • Draft
  • Thickness

I'm not sure about the primitives. I personally don't care. But i can understand that others thing different about that

@luzpaz
Copy link
Contributor

luzpaz commented Mar 26, 2023

Thanks! I added checkboxes and separated the groupings (since it the whitespace separations weren't showing up in the markdown)

@FlachyJoe
Copy link
Contributor

NB : all listed objects can be make throw DocumentObject.addObject and BodyObject.newObject so only helpers are claimed.

>>> App.ActiveDocument.addObject('PartDesign::Body', 'Body')
<body object>
>> pad = App.ActiveDocument.Body.newObject('PartDesign::Pad','Pad')
>> mirror = App.ActiveDocument.Body.newObject('PartDesign::Mirrored','Mirrored')
>> mirror.Originals = [pad]
>> #etc.

@luzpaz
Copy link
Contributor

luzpaz commented Mar 26, 2023

Maybe this is a usecase for @mnesarco's https://github.com/mnesarco/fcscript ?

@mnesarco
Copy link
Contributor

Maybe this is a usecase for @mnesarco's https://github.com/mnesarco/fcscript ?

Yes, in the demo macro available after install, there are many examples creating sketches and padding in a PD Body.

@Jee-Bee
Copy link
Author

Jee-Bee commented Mar 27, 2023

The request is not about what is already possible. Ofcourse i can record a macro and i am able to automate things...
The request is about having a dedicated (preferable )pythonic interface.
The mentioned commands work probably well when recording a macro but give no help when using with PD as imported Module.
see as example: https://forum.freecad.org/viewtopic.php?t=76312

@mnesarco
Copy link
Contributor

mnesarco commented Mar 27, 2023 •
edited

fcscript is a project of a simplified and pythonic api for FreeCAD

image

@mnesarco
Copy link
Contributor

fcscript is a project of a simplified and pythonic api for FreeCAD

@Jee-Bee
Copy link
Author

Jee-Bee commented Mar 27, 2023

Thanks! Sounds like a good idea, assuming it ends in FC main code ;)

@luzpaz
Copy link
Contributor

luzpaz commented Mar 28, 2023

@Jee-Bee it's currently available via the Addon Manager. It's super promising!

@adrianinsaval
Copy link
Member

I don't consider Part Design to be primarily intended for this kind of use, I consider this request out of scope for the Part Design project as maintaining an additional interface is quite the maintenance burden as it would need to be constantly updated and extended as Part Design evolves.

Not everything needs to be on the main repo, I would say mnesarco's addon satisfies this need. Also consider using the Part API instead when working through python.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Coding: Python Coding issue related to Python Feature FR for improvements or new features Help wanted WB Part Design Related to the Part Design Workbench
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@mnesarco @luzpaz @Jee-Bee @FlachyJoe @adrianinsaval