Mask Editing¶

Quick Reference¶

Hotkey	Operator
`Ctrl-A`	`bpy.ops.mask.select_all()`
`Ctrl-Alt-SELECTMOUSE`	`bpy.ops.mask.add_vertex_slide()`
`Alt-EVT_TWEAK_A`	`bpy.ops.mask.select_lasso()`
`Shift-Alt-EVT_TWEAK_A`	`bpy.ops.mask.select_lasso()`
`Alt-EVT_TWEAK_S`	`bpy.ops.mask.select_border()`
`Shift-Alt-EVT_TWEAK_S`	`bpy.ops.mask.select_border()`
`SELECTMOUSE`	`bpy.ops.mask.slide_point()`
`Ctrl-Shift-SELECTMOUSE`	`bpy.ops.mask.add_feather_vertex_slide()`
`Ctrl-ACTIONMOUSE`	`bpy.ops.uv.cursor_set()`
`Alt-N`	`bpy.ops.mask.new()`
`Shift-A`	`bpy.ops.wm.call_menu()`
`Shift-O`	`bpy.ops.wm.context_cycle_enum()`
`O`	`bpy.ops.wm.context_toggle()`
`Ctrl-ACTIONMOUSE`	`bpy.ops.mask.add_vertex_slide()`
`Shift-ACTIONMOUSE`	`bpy.ops.mask.add_feather_vertex_slide()`
`X`	`bpy.ops.mask.delete()`
`DEL`	`bpy.ops.mask.delete()`
`SELECTMOUSE`	`bpy.ops.mask.select()`
`Shift-SELECTMOUSE`	`bpy.ops.mask.select()`
`A`	`bpy.ops.mask.select_all()`
`Ctrl-I`	`bpy.ops.mask.select_all()`
`Ctrl-L`	`bpy.ops.mask.select_linked()`
`L`	`bpy.ops.mask.select_linked_pick()`
`Shift-L`	`bpy.ops.mask.select_linked_pick()`
`B`	`bpy.ops.mask.select_border()`
`C`	`bpy.ops.mask.select_circle()`
`Ctrl-Alt-EVT_TWEAK_A`	`bpy.ops.mask.select_lasso()`
`Ctrl-Shift-Alt-EVT_TWEAK_A`	`bpy.ops.mask.select_lasso()`
`Ctrl-NUMPAD_PLUS`	`bpy.ops.mask.select_more()`
`Ctrl-NUMPAD_MINUS`	`bpy.ops.mask.select_less()`
`Alt-H`	`bpy.ops.mask.hide_view_clear()`
`H`	`bpy.ops.mask.hide_view_set()`
`Shift-H`	`bpy.ops.mask.hide_view_set()`
`Ctrl-SELECTMOUSE`	`bpy.ops.clip.select()`
`Alt-C`	`bpy.ops.mask.cyclic_toggle()`
`ACTIONMOUSE`	`bpy.ops.mask.slide_spline_curvature()`
`V`	`bpy.ops.mask.handle_type_set()`
`Ctrl-N`	`bpy.ops.mask.normals_make_consistent()`
`Ctrl-P`	`bpy.ops.mask.parent_set()`
`Alt-P`	`bpy.ops.mask.parent_clear()`
`I`	`bpy.ops.mask.shape_key_insert()`
`Alt-I`	`bpy.ops.mask.shape_key_clear()`
`Shift-D`	`bpy.ops.mask.duplicate_move()`
`Ctrl-C`	`bpy.ops.mask.copy_splines()`
`Ctrl-V`	`bpy.ops.mask.paste_splines()`
`G`	`bpy.ops.transform.translate()`
`EVT_TWEAK_S`	`bpy.ops.transform.translate()`
`S`	`bpy.ops.transform.resize()`
`R`	`bpy.ops.transform.rotate()`
`Alt-S`	`bpy.ops.transform.transform()`

Detailed Reference¶

Note

Hotkeys marked with the “(default)” prefix are inherited from the default blender keymap

Ctrl-A → mask.select_all : KEYBOARD → PRESS¶

(De)select All

bpy.ops.mask.select_all(action=’TOGGLE’)

Properties:	Values:
Action	TOGGLE

Ctrl-Alt-SELECTMOUSE → mask.add_vertex_slide : MOUSE → PRESS¶

