Std SendToPythonConsole: Difference between revisions

From FreeCAD Documentation
(Removed code template from 'Example output'.)
(Removed Std prefix in Docnav as discussed)
Line 4: Line 4:
<!--T:1-->
<!--T:1-->
{{Docnav
{{Docnav
|[[Std_Delete|Std Delete]]
|[[Std_Delete|Delete]]
|[[Std_Placement|Std Placement]]
|[[Std_Placement|Placement]]
|[[Std_Edit_Menu|Std Edit Menu]]
|[[Std_Edit_Menu|Std Edit Menu]]
|IconL=Std_Delete.svg
|IconL=Std_Delete.svg
Line 44: Line 44:
#* Select the {{MenuCommand|[[Image:Std_SendToPythonConsole.svg|16px]] Send to Python Console}} option from the [[Tree_view|Tree view]] context menu or [[3D_view|3D view]] context menu.
#* Select the {{MenuCommand|[[Image:Std_SendToPythonConsole.svg|16px]] Send to Python Console}} option from the [[Tree_view|Tree view]] context menu or [[3D_view|3D view]] context menu.
#* Use the keyboard shortcut: {{KEY|Ctrl}}+{{KEY|Shift}}+{{KEY|P}}.
#* Use the keyboard shortcut: {{KEY|Ctrl}}+{{KEY|Shift}}+{{KEY|P}}.



<!--T:9-->
<!--T:9-->
{{Docnav
{{Docnav
|[[Std_Delete|Std Delete]]
|[[Std_Delete|Delete]]
|[[Std_Placement|Std Placement]]
|[[Std_Placement|Placement]]
|[[Std_Edit_Menu|Std Edit Menu]]
|[[Std_Edit_Menu|Std Edit Menu]]
|IconL=Std_Delete.svg
|IconL=Std_Delete.svg

Revision as of 09:21, 29 December 2020

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 a variable in the Python console referencing a selected object. If a subshape of the object is selected two additional variables are created, one referencing the shape of the object and the other referencing the subshape itself. The variables and the code involved can be used to development Python code.

>>> ### Begin command Std_SendToPythonConsole
>>> obj = App.getDocument("Unnamed").getObject("Box")
>>> shp = App.getDocument("Unnamed").getObject("Box").Shape
>>> elt = App.getDocument("Unnamed").getObject("Box").Shape.Edge8
>>> ### End command Std_SendToPythonConsole

Example output: an edge of a Part Box was selected

Usage

  1. Select 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.