Std SendToPythonConsole: Difference between revisions
TheMarkster (talk | contribs) (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
- Select a single object or one or more subshapes belonging to a single object.
- There are several ways to invoke the command:
- If required the Python console opens. introduced in version 0.20
- 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.
Std Base
- File: New, Open, Close, Close All, Save, Save As, Save a Copy, Save All, Revert, Import, Export,Merge project, Project information, Print, Print preview, Export PDF, Recent files, Exit
- Edit: Undo, Redo, Cut, Copy, Paste, Duplicate selection, Refresh, Box selection, Box element selection, Select All, Delete, Send to Python Console, Placement, Transform, Alignment, Toggle Edit mode, Edit mode, Preferences
- View:
- Miscellaneous: Create new view, Orthographic view, Perspective view, Fullscreen, Bounding box, Toggle axis cross, Clipping plane, Texture mapping, Toggle navigation/Edit mode, Appearance, Random color, Workbench, Status bar
- Standard views: Fit all, Fit selection, Isometric, Dimetric, Trimetric, Home, Front, Top, Right, Rear, Bottom, Left, Rotate Left, Rotate Right
- Freeze display: Save views, Load views, Freeze view, Clear views
- Draw style: As is, Points, Wireframe, Hidden line, No shading, Shaded, Flat lines
- Stereo: Stereo red/cyan, Stereo quad buffer, Stereo Interleaved Rows, Stereo Interleaved Columns, Stereo Off, Issue camera position
- Zoom: Zoom In, Zoom Out, Box zoom
- Document window: Docked, Undocked, Fullscreen
- Visibility: Toggle visibility, Show selection, Hide selection, Select visible objects, Toggle all objects, Show all objects, Hide all objects, Toggle selectability, Toggle measurement, Clear measurement
- Toolbars: File, Edit, Clipboard, Workbench, Macro, View, Structure, Help
- Panels: Tree view, Property view, Selection view, Tasks, Python console, DAG view, Model, Report view
- Link navigation: Go to linked object, Go to the deepest linked object, Select all links
- Tree view actions: Sync view, Sync selection, Sync placement, Pre-selection, Record selection, Single document, Multi document, Collapse/Expand, Initiate dragging, Go to selection, Selection Back, Selection Forward
- Tools: Edit parameters, Save image, Load image, Scene inspector, Dependency graph, Project utility, Measure distance, Add text document, View turntable, Units calculator, Customize, Addon manager
- Macro: Macro recording, Macros, Recent macros, Execute macro, Attach to remote debugger, Debug macro, Stop debugging, Step over, Step into, Toggle breakpoint
- Help: Help, FreeCAD Website, Donate, Users documentation, Python scripting documentation, Automatic Python modules documentation, FreeCAD Forum, FreeCAD FAQ, Report a bug, About FreeCAD, What's This
User documentation
- Getting started
- Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
- Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate
- Help: Tutorials, Video tutorials
- Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Surface, TechDraw, Test Framework
- Hubs: User hub, Power users hub, Developer hub