Std DlgMacroRecord: Difference between revisions
mNo edit summary |
No edit summary |
||
(25 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
<languages/> |
<languages/> |
||
{{UnfinishedDocu|Needs English UI image}} |
|||
<translate> |
<translate> |
||
<!--T:17--> |
|||
{{Docnav |
|||
| |
|||
|[[Std_MacroStopRecord|MacroStopRecord]] |
|||
|[[Std_Macro_Menu|Std Macro Menu]] |
|||
| |
|||
|IconR=Std_MacroStopRecord.svg |
|||
|IconC=Freecad.svg |
|||
}} |
|||
<!--T:1--> |
<!--T:1--> |
||
{{GuiCommand |
{{GuiCommand |
||
|Name=Std DlgMacroRecord |
|Name=Std DlgMacroRecord |
||
|MenuLocation= |
|MenuLocation=Macro → Macro recording... |
||
|Workbenches=All |
|Workbenches=All |
||
|SeeAlso=[[ |
|SeeAlso=[[Std_MacroStopRecord|Std MacroStopRecord]] |
||
}} |
}} |
||
== |
==Description== <!--T:2--> |
||
<!--T:3--> |
<!--T:3--> |
||
The '''Std DlgMacroRecord''' command starts a [[Macros|macro]] recording session during which user actions are stored in a FreeCAD macro, a file with the {{FileName|.FCMacro}} extension. A macro can later be replayed, executed, to repeat the recorded actions. |
|||
The [[Image:Std_DlgMacroRecord.svg|16px]] Start Macro recording function initiates a recording session of a [[macros|macro]]. This means it will record all operation the user makes in the [[3D view]]. Once the user is finished with the sequence of action, the [[File:Std MacroStopRecord.svg|16px]] [[Std MacroStopRecord|Stop Macro Recording]] functions ends the macro recording session. This is a powerful technique to record repetitive sequences of actions (in to [[Python]] code that can be saved in a FreeCAD Macro file ({{incode|.FCMacro}})), that can be executed at a later time or even transferred to another computer running FreeCAD. |
|||
</translate> |
|||
⚫ | |||
[[Image:Std_DlgMacroRecord_dialog.png]] |
|||
<translate> |
|||
<!--T:18--> |
|||
{{Caption|The Macro recording dialog box}} |
|||
⚫ | |||
<!--T:4--> |
<!--T:4--> |
||
# There are several ways to invoke the command: |
|||
#The Macro Record function is accessible via several ways: |
|||
#* |
#* Press the {{Button|[[Image:Std_DlgMacroRecord.svg|16px]] [[Std_DlgMacroRecord|Std DlgMacroRecord]]}} button. |
||
#* |
#* Select the {{MenuCommand|Macro → [[Image:Std_DlgMacroRecord.svg|16px]] Macro recording...}} option from the menu. |
||
# The Macro recording dialog box opens. |
|||
# '''Result:''' A dialog box will appear querying the user for the following information |
|||
⚫ | |||
#: [[Image:Menu_Std_DlgMacroRecord_it.png|Macro recording]] |
|||
# |
# Optionally change the '''Macro path''' by pressing the {{Button|...}} button. |
||
# The {{Button|Stop}} button does not work at this time. |
|||
#::* '''Macro path''': Path macro library. To change the path, click {{Button| ... }}. |
|||
# |
# Press the {{Button|Record}} button to close the dialog box and start the recording session. |
||
# Perform the actions you want to record. |
|||
#:::'''Note:''' The button {{Button|[[File:Std MacroStopRecord.svg|16px]] Stop macro recording session}} in the macros toolbar [[File:Macros_toolbar.jpg|96px]] will turn green [[File:Std MacroStopRecord.svg|16px]]. |
|||
# |
# To end the recording session do one of the following: |
||
#* Press the {{Button|[[Image:Std_MacroStopRecord.svg|16px]] [[Std_MacroStopRecord|Std MacroStopRecord]]}} button. |
|||
#::* {{Button|Cancel}}: Cancels and closes the window. |
|||
# |
#* Select the {{MenuCommand|Macro → [[Image:Std_MacroStopRecord.svg|16px]] Stop macro recording}} option from the menu. |
||
== |
==Options== <!--T:19--> |
||
<!--T:20--> |
|||
# The macro can be executed several ways: |
|||
* When the Macro recording dialog box is displayed: press {{KEY|Esc}} or the {{Button|Cancel}} button to abort the command. |
|||
#* Through the {{MenuCommand|Macro → Macros...}} menu |
|||
#* Pressing the {{Button|[[File:Std_DlgMacroExecuteDirect.svg|16px]] [[Std_DlgMacroExecuteDirect|Execute this macro]]}} button in the macro toolbar |
|||
# Choose the macro |
|||
# Press {{Button|OK}} |
|||
== |
==Notes== <!--T:21--> |
||
<!--T: |
<!--T:22--> |
||
* To execute the recorded macro use the [[Std_DlgMacroExecute|Std DlgMacroExecute]] command. |
|||
# Press the [File:Std DlgMacroRecord.svg|16px]] button |
|||
* To learn more about macros see the [[Macros]] page. |
|||
⚫ | |||
# Open a document |
|||
# Create an [[Image:Part_Box.svg|24px]] [[Part Box|Cube]] |
|||
# Change the color of the box |
|||
# Press on [[File:Std MacroStopRecord.svg|16px]] to stop the macro recording |
|||
<!--T: |
==Preferences== <!--T:23--> |
||
Result: The macro is available in your macros directory. [[#Executing the Macro|Execute]] the macro to recreate the steps you just recorded. |
|||
<!--T: |
<!--T:24--> |
||
* The macro path can also be changed in the preferences: {{MenuCommand|Edit → Preferences... → General → Macro → Macro path}}. See [[Preferences_Editor#Macro|Preferences Editor]]. |
|||
⚫ | |||
* In most cases it is undesirable to record actions that do not change the model: under {{MenuCommand|Edit → Preferences... → General → Macro → GUI commands}} do one of the following: |
|||
** To exclude these actions uncheck the {{CheckBox|FALSE|Record GUI commands}} checkbox. |
|||
** To include them as comments only check both the {{CheckBox|TRUE|Record GUI commands}} and {{CheckBox|TRUE|Record as comment}} checkboxes. |
|||
<!--T:25--> |
|||
{{Docnav |
|||
| |
|||
|[[Std_MacroStopRecord|MacroStopRecord]] |
|||
|[[Std_Macro_Menu|Std Macro Menu]] |
|||
| |
|||
|IconR=Std_MacroStopRecord.svg |
|||
|IconC=Freecad.svg |
|||
}} |
|||
⚫ | |||
</translate> |
</translate> |
||
⚫ | |||
⚫ | |||
{{clear}} |
{{clear}} |
Revision as of 20:56, 22 December 2020
Std DlgMacroRecord |
Menu location |
---|
Macro → Macro recording... |
Workbenches |
All |
Default shortcut |
None |
Introduced in version |
- |
See also |
Std MacroStopRecord |
Description
The Std DlgMacroRecord command starts a macro recording session during which user actions are stored in a FreeCAD macro, a file with the .FCMacro extension. A macro can later be replayed, executed, to repeat the recorded actions.
The Macro recording dialog box
Usage
- There are several ways to invoke the command:
- Press the Std DlgMacroRecord button.
- Select the Macro → Macro recording... option from the menu.
- The Macro recording dialog box opens.
- Enter a name for the macro in the Macro name input box.
- Optionally change the Macro path by pressing the ... button.
- The Stop button does not work at this time.
- Press the Record button to close the dialog box and start the recording session.
- Perform the actions you want to record.
- To end the recording session do one of the following:
- Press the Std MacroStopRecord button.
- Select the Macro → Stop macro recording option from the menu.
Options
- When the Macro recording dialog box is displayed: press Esc or the Cancel button to abort the command.
Notes
- To execute the recorded macro use the Std DlgMacroExecute command.
- To learn more about macros see the Macros page.
Preferences
- The macro path can also be changed in the preferences: Edit → Preferences... → General → Macro → Macro path. See Preferences Editor.
- In most cases it is undesirable to record actions that do not change the model: under Edit → Preferences... → General → Macro → GUI commands do one of the following:
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, Start, Surface, TechDraw, Test Framework, Web
- Hubs: User hub, Power users hub, Developer hub