Std UserEditMode

From FreeCAD Documentation
Jump to navigation Jump to search
Other languages:
English • ‎français • ‎polski

Std UserEditMode.svg 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 UserEditModeDefault.svg 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 View → Edit mode and select an edit mode.

Available edit modes

Std UserEditModeDefault.svg 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.

Std UserEditModeTransform.svg Transform

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

Std UserEditModeCutting.svg Cutting

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

Std UserEditModeColor.svg 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