Missing Gizmo information in the API documentation #68709

New Issue

Cédric · 2019-08-15T22:29:18+02:00

Cédric commented

2019-08-15 22:29:18 +02:00

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.

Copy from devtalk : [https:*devtalk.blender.org/t/gizmo-api-documentation-missing-infos/8965](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.

Cédric commented

2019-08-15 22:29:18 +02:00

Added subscriber: @Clarkx

Campbell Barton was assigned by Aaron Carlisle

2019-08-16 23:55:43 +02:00

MACHIN3 commented

2019-09-10 01:01:39 +02:00

Added subscriber: @MACHIN3

Campbell Barton was unassigned by Dalai Felinto

2019-12-23 16:33:17 +01:00

Dalai Felinto commented

2019-12-23 16:33:17 +01:00