Add Vertex and Slide

bpy.ops.mask.add_vertex_slide(MASK_OT_add_vertex={“location”:(0, 0)}, MASK_OT_slide_point={“slide_feather”:False, “is_new_point”:False})

Properties:	Values:
Add Vertex	N/A
Slide Point	N/A

Alt-EVT_TWEAK_A → mask.select_lasso : TWEAK → ANY¶

Lasso Select

bpy.ops.mask.select_lasso(path=[], deselect=False, extend=True)

Properties:	Values:
Deselect	False

Shift-Alt-EVT_TWEAK_A → mask.select_lasso : TWEAK → ANY¶

Lasso Select

bpy.ops.mask.select_lasso(path=[], deselect=False, extend=True)

Properties:	Values:
Deselect	True

Alt-EVT_TWEAK_S → mask.select_border : TWEAK → ANY¶

Border Select

bpy.ops.mask.select_border(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0, extend=True)

Properties:	Values:
Extend	False

Shift-Alt-EVT_TWEAK_S → mask.select_border : TWEAK → ANY¶

Border Select

bpy.ops.mask.select_border(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0, extend=True)

Properties:	Values:
Extend	True

SELECTMOUSE → mask.slide_point : MOUSE → PRESS¶

Slide Point

bpy.ops.mask.slide_point(slide_feather=False, is_new_point=False)

Ctrl-Shift-SELECTMOUSE → mask.add_feather_vertex_slide : MOUSE → PRESS¶

Add Feather Vertex and Slide

bpy.ops.mask.add_feather_vertex_slide(MASK_OT_add_feather_vertex={“location”:(0, 0)}, MASK_OT_slide_point={“slide_feather”:False, “is_new_point”:False})

Properties:	Values:
Add Feather Vertex	N/A
Slide Point	N/A

Ctrl-ACTIONMOUSE → uv.cursor_set : MOUSE → PRESS¶

Set 2D Cursor

bpy.ops.uv.cursor_set(location=(0, 0))

(default) Alt-N → mask.new : KEYBOARD → PRESS¶

New Mask

bpy.ops.mask.new(name=””)

(default) Shift-A → wm.call_menu : KEYBOARD → PRESS¶

Call Menu

bpy.ops.wm.call_menu(name=””)

Properties:	Values:
Name	MASK_MT_add

(default) Shift-O → wm.context_cycle_enum : KEYBOARD → PRESS¶

Context Enum Cycle

bpy.ops.wm.context_cycle_enum(data_path=””, reverse=False, wrap=False)

Properties:	Values:
Context Attributes	tool_settings.proportional_edit_falloff
Wrap	True

(default) O → wm.context_toggle : KEYBOARD → PRESS¶

Context Toggle

bpy.ops.wm.context_toggle(data_path=””)

Properties:	Values:
Context Attributes	tool_settings.use_proportional_edit_mask

(default) Ctrl-ACTIONMOUSE → mask.add_vertex_slide : MOUSE → PRESS¶

Add Vertex and Slide

bpy.ops.mask.add_vertex_slide(MASK_OT_add_vertex={“location”:(0, 0)}, MASK_OT_slide_point={“slide_feather”:False, “is_new_point”:False})

Properties:	Values:
Add Vertex	N/A
Slide Point	N/A

(default) Shift-ACTIONMOUSE → mask.add_feather_vertex_slide : MOUSE → PRESS¶

Add Feather Vertex and Slide

bpy.ops.mask.add_feather_vertex_slide(MASK_OT_add_feather_vertex={“location”:(0, 0)}, MASK_OT_slide_point={“slide_feather”:False, “is_new_point”:False})

Properties:	Values:
Add Feather Vertex	N/A
Slide Point	N/A

(default) X → mask.delete : KEYBOARD → PRESS¶

Delete

bpy.ops.mask.delete()

(default) DEL → mask.delete : KEYBOARD → PRESS¶

Delete

bpy.ops.mask.delete()

(default) SELECTMOUSE → mask.select : MOUSE → PRESS¶

Select

bpy.ops.mask.select(extend=False, deselect=False, toggle=False, location=(0, 0))

Properties:	Values:
Extend	False
Deselect	False
Toggle Selection	False

