Std DlgMacroRecord
This documentation is not finished. Please help and contribute documentation.
GuiCommand model explains how commands should be documented. Browse Category:UnfinishedDocu to see more incomplete pages like this one. See Category:Command Reference for all commands.
See WikiPages to learn about editing the wiki pages, and go to Help FreeCAD to learn about other ways in which you can contribute.
Std DlgMacroRecord |
Menu location |
---|
Macro → Macro recording... |
Workbenches |
All |
Default shortcut |
None |
Introduced in version |
- |
See also |
Execute macro, Std Macro Menu |
Description
The Start Macro recording function initiates a recording session of a 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 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 (.FCMacro
)), that can be executed at a later time or even transferred to another computer running FreeCAD.
Usage
- The Macro Record function is accessible via several ways:
- The Macro recording button in the macro toolbar
- The menu Macro → Macro recording,
- Result: A dialog box will appear querying the user for the following information
-
- Macro name: Enter the name of the new macro.
- Macro path: Path macro library. To change the path, click ... .
- Record: Record the macro (starts recording all actions in the 3D view).
- Stop: Stop recording the macro.
- Cancel: Cancels and closes the window.
-
- Once completed, click Stop the macro recording session to stop recording the macro.
Executing the Macro
- The macro can be executed several ways:
- Through the Macro → Macros... menu
- Pressing the Execute this macro button in the macro toolbar
- Choose the macro
- Press OK
Example
- Press the [File:Std DlgMacroRecord.svg|16px]] button
- Enter a name for the macro and press OK
- Open a document
- Create an Cube
- Change the color of the box
- Press on to stop the macro recording
Result: The macro is available in your macros directory. Execute the macro to recreate the steps you just recorded.
- 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
- 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
- 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, Assembly, BIM, 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