Std UserEditMode: Difference between revisions

From FreeCAD Documentation
No edit summary
(Toolbar button removed. See: https://github.com/FreeCAD/FreeCAD/pull/7570)
(10 intermediate revisions by 2 users not shown)
Line 2: Line 2:
<translate>
<translate>


<!--T:1-->
{{Docnav
{{Docnav
|[[Std_Edit|Edit]]
|[[Std_Edit|Edit]]
Line 11: Line 12:
}}
}}


<!--T:2-->
{{GuiCommand
{{GuiCommand
|Name=Std UserEditMode
|Name=Std UserEditMode
Line 19: Line 21:
}}
}}


== Description ==
== Description == <!--T:3-->


<!--T:4-->
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 == <!--T:5-->


<!--T:6-->
# There are several ways to invoke the command:
#* 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. Note: the button image will change depending on the selected option.
# In the menu go to {{MenuCommand|Edit Edit mode}} and select an edit mode.<!--Please keep the numbered list for consistency with other Std pages-->
#* In the menu go to {{MenuCommand|View → Edit mode}} and select an edit mode.


== Available edit modes ==
== Available edit modes == <!--T:7-->


=== [[Image:Std_UserEditModeDefault.svg|32px]] Default ===
=== [[Image:Std_UserEditModeDefault.svg|24px]] Default === <!--T:8-->


<!--T:9-->
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|Part primitives]] and [[PartDesign_Feature|PartDesign features]], placement edition for [[Part_Boolean|Part booleans]], etc.
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|Part primitives]] and [[PartDesign_Feature|PartDesign features]], placement edition for [[Part_Boolean|Part booleans]], etc.


=== [[Image:Std_UserEditModeTransform.svg|32px]] Transform ===
=== [[Image:Std_UserEditModeTransform.svg|24px]] Transform === <!--T:10-->


<!--T:11-->
The object will have its placement editable with the [[Std_TransformManip|Std TransformManip]] command.
The object will have its placement editable with the [[Std_TransformManip|Std TransformManip]] command.


=== [[Image:Std_UserEditModeCutting.svg|32px]] Cutting ===
=== [[Image:Std_UserEditModeCutting.svg|24px]] Cutting === <!--T:12-->


<!--T:13-->
This mode is implemented as available but currently does not seems to be used by any object.
This edit mode is implemented as available but currently does not seem to be used by any object.


=== [[Image:Std_UserEditModeColor.svg|32px]] Color ===
=== [[Image:Std_UserEditModeColor.svg|24px]] Color === <!--T:14-->


<!--T:15-->
The object will have the color of its individual faces editable with the [[Part_FaceColors|Part FaceColors]] command.
The object will have the color of its individual faces editable with the [[Part_FaceColors|Part FaceColors]] command.


== Notes ==
== Notes == <!--T:16-->


<!--T:17-->
* 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.
* Not all objects support all edit modes. If the selected mode isn't supported by the object, its default edit mode will be used instead.


== Scripting ==
== Preferences == <!--T:18-->


<!--T:19-->
* The last edit mode is stored: {{MenuCommand|Tools → Edit parameters... → BaseApp → Preferences → General → UserEditMode}}. It is an integer value. Possible values are {{Incode|0}} (Default), {{Incode|1}} (Transform), {{Incode|2}} (Cutting) or {{Incode|3}} (Color). The default is {{Incode|0}}.

== Scripting == <!--T:20-->

<!--T:21-->
{{Emphasis|See also:}} [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].
{{Emphasis|See also:}} [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].


<!--T:22-->
To list the available edit modes:
To list the available edit modes:


Line 64: Line 78:
<translate>
<translate>


<!--T:23-->
To get the active edit mode:
To get the active edit mode:


Line 73: Line 88:
<translate>
<translate>


<!--T:24-->
To set the active edit mode:
To set the active edit mode:


Line 83: Line 99:




<!--T:25-->
{{Docnav
{{Docnav
|[[Std_Edit|Edit]]
|[[Std_Edit|Edit]]

Revision as of 08:50, 11 October 2022

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. In the menu go to Edit → 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 for Part booleans, etc.

Transform

The object will have its placement editable with the Std TransformManip command.

Cutting

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

Color

The object will have the color of its individual faces editable with the Part FaceColors command.

Notes

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

Preferences

  • The last edit mode is stored: Tools → Edit parameters... → BaseApp → Preferences → General → UserEditMode. It is an integer value. Possible values are 0 (Default), 1 (Transform), 2 (Cutting) or 3 (Color). The default is 0.

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