(default) Shift-SELECTMOUSE → mask.select : MOUSE → PRESS¶

Select

bpy.ops.mask.select(extend=False, deselect=False, toggle=False, location=(0, 0))

Properties:	Values:
Extend	False
Deselect	False
Toggle Selection	True

(default) A → mask.select_all : KEYBOARD → PRESS¶

(De)select All

bpy.ops.mask.select_all(action=’TOGGLE’)

Properties:	Values:
Action	TOGGLE

(default) Ctrl-I → mask.select_all : KEYBOARD → PRESS¶

(De)select All

bpy.ops.mask.select_all(action=’TOGGLE’)

Properties:	Values:
Action	INVERT

(default) Ctrl-L → mask.select_linked : KEYBOARD → PRESS¶

Select Linked All

bpy.ops.mask.select_linked()

(default) L → mask.select_linked_pick : KEYBOARD → PRESS¶

Select Linked

bpy.ops.mask.select_linked_pick(deselect=False)

Properties:	Values:
Deselect	False

(default) Shift-L → mask.select_linked_pick : KEYBOARD → PRESS¶

Select Linked

bpy.ops.mask.select_linked_pick(deselect=False)

Properties:	Values:
Deselect	True

(default) B → mask.select_border : KEYBOARD → PRESS¶

Border Select

bpy.ops.mask.select_border(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0, extend=True)

(default) C → mask.select_circle : KEYBOARD → PRESS¶

Circle Select

bpy.ops.mask.select_circle(x=0, y=0, radius=1, gesture_mode=0)

(default) Ctrl-Alt-EVT_TWEAK_A → mask.select_lasso : TWEAK → ANY¶

Lasso Select

bpy.ops.mask.select_lasso(path=[], deselect=False, extend=True)

Properties:	Values:
Deselect	False

(default) Ctrl-Shift-Alt-EVT_TWEAK_A → mask.select_lasso : TWEAK → ANY¶

Lasso Select

bpy.ops.mask.select_lasso(path=[], deselect=False, extend=True)

Properties:	Values:
Deselect	True

(default) Ctrl-NUMPAD_PLUS → mask.select_more : KEYBOARD → PRESS¶

Select More

bpy.ops.mask.select_more()

(default) Ctrl-NUMPAD_MINUS → mask.select_less : KEYBOARD → PRESS¶

Select Less

bpy.ops.mask.select_less()

(default) Alt-H → mask.hide_view_clear : KEYBOARD → PRESS¶

Clear Restrict View

bpy.ops.mask.hide_view_clear()

(default) H → mask.hide_view_set : KEYBOARD → PRESS¶

Set Restrict View

bpy.ops.mask.hide_view_set(unselected=False)

Properties:	Values:
Unselected	False

(default) Shift-H → mask.hide_view_set : KEYBOARD → PRESS¶

Set Restrict View

bpy.ops.mask.hide_view_set(unselected=False)

Properties:	Values:
Unselected	True

(default) Ctrl-SELECTMOUSE → clip.select : MOUSE → PRESS¶

Select

bpy.ops.clip.select(extend=False, location=(0, 0))

Properties:	Values:
Extend	False

(default) Alt-C → mask.cyclic_toggle : KEYBOARD → PRESS¶

Toggle Cyclic

bpy.ops.mask.cyclic_toggle()

(default) ACTIONMOUSE → mask.slide_spline_curvature : MOUSE → PRESS¶

Slide Spline Curvature

bpy.ops.mask.slide_spline_curvature()

(default) V → mask.handle_type_set : KEYBOARD → PRESS¶

Set Handle Type

bpy.ops.mask.handle_type_set(type=’AUTO’)

(default) Ctrl-N → mask.normals_make_consistent : KEYBOARD → PRESS¶

Recalc Normals

bpy.ops.mask.normals_make_consistent()

(default) Ctrl-P → mask.parent_set : KEYBOARD → PRESS¶

Make Parent

bpy.ops.mask.parent_set()

(default) Alt-P → mask.parent_clear : KEYBOARD → PRESS¶

Clear Parent

bpy.ops.mask.parent_clear()

(default) I → mask.shape_key_insert : KEYBOARD → PRESS¶

Insert Shape Key

