Std SendToPythonConsole: Difference between revisions

From FreeCAD Documentation
(update for 0.20)
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.
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 variable '''doc''' references the document containing the selected object. The variable '''obj''' references the selected object unless it is a Link, in which case '''obj''' references the Linked object. If the selected object is a Link, then a variable named '''lnk''' is produced that references the Link object itself. The variable '''shp''' references the Shape property of the object if it is derived from Part::Feature (as all object's with Shape property are), but for Mesh objects '''shp''' = obj.Mesh, and for Points objects, '''shp''' = obj.Points. If a subshape of the object is selected an additional variable '''sub''' is created, referencing the subshape of the object. Note: '''sub''' has been renamed from '''elt''' used in previous versions. If more than one subshape has been selected, then '''sub''' references the first selected subshape and all of the selected subshapes are in a list variable '''subs'''. The variables and the code involved can be used to development Python code. Note: all previously created variables are deleted each time the command is run, so you would need to save any variables you wish to use after a subsequent use of the command by assigning to a new variable Although you may select multiple subshapes of a single object, only one single object is supported.

{| class="wikitable"
|-
! 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 is the Linked object.
|-
| lnk || The Link object (only created if the selected object is a Link)
|-
| shp || The Shape property of the object (obj.Shape for objects derived from the Part::Feature class, obj.Mesh for Mesh objects, obj.Points for Points objects)
|-
| sub || The 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)
|}


</translate>
</translate>
Line 47: Line 64:


<!--T:13-->
<!--T:13-->
# Select a single object.
# Select a single object or one or more subshapes belonging to a single object.
# There are several ways to invoke the command:
# There are several ways to invoke the command:
#* Select the {{MenuCommand|Edit → [[Image:Std_SendToPythonConsole.svg|16px]] Send to Python Console}} option from the menu.
#* Select the {{MenuCommand|Edit → [[Image:Std_SendToPythonConsole.svg|16px]] Send to Python Console}} option from the menu.
Line 54: Line 71:
# If required the [[Python_console|Python console]] opens. {{Version|0.20}}
# If required the [[Python_console|Python console]] opens. {{Version|0.20}}
# The [[Python_console|Python console]] receives the keyboard focus. {{Version|0.20}}
# The [[Python_console|Python console]] receives the keyboard focus. {{Version|0.20}}

==Notes==

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





Revision as of 21:40, 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 development Python code.

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 is the Linked object.
lnk The Link object (only created if the selected object is a Link)
shp The Shape property of the object (obj.Shape for objects derived from the Part::Feature class, obj.Mesh for Mesh objects, obj.Points for Points objects)
sub The 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.