Call for help: document the list of available object types of the Wiki

Need help, or want to share a macro? Post here!
Forum rules
Be nice to others! Respect the FreeCAD code of conduct!
Post Reply
galou_breizh
Posts: 436
Joined: Wed Sep 15, 2010 9:38 am

Call for help: document the list of available object types of the Wiki

Post by galou_breizh »

I added the list of supported object types for Python scripting. Please add a small documentation of a link to a wiki page to all types.

I also added the list of available extensions. Please do the same for extensions.

Thanks,
Gaël
User avatar
onekk
Veteran
Posts: 6146
Joined: Sat Jan 17, 2015 7:48 am
Contact:

Re: Call for help: document the list of available object types of the Wiki

Post by onekk »

Probably it is not the right place as you have listed all FeaturePython objects type in the page where you describe generic FreeCAD objects.

From what I know the type described in the linked page is specific for FeaturePython objects i.e. those with type as below:

Code: Select all

a=FreeCAD.ActiveDocument.addObject("App::FeaturePython","Box")
Kind Regards

Carlo D.
Last edited by onekk on Thu Jun 01, 2023 3:08 pm, edited 1 time in total.
GitHub page: https://github.com/onekk/freecad-doc.
- In deep articles on FreeCAD.
- Learning how to model with scripting.
- Various other stuffs.

Blog: https://okkmkblog.wordpress.com/
galou_breizh
Posts: 436
Joined: Wed Sep 15, 2010 9:38 am

Re: Call for help: document the list of available object types of the Wiki

Post by galou_breizh »

Thanks Carlo,

I see your point, some of the objects created with `addObject()` cannot be customized (but they are still useful when writing Python scripts). Where would you put the complete list then? I'd like to keep all customizable objects on this page but I don't know which they are.
User avatar
onekk
Veteran
Posts: 6146
Joined: Sat Jan 17, 2015 7:48 am
Contact:

Re: Call for help: document the list of available object types of the Wiki

Post by onekk »

galou_breizh wrote: Tue Mar 28, 2023 6:30 pm Thanks Carlo,

I see your point, some of the objects created with `addObject()` cannot be customized (but they are still useful when writing Python scripts). Where would you put the complete list then? I'd like to keep all customizable objects on this page but I don't know which they are.
Probably seeing in Scripting Section of the wiki you will find a more taylored place.

I have not a computer now so I can't help, maybe tomorrow I will try to suggest a place, but probably some consultation with the page author should be a good move.

Regards

Carlo D.
GitHub page: https://github.com/onekk/freecad-doc.
- In deep articles on FreeCAD.
- Learning how to model with scripting.
- Various other stuffs.

Blog: https://okkmkblog.wordpress.com/
User avatar
onekk
Veteran
Posts: 6146
Joined: Sat Jan 17, 2015 7:48 am
Contact:

Re: Call for help: document the list of available object types of the Wiki

Post by onekk »

galou_breizh wrote: Tue Mar 28, 2023 6:30 pm ...
Ok probably in this wiki page:

https://wiki.freecad.org/FreeCAD_Script ... al_modules

Maybe talking to @Roy_043 that has edited the page (last edit is around 2021)

Hope it helps.

Regards

Carlo D.
GitHub page: https://github.com/onekk/freecad-doc.
- In deep articles on FreeCAD.
- Learning how to model with scripting.
- Various other stuffs.

Blog: https://okkmkblog.wordpress.com/
User avatar
Roy_043
Veteran
Posts: 8450
Joined: Thu Dec 27, 2018 12:28 pm

Re: Call for help: document the list of available object types of the Wiki

Post by Roy_043 »

@galou_breizh Before discussion the correct page, can you give some insights in your own plans regarding this documentation. If you intend to flesh this out then creating a new page may be more appropriate. Maybe start with a sandbox page then?

galou_breizh wrote: Tue Mar 28, 2023 6:30 pm I'd like to keep all customizable objects on this page but I don't know which they are.
Objects with the "Python" suffix are the scriptable objects.
galou_breizh
Posts: 436
Joined: Wed Sep 15, 2010 9:38 am

Re: Call for help: document the list of available object types of the Wiki

Post by galou_breizh »

My plan was to give an exhaustive list of types that you can use to build your scripted objects upon with an explanation of each type (I cannot give the explanation myself).

Do you really mean that you can't create a scripted object starting with a Part::Box for example? I don't have the time to test it right now. I would like then to remove all inappropriate objects from this page and add them to this one.


Gaël
User avatar
onekk
Veteran
Posts: 6146
Joined: Sat Jan 17, 2015 7:48 am
Contact:

Re: Call for help: document the list of available object types of the Wiki

Post by onekk »

galou_breizh wrote: Fri Mar 31, 2023 2:02 pm ...
You forgot to poke @Roy_043, without a mention, he probably will miss your post.

Regards

Carlo D.
GitHub page: https://github.com/onekk/freecad-doc.
- In deep articles on FreeCAD.
- Learning how to model with scripting.
- Various other stuffs.

Blog: https://okkmkblog.wordpress.com/
galou_breizh
Posts: 436
Joined: Wed Sep 15, 2010 9:38 am

Re: Call for help: document the list of available object types of the Wiki

Post by galou_breizh »

This is a friendly reminder for any volunteer willing to share her knowledge.

Thanks,
Gaël
Post Reply