bpy.ops.mask.shape_key_insert()

(default) Alt-I → mask.shape_key_clear : KEYBOARD → PRESS¶

Clear Shape Key

bpy.ops.mask.shape_key_clear()

(default) Shift-D → mask.duplicate_move : KEYBOARD → PRESS¶

Add Duplicate

bpy.ops.mask.duplicate_move(MASK_OT_duplicate={}, TRANSFORM_OT_translate={“value”:(0, 0, 0), “constraint_axis”:(False, False, False), “constraint_orientation”:’GLOBAL’, “mirror”:False, “proportional”:’DISABLED’, “proportional_edit_falloff”:’SMOOTH’, “proportional_size”:1, “snap”:False, “snap_target”:’CLOSEST’, “snap_point”:(0, 0, 0), “snap_align”:False, “snap_normal”:(0, 0, 0), “gpencil_strokes”:False, “texture_space”:False, “remove_on_cancel”:False, “release_confirm”:False})

Properties:	Values:
Duplicate Mask	N/A
Translate	N/A

(default) Ctrl-C → mask.copy_splines : KEYBOARD → PRESS¶

Copy Splines

bpy.ops.mask.copy_splines()

(default) Ctrl-V → mask.paste_splines : KEYBOARD → PRESS¶

Paste Splines

bpy.ops.mask.paste_splines()

(default) G → transform.translate : KEYBOARD → PRESS¶

Translate

bpy.ops.transform.translate(value=(0, 0, 0), constraint_axis=(False, False, False), constraint_orientation=’GLOBAL’, mirror=False, proportional=’DISABLED’, proportional_edit_falloff=’SMOOTH’, proportional_size=1, snap=False, snap_target=’CLOSEST’, snap_point=(0, 0, 0), snap_align=False, snap_normal=(0, 0, 0), gpencil_strokes=False, texture_space=False, remove_on_cancel=False, release_confirm=False)

(default) EVT_TWEAK_S → transform.translate : TWEAK → ANY¶

Translate

bpy.ops.transform.translate(value=(0, 0, 0), constraint_axis=(False, False, False), constraint_orientation=’GLOBAL’, mirror=False, proportional=’DISABLED’, proportional_edit_falloff=’SMOOTH’, proportional_size=1, snap=False, snap_target=’CLOSEST’, snap_point=(0, 0, 0), snap_align=False, snap_normal=(0, 0, 0), gpencil_strokes=False, texture_space=False, remove_on_cancel=False, release_confirm=False)

(default) S → transform.resize : KEYBOARD → PRESS¶

Resize

bpy.ops.transform.resize(value=(1, 1, 1), constraint_axis=(False, False, False), constraint_orientation=’GLOBAL’, mirror=False, proportional=’DISABLED’, proportional_edit_falloff=’SMOOTH’, proportional_size=1, snap=False, snap_target=’CLOSEST’, snap_point=(0, 0, 0), snap_align=False, snap_normal=(0, 0, 0), gpencil_strokes=False, texture_space=False, remove_on_cancel=False, release_confirm=False)

(default) R → transform.rotate : KEYBOARD → PRESS¶

Rotate

bpy.ops.transform.rotate(value=0, axis=(0, 0, 0), constraint_axis=(False, False, False), constraint_orientation=’GLOBAL’, mirror=False, proportional=’DISABLED’, proportional_edit_falloff=’SMOOTH’, proportional_size=1, snap=False, snap_target=’CLOSEST’, snap_point=(0, 0, 0), snap_align=False, snap_normal=(0, 0, 0), gpencil_strokes=False, release_confirm=False)

(default) Alt-S → transform.transform : KEYBOARD → PRESS¶

Transform

bpy.ops.transform.transform(mode=’TRANSLATION’, value=(0, 0, 0, 0), axis=(0, 0, 0), constraint_axis=(False, False, False), constraint_orientation=’GLOBAL’, mirror=False, proportional=’DISABLED’, proportional_edit_falloff=’SMOOTH’, proportional_size=1, snap=False, snap_target=’CLOSEST’, snap_point=(0, 0, 0), snap_align=False, snap_normal=(0, 0, 0), gpencil_strokes=False, release_confirm=False)

Properties:	Values:
Mode	MASK_SHRINKFATTEN