Std DlgMacroRecord: Difference between revisions

From FreeCAD Documentation
mNo edit summary
mNo edit summary
Line 21: Line 21:
#* The menu {{MenuCommand|{{StdMenu|[[Std Macro Menu|Macro]]}} → Macro recording}},
#* The menu {{MenuCommand|{{StdMenu|[[Std Macro Menu|Macro]]}} → Macro recording}},
# '''Result:''' A dialog box will appear querying the user for the following information
# '''Result:''' A dialog box will appear querying the user for the following information
#: [[Image:Menu_Std_DlgMacroRecord_it.png‎|Macro recording]]
#: [[Image:Menu_Std_DlgMacroRecord_it.svg‎|Macro recording]]
:::* '''Macro name''': Enter the name of the new macro.
#::* '''Macro name''': Enter the name of the new macro.
:::* '''Macro path''': Path macro library. To change the path, click {{Button| ... }}.
#::* '''Macro path''': Path macro library. To change the path, click {{Button| ... }}.
:::* {{KEY|Record}}: Record the macro (starts recording all actions in the [[3D view]]).
#::* {{KEY|Record}}: Record the macro (starts recording all actions in the [[3D view]]).
::::'''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]].
#:::'''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]].
:::* {{Button|Stop}}: Stop recording the macro.
#::* {{Button|Stop}}: Stop recording the macro.
:::* {{Button|Cancel}}: Cancels and closes the window.
#::* {{Button|Cancel}}: Cancels and closes the window.
# Once completed, click {{KEY|[[File:Std MacroStopRecord.svg|16px]] [[Std MacroStopRecord|Stop the macro recording session]]}} to stop recording the macro.
# Once completed, click {{KEY|[[File:Std MacroStopRecord.svg|16px]] [[Std MacroStopRecord|Stop the macro recording session]]}} to stop recording the macro.


Line 41: Line 41:


<!--T:13-->
<!--T:13-->
Click the button [[File:Std DlgMacroRecord.png|16px]] enter a name for the macro and validate, open a document, create a cube, change the color stop the macro with the button [[File:Std MacroStopRecord.svg|16px]].
# Press the [File:Std DlgMacroRecord.svg|16px]] button
# Enter a name for the macro and press {{Button|OK}}
# Open a document
# Create an [[Image:Part_Box.svg|24px]] [[PartBox|Cube]]
# Change the color of the box
# Press on [[File:Std MacroStopRecord.svg|16px]] to stop the macro recording


<!--T:10-->
<!--T:10-->
The macro is available in your macros directory.
Result: The macro is available in your macros directory. [[#Executing the Macro|Execute]] the macro to recreate the steps you just recorded.


<!--T:14-->
<!--T:14-->

Revision as of 21:42, 12 February 2020

Std DlgMacroRecord

Menu location
Macro → Macro recording...
Workbenches
All
Default shortcut
None
Introduced in version
-
See also
Execute macro

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

  1. The Macro Record function is accessible via several ways:
    • The Macro recording button in the macro toolbar
    • The menu Macro → Macro recording,
  2. Result: A dialog box will appear querying the user for the following information
    Macro recording
    • 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).
    Note: The button Stop macro recording session in the macros toolbar will turn green .
    • Stop: Stop recording the macro.
    • Cancel: Cancels and closes the window.
  3. Once completed, click Stop the macro recording session to stop recording the macro.

Executing the Macro

  1. The macro can be executed several ways:
    • Through the Macro → Macros... menu
    • Pressing the Execute this macro button in the macro toolbar
  2. Choose the macro
  3. Press OK

Example

  1. Press the [File:Std DlgMacroRecord.svg|16px]] button
  2. Enter a name for the macro and press OK
  3. Open a document
  4. Create an Cube
  5. Change the color of the box
  6. 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.