user: Describe Bpy.Types.Gizmo from the Blender manual or Python API, including usage steps and snippets.

assistant: y ( string , ( never None ) ) – Identifier of property in data target_set_operator ( operator , * , index = 0 ) ¶ Operator to run when activating the gizmo (overrides property targets) Parameters : operator ( string , ( never None ) ) – Target operator index ( int in [ 0 , 255 ] , ( optional ) ) – Part index Returns : Operator properties to fill in Return type : OperatorProperties target_is_valid ( property ) ¶ Parameters : property ( string , ( never None ) ) – Property identifier Return type : boolean draw_custom_shape ( shape , * , matrix = None , select_id = None ) ¶ Draw a shape created form Gizmo.draw_custom_shape . Parameters : shape ( Any ) – The cached shape to draw. matrix ( mathutils.Matrix ) – 4x4 matrix, when not given Gizmo.matrix_world is used. select_id ( int ) – The selection id. Only use when drawing within Gizmo.draw_select . static new_custom_shape ( type , verts ) ¶ Create a new shape that can be passed to Gizmo.draw_custom_shape . Parameters : type ( str ) – The type of shape to create in (POINTS, LINES, TRIS, LINE_STRIP). verts ( Sequence [ Sequence [ float ] ] ) – Sequence of 2D or 3D coordinates. Returns : The newly created shape (the return type make change). Return type : Any classmethod bl_rna_get_subclass ( id , default = None , / ) ¶ Parameters : id ( str ) – 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 ( str ) – The RNA type identifier. Returns : The class or default when not found. Return type : type target_get_range(target): Get the range for this target property. Parameters : target – Target property name. Returns : The range of this property (min, max). Return type : tuple[float, float] target_get_value(target): Get the value of this target property. Parameters : target ( str ) – Target property name. Returns : The value of the target property as a value or array based on the target type. Return type : float | tuple[float, …] target_set_handler(target, get, set, range=None): Assigns callbacks to a gizmos property. Parameters : target ( str ) – Target property name. get ( Callable [ [ ] , float | Sequence [ float ] ] ) – Function that returns the value for this property (single value or sequence). set ( Callable [ [ tuple [ float , ... ] ] , Any ] ) – Function that takes a single value argument and applies it. range ( callable ) – Function that returns a (min, max) tuple for gizmos that use a range. The returned value is not used. target_set_value(target): Set the value of this target property. Parameters : target ( str ) – Target property name. Inherited Properties ¶ bpy_struct.id_data Inherited Functions ¶ bpy_struct.as_pointer bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.id_properties_clear bpy_struct.id_properties_ensure bpy_struct.id_properties_ui bpy_struct.is_property_hidden bpy_struct.is_property_overridable_library bpy_struct.is_property_readonly bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_from_module bpy_struct.path_resolve bpy_struct.pop bpy_struct.property_overridable_library_set bpy_struct.property_unset bpy_struct.rna_ancestors bpy_struct.type_recast bpy_struct.values References ¶ GizmoGroup.gizmos GizmoGroup.invoke_prepare Gizmos.new Gizmos.remove Next GizmoGroup(bpy_struct) Previous GeometrySet Copyright &#169; Blender Authors Made with Furo Report issue on this page On this page Gizmo(bpy_struct) Gizmo Gizmo.alpha Gizmo.alpha_highlight Gizmo.bl_idname Gizmo.color Gizmo.color_highlight Gizmo.group Gizmo.hide Gizmo.hide_keymap Gizmo.hide_select Gizmo.is_highlight Gizmo.is_modal Gizmo.line_width Gizmo.matrix_basis Gizmo.matrix_offset Gizmo.matrix_space Gizmo.matrix_world Gizmo.properties Gizmo.scale_basis Gizmo.select Gizmo.select_bias Gizmo.use_draw_hover Gizmo.use_draw_modal Gizmo.use_draw_offset_scale Gizmo.use_draw_scale Gizmo.use_draw_value Gizmo.use_event_handle_all Gizmo.use_grab_cursor Gizmo.use_operator_tool_properties Gizmo.use_select_background Gizmo.use_tooltip Gizmo.draw() Gizmo.draw_select() Gizmo.test_select() Gizmo.modal() Gizmo.setup() Gizmo.invoke() Gizmo.exit() Gizmo.select_refresh() Gizmo.draw_preset_box() Gizmo.draw_preset_arrow() Gizmo.draw_preset_circle() Gizmo.target_set_prop() Gizmo.target_set_operator() Gizmo.target_is_valid() Gizmo.draw_custom_shape() Gizmo.new_custom_shape() Gizmo.bl_rna_get_subclass() Gizmo.bl_rna_get_subclass_py() Inherited Properties Inherited Functions References