Page MenuHome

Missing Gizmo information in the API documentation
Confirmed, NormalPublicTO DO

Description

Copy from devtalk : https://devtalk.blender.org/t/gizmo-api-documentation-missing-infos/8965

Hi, here is a list of what I found was missing by Gizmo type when looking in the code.

  • List of the name of GizmoType : GIZMO_GT_* we can use, like for the icons.
  • GIZMO_GT_arrow_2d

    length : arrow length

    angle : do nothing
  • GIZMO_GT_arrow_3d

    length : arrow length

    draw_options : {'STEM'} do nothing

    draw_style : ('NORMAL', 'CROSS', 'BOX', 'CONE')

    transform : {'INVERT', 'CONSTRAIN'} 'CONSTRAIN' crash Blender

    aspect : (flt, flt) do nothing
  • GIZMO_GT_blank_3d
  • GIZMO_GT_cage_2d

    draw_style : ('BOX', 'CIRCLE') Box = Open cage / Nothing = Closed Cage / Circle = Do nothing

    draw_options : ('XFORM_CENTER_HANDLE') do nothing : Not working, should work with 'BOX' draw_style for open or closed cage.
  • GIZMO_GT_cage_3d

    draw_style : ('BOX', 'CIRCLE') Box = 3D cage 1 handle / Nothing = 3D Cage multiple handles / Circle = Do nothing

    draw_options : ('XFORM_CENTER_HANDLE') do nothing
  • GIZMO_GT_dial_3d

    draw_options : ('CLIP', 'FILL', 'FILL_SELECT', 'ANGLE_MIRROR', 'ANGLE_START_Y', 'ANGLE_VALUE')

    wrap_angle : Bool True : add offset value indefinitely // False : Only add offset for one turn

    arc_inner_factor : 0.5 Add inner circle in middle // 1 = size of outer circle

    arc_partial_angle : Show Partial Dial

    incremental_angle : flt Angle to snap in steps

    click_value : Value to use for a single click action
  • GIZMO_GT_button_2d

    draw_options : {'OUTLINE', 'BACKDROP', 'HELPLINE'}
  • GIZMO_GT_move_3d

    draw_style : ('RING_2D', 'CROSS_2D')

    draw_options : {'FILL', 'FILL_SELECT', 'ALIGN_VIEW'}

    use_snap : Bool
  • GIZMO_GT_primitive_3d

    draw_style = "PLANE" only plane
  • GIZMO_GT_value_2d ??

Thanks a lot for your work.

Event Timeline

Aaron Carlisle (Blendify) lowered the priority of this task from 90 to 50.
Aaron Carlisle (Blendify) moved this task from Backlog to Python API on the Documentation board.
Aaron Carlisle (Blendify) changed the subtype of this task from "Report" to "To Do".