Std UserEditMode: Difference between revisions

From FreeCAD Documentation
(Updated the icons for the 4 modes.)
(Revised...)
Line 13: Line 13:
{{GuiCommand
{{GuiCommand
|Name=Std UserEditMode
|Name=Std UserEditMode
|MenuLocation=Edit → Edit mode
|MenuLocation=Edit → Edit mode → ...
|Workbenches=All
|Workbenches=All
|Version=0.20
|Version=0.20
Line 19: Line 19:
}}
}}


==Description==
== Description ==


The '''Std UserEditMode''' command defines the edit mode to be used when an object is double-clicked in the [[Tree_view|Tree view]].
The '''Std UserEditMode''' command defines the edit mode to be used when an object is double-clicked in the [[Tree_view|Tree view]].


==Usage==
== Usage ==


# There are several ways to invoke the command:
Choose an edit mode among available ones:
#* Click on the black down arrow to the right of the {{Button|[[Image:Std_UserEditModeDefault.svg|16px]] [[Std_UserEditMode|Std UserEditMode]]}} button and select an edit mode from the flyout.
# [[File:Std_UserEditModeDefault.svg|24px]] '''Default''': the object will be edited with its default mode. The edit mode is defined internally to be the most appropriate according the object type: for example, it will be shape properties edition for Part primitives and PartDesign features, placement edition with transform tool for boolean operations, ...
#* In the menu go to {{MenuCommand|View → Edit mode}} and select an edit mode.
# [[File:Std_UserEditModeTransform.svg|24px]] '''Transform''': the object will have its placement editable with the [[Std_TransformManip|Transform manipulator]]
# [[File:Std_UserEditModeCutting.svg|24px]] '''Cutting''': ??? this mode is implemented as available but seems to be currently not used by any object in FreeCAD
# [[File:Std_UserEditModeColor.svg|24px]] '''Color''': the object will have its individual faces color editable with the [[Part_FaceColors|face color editor]]


== Available edit modes ==
==Notes==


=== [[Image:Std_UserEditModeDefault.svg|32px]] Default ===
* Not all objects support all edit modes. In case the selected edit mode isn't supported by the edited object, it will fall back to its default mode


The object will be edited using its default mode. This edit mode is defined internally to be the most appropriate for the object type. For example, it will be shape properties edition for [[Part_Workbench|Part]] primitives and [[PartDesign_Workbench|PartDesign]] features, placement edition with transform tool for boolean operations, etc.
==Scripting==

=== [[Image:Std_UserEditModeTransform.svg|32px]] Transform ===

The object will have its placement editable with the [[Std_TransformManip|Transform manipulator]].

=== [[Image:Std_UserEditModeCutting.svg|32px]] Cutting ===

This mode is implemented as available but does not seems to be used by any object.

=== [[Image:Std_UserEditModeColor.svg|32px]] Color ===

The object will have the color of its individual faces editable with the [[Part_FaceColors|face color editor]].

== Notes ==

* Not all objects support all edit modes. In case the selected mode isn't supported by the object, its default edit mode will be used instead.

== Scripting ==


{{Emphasis|See also:}} [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].
{{Emphasis|See also:}} [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].

Revision as of 18:31, 11 October 2021

Other languages:

Std UserEditMode

Menu location
Edit → Edit mode → ...
Workbenches
All
Default shortcut
None
Introduced in version
0.20
See also
Std Edit

Description

The Std UserEditMode command defines the edit mode to be used when an object is double-clicked in the Tree view.

Usage

  1. There are several ways to invoke the command:
    • Click on the black down arrow to the right of the Std UserEditMode button and select an edit mode from the flyout.
    • In the menu go to View → Edit mode and select an edit mode.

Available edit modes

Default

The object will be edited using its default mode. This edit mode is defined internally to be the most appropriate for the object type. For example, it will be shape properties edition for Part primitives and PartDesign features, placement edition with transform tool for boolean operations, etc.

Transform

The object will have its placement editable with the Transform manipulator.

Cutting

This mode is implemented as available but does not seems to be used by any object.

Color

The object will have the color of its individual faces editable with the face color editor.

Notes

  • Not all objects support all edit modes. In case the selected mode isn't supported by the object, its default edit mode will be used instead.

Scripting

See also: FreeCAD Scripting Basics.

To list the available edit modes:

import FreeCADGui
FreeCADGui.listUserEditModes()

To get the active edit mode:

import FreeCADGui
FreeCADGui.getUserEditMode()

To set the active edit mode:

import FreeCADGui
FreeCADGui.setUserEditMode(MODENAME) # Where MODENAME is a string available in the list of edit modes