base class — bpy_struct

class bpy.types.GizmoGroup(bpy_struct)

Storage of an operator being executed, or registered after execution

Type:string, default “”, (never None)
Type:string, default “”, (never None)

Options for this operator type

  • 3D 3D, Use in 3D viewport.
  • SCALE Scale, Scale to respect zoom (otherwise zoom independent draw size).
  • DEPTH_3D Depth 3D, Supports culled depth by other objects in the view.
  • SELECT Select, Supports selection.
  • PERSISTENT Persistent.
  • SHOW_MODAL_ALL Show Modal All, Show all while interacting.
  • TOOL_INIT Tool Init, Postpone running until tool operator run (when used with a tool).
Type:enum set in {‘3D’, ‘SCALE’, ‘DEPTH_3D’, ‘SELECT’, ‘PERSISTENT’, ‘SHOW_MODAL_ALL’, ‘TOOL_INIT’}, default {‘3D’}
Type:string, default “”, (never None)

The region where the panel is going to be used in


The space where the panel is going to be used in

  • EMPTY Empty.
  • VIEW_3D 3D Viewport, Manipulate objects in a 3D environment.
  • IMAGE_EDITOR UV/Image Editor, View and edit images and UV Maps.
  • NODE_EDITOR Node Editor, Editor for node-based shading and compositing tools.
  • SEQUENCE_EDITOR Video Sequencer, Video editing tools.
  • CLIP_EDITOR Movie Clip Editor, Motion tracking tools.
  • DOPESHEET_EDITOR Dope Sheet, Adjust timing of keyframes.
  • GRAPH_EDITOR Graph Editor, Edit drivers and keyframe interpolation.
  • NLA_EDITOR Nonlinear Animation, Combine and layer Actions.
  • TEXT_EDITOR Text Editor, Edit scripts and in-file documentation.
  • CONSOLE Python Console, Interactive programmatic console for advanced editing and script development.
  • INFO Info, Log of operations, warnings and error messages.
  • TOPBAR Top Bar, Global bar at the top of the screen for global per-window settings.
  • STATUSBAR Status Bar, Global bar at the bottom of the screen for general status information.
  • OUTLINER Outliner, Overview of scene graph and all available data-blocks.
  • PROPERTIES Properties, Edit properties of active object and related data-blocks.
  • FILE_BROWSER File Browser, Browse for files and assets.
  • PREFERENCES Preferences, Edit persistent configuration settings.

List of gizmos in the Gizmo Map

Type:Gizmos bpy_prop_collection of Gizmo, (readonly)

GizmoGroup has a set of reports (warnings and errors) from last execution

Type:boolean, default False, (readonly)
Type:string, default “”, (readonly, never None)
classmethod poll(context)

Test if the gizmo group can be called or not

Return type:boolean
classmethod setup_keymap(keyconfig)

Initialize keymaps for this gizmo group, use fallback keymap when not present

Return type:KeyMap, (never None)

Create gizmos function for the gizmo group


Refresh data (called on common state changes such as selection)


Run before each redraw

invoke_prepare(context, gizmo)

Run before invoke

classmethod bl_rna_get_subclass(id, default=None)
Parameters:id (string) – The RNA type identifier.
Returns:The RNA type or default when not found.
Return type:bpy.types.Struct subclass
classmethod bl_rna_get_subclass_py(id, default=None)
Parameters:id (string) – The RNA type identifier.
Returns:The class or default when not found.
Return type:type

Inherited Properties

Inherited Functions