GizmoGroup(bpy_struct)

base class — bpy_struct

class bpy.types.GizmoGroup(bpy_struct)

Storage of an operator being executed, or registered after execution

bl_idname
Type

string, default “”, (never None)

bl_label
Type

string, default “”, (never None)

bl_options

Options for this operator type

  • 3D 3D – Use in 3D viewport.

  • SCALE Scale – Scale to respect zoom (otherwise zoom independent display 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, as well as this group when another is being interacted with.

  • EXCLUDE_MODAL Exclude Modal – Show all except this group while interacting.

  • TOOL_INIT Tool Init – Postpone running until tool operator run (when used with a tool).

  • VR_REDRAWS VR Redraws – The gizmos are made for use with virtual reality sessions and require special redraw management.

Type

enum set in {‘3D’, ‘SCALE’, ‘DEPTH_3D’, ‘SELECT’, ‘PERSISTENT’, ‘SHOW_MODAL_ALL’, ‘EXCLUDE_MODAL’, ‘TOOL_INIT’, ‘VR_REDRAWS’}, default {‘3D’}

bl_owner_id
Type

string, default “”, (never None)

bl_region_type

The region where the panel is going to be used in

Type

enum in [‘WINDOW’, ‘HEADER’, ‘CHANNELS’, ‘TEMPORARY’, ‘UI’, ‘TOOLS’, ‘TOOL_PROPS’, ‘PREVIEW’, ‘HUD’, ‘NAVIGATION_BAR’, ‘EXECUTE’, ‘FOOTER’, ‘TOOL_HEADER’, ‘XR’], default ‘WINDOW’

bl_space_type

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.

  • LOGIC_EDITOR Logic Bricks Editor – Logic Bricks Editor tools.

  • 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.

  • SPREADSHEET Spreadsheet – Explore geometry data in a table.

  • PREFERENCES Preferences – Edit persistent configuration settings.

Type

enum in [‘EMPTY’, ‘VIEW_3D’, ‘IMAGE_EDITOR’, ‘NODE_EDITOR’, ‘SEQUENCE_EDITOR’, ‘CLIP_EDITOR’, ‘DOPESHEET_EDITOR’, ‘GRAPH_EDITOR’, ‘NLA_EDITOR’, ‘TEXT_EDITOR’, ‘LOGIC_EDITOR’, ‘CONSOLE’, ‘INFO’, ‘TOPBAR’, ‘STATUSBAR’, ‘OUTLINER’, ‘PROPERTIES’, ‘FILE_BROWSER’, ‘SPREADSHEET’, ‘PREFERENCES’], default ‘EMPTY’

gizmos

List of gizmos in the Gizmo Map

Type

Gizmos bpy_prop_collection of Gizmo, (readonly)

has_reports

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

Type

boolean, default False, (readonly)

name
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)

setup(context)

Create gizmos function for the gizmo group

refresh(context)

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

draw_prepare(context)

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

References