Std SendToPythonConsole: Difference between revisions

From FreeCAD Documentation
No edit summary
No edit summary
Line 24: Line 24:


<!--T:4-->
<!--T:4-->
The '''Std SendToPythonConsole''' command creates variables in the [[Python_console|Python console]] referencing the selected object and its subshapes, along with some other useful references. The variables and the code involved can be used to development Python code. See the table below.
The '''Std SendToPythonConsole''' command creates variables in the [[Python_console|Python console]] referencing the selected object and its subshapes, along with some other useful references. The variables and the code involved can be used to develop Python code. See the table below.


{| class="wikitable"
{| class="wikitable"

Revision as of 22:04, 2 March 2022

Std SendToPythonConsole

Menu location
Edit → Send to Python Console
Workbenches
All
Default shortcut
Ctrl+Shift+P
Introduced in version
0.19
See also
None

Description

The Std SendToPythonConsole command creates variables in the Python console referencing the selected object and its subshapes, along with some other useful references. The variables and the code involved can be used to develop Python code. See the table below.

Variable name Referenced object(s)
doc The document containing the selected object
obj The selected object unless it is a Link, in which case it references the Linked object
lnk The Link object (only created if the selected object is a Link)
shp Depending on the type of the selected object:

The Shape property of the object (for objects derived from the Part::Feature class)
The Mesh property of the object (for Mesh objects)
The Points property of the object (for Points objects)

sub The first selected subshape of the object (only created if at least one subshape has been select)
subs A list containing all subshapes (only created if two or more subshapes have been select)
>>> ### Begin command Std_SendToPythonConsole
>>> try:
>>>     del(doc,lnk,obj,shp,sub,subs)
>>> except Exception:
>>>     pass
>>> 
>>> doc = App.getDocument("Unnamed")
>>> lnk = doc.getObject("Link")
>>> obj = lnk.getLinkedObject() #in this case a Cube
>>> shp = obj.Shape
>>> sub = obj.getSubObject("Edge10")
>>> subs = [obj.getSubObject("Edge10"),obj.getSubObject("Face3"),obj.getSubObject("Vertex5"),]
>>> ### End command Std_SendToPythonConsole

Example output: an edge, a face, and a vertex of a Link to a Part Box was selected

Usage

  1. Select a single object or one or more subshapes belonging to a single object.
  2. There are several ways to invoke the command:
    • Select the Edit → Send to Python Console option from the menu.
    • Select the Send to Python Console option from the Tree view context menu or 3D view context menu.
    • Use the keyboard shortcut: Ctrl+Shift+P.
  3. If required the Python console opens. introduced in version 0.20
  4. The Python console receives the keyboard focus. introduced in version 0.20

Notes

  • All previously created variables are deleted each time the command is run.