Headless FreeCAD: Difference between revisions
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
<languages/> |
|||
<translate> |
|||
== Introduction == |
== Introduction == |
||
Line 10: | Line 13: | ||
However, what's possible is to create a [[Scenegraph|scenegraph]] representation of an object. This works this way: |
However, what's possible is to create a [[Scenegraph|scenegraph]] representation of an object. This works this way: |
||
</translate> |
|||
{{Code|lang=python|code= |
{{Code|lang=python|code= |
||
import FreeCADGui as Gui |
import FreeCADGui as Gui |
||
Line 20: | Line 24: | ||
view = Gui.subgraphFromObject(obj) |
view = Gui.subgraphFromObject(obj) |
||
}} |
}} |
||
<translate> |
|||
:<small>reference: [https://forum.freecadweb.org/viewtopic.php?f=10&t=55794&p=481586#p481586 forum thread]</small> |
:<small>reference: [https://forum.freecadweb.org/viewtopic.php?f=10&t=55794&p=481586#p481586 forum thread]</small> |
||
Line 58: | Line 64: | ||
== Related == |
== Related == |
||
* [[Embedding FreeCAD#Using FreeCAD without GUI]] |
* [[Embedding_FreeCAD#Using_FreeCAD_without_GUI|Embedding FreeCAD#Using FreeCAD without GUI]] |
||
* [[Start_up_and_Configuration#Running_FreeCAD_without_GUI_.28headless.29|Start up and Configuration#Running FreeCAD without GUI .28headless.29]] |
* [[Start_up_and_Configuration#Running_FreeCAD_without_GUI_.28headless.29|Start up and Configuration#Running FreeCAD without GUI .28headless.29]] |
||
</translate> |
|||
[[Embedding_FreeCAD#Using_FreeCAD_without_GUI|Category:Developer Documentation{{#translation:}}]] |
[[Embedding_FreeCAD#Using_FreeCAD_without_GUI|Category:Developer Documentation{{#translation:}}]] |
||
[[Category:Poweruser Documentation{{#translation:}}]] |
[[Category:Poweruser Documentation{{#translation:}}]] |
Revision as of 22:36, 19 November 2021
Introduction
This wiki page will document various aspect of running FreeCAD in the console without enabling the GUI (Graphical User Interface) or what is called 'headless'.
Scenegraph Representation
As it's not possible to create or access the view provider in headless mode. What's possible is to load FreeCADGui
in headless mode but there is no way to access the GUI document because it won't be created and consequently there exist no view providers.
However, what's possible is to create a scenegraph representation of an object. This works this way:
import FreeCADGui as Gui
from pivy import coin
Gui.setupWithoutGUI()
doc = App.newDocument()
obj = doc.addObject("Part::Box","Box")
doc.recompute()
view = Gui.subgraphFromObject(obj)
- reference: forum thread
Examples
Searching FreeCAD Modules
- Open the terminal
$ /path/to/FreeCAD -c
- or
$ /path/to/FreeCADCmd
- A python shell will start with a prompt. Type
help()
[FreeCAD Console mode <Use Ctrl-D (i.e. EOF) to exit.>] >>> help() Welcome to Python 3.x's help utility! If this is your first time using Python, you should definitely check out the tutorial on the Internet at https://docs.python.org/3.8/tutorial/. Enter the name of any module, keyword, or topic to get help on writing Python programs and using Python modules. To quit this help utility and return to the interpreter, just type "quit". To get a list of available modules, keywords, symbols, or topics, type "modules", "keywords", "symbols", or "topics". Each module also comes with a one-line summary of what it does; to list the modules whose name or summary contain a given string such as "spam", type "modules spam". help>
- Type
modules freecad
help> modules freecad