Mask Operators

bpy.ops.mask.add_feather_vertex(location=(0.0, 0.0))

Add vertex to feather

Parameters:location (float array of 2 items in [-inf, inf], (optional)) – Location, Location of vertex in normalized space

bpy.ops.mask.add_feather_vertex_slide(MASK_OT_add_feather_vertex=None, MASK_OT_slide_point=None)

Add new vertex to feather and slide it

Parameters:

• MASK_OT_add_feather_vertex (MASK_OT_add_feather_vertex, (optional)) – Add Feather Vertex, Add vertex to feather
• MASK_OT_slide_point (MASK_OT_slide_point, (optional)) – Slide Point, Slide control points

bpy.ops.mask.add_vertex(location=(0.0, 0.0))

Add vertex to active spline

Parameters:location (float array of 2 items in [-inf, inf], (optional)) – Location, Location of vertex in normalized space

bpy.ops.mask.add_vertex_slide(MASK_OT_add_vertex=None, MASK_OT_slide_point=None)

Add new vertex and slide it

Parameters:

• MASK_OT_add_vertex (MASK_OT_add_vertex, (optional)) – Add Vertex, Add vertex to active spline
• MASK_OT_slide_point (MASK_OT_slide_point, (optional)) – Slide Point, Slide control points

bpy.ops.mask.copy_splines()

Copy selected splines to clipboard

bpy.ops.mask.cyclic_toggle()

Toggle cyclic for selected splines

bpy.ops.mask.delete()

Delete selected control points or splines

bpy.ops.mask.duplicate()

Duplicate selected control points and segments between them

bpy.ops.mask.duplicate_move(MASK_OT_duplicate=None, TRANSFORM_OT_translate=None)

Duplicate mask and move

Parameters:

• MASK_OT_duplicate (MASK_OT_duplicate, (optional)) – Duplicate Mask, Duplicate selected control points and segments between them
• TRANSFORM_OT_translate (TRANSFORM_OT_translate, (optional)) – Translate, Translate (move) selected items

bpy.ops.mask.feather_weight_clear()

Reset the feather weight to zero

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

Set type of handles for selected control points

Parameters:type (enum in [‘AUTO’, ‘VECTOR’, ‘ALIGNED’, ‘ALIGNED_DOUBLESIDE’, ‘FREE’], (optional)) – Type, Spline type

bpy.ops.mask.hide_view_clear()

Reveal the layer by setting the hide flag

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

Hide the layer by setting the hide flag

Parameters:unselected (boolean, (optional)) – Unselected, Hide unselected rather than selected layers

bpy.ops.mask.layer_move(direction='UP')

Move the active layer up/down in the list

Parameters:direction (enum in [‘UP’, ‘DOWN’], (optional)) – Direction, Direction to move the active layer

bpy.ops.mask.layer_new(name="")

Add new mask layer for masking

Parameters:name (string, (optional, never None)) – Name, Name of new mask layer

bpy.ops.mask.layer_remove()

Remove mask layer

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

Create new mask

Parameters:name (string, (optional, never None)) – Name, Name of new mask

bpy.ops.mask.normals_make_consistent()

Re-calculate the direction of selected handles

bpy.ops.mask.parent_clear()

Clear the mask’s parenting

bpy.ops.mask.parent_set()

Set the mask’s parenting

bpy.ops.mask.paste_splines()

Paste splines from clipboard

bpy.ops.mask.primitive_circle_add(size=100.0, location=(0.0, 0.0))

Add new circle-shaped spline

Parameters:

• size (float in [-inf, inf], (optional)) – Size, Size of new circle
• location (float array of 2 items in [-inf, inf], (optional)) – Location, Location of new circle

bpy.ops.mask.primitive_square_add(size=100.0, location=(0.0, 0.0))

Add new square-shaped spline

Parameters:

• size (float in [-inf, inf], (optional)) – Size, Size of new circle
• location (float array of 2 items in [-inf, inf], (optional)) – Location, Location of new circle

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

Select spline points

Parameters:

• extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first
• deselect (boolean, (optional)) – Deselect, Remove from selection
• toggle (boolean, (optional)) – Toggle Selection, Toggle the selection
• location (float array of 2 items in [-inf, inf], (optional)) – Location, Location of vertex in normalized space

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

Change selection of all curve points

Parameters:action (enum in [‘TOGGLE’, ‘SELECT’, ‘DESELECT’, ‘INVERT’], (optional)) –

Action, Selection action to execute

• TOGGLE Toggle, Toggle selection for all elements.
• SELECT Select, Select all elements.
• DESELECT Deselect, Deselect all elements.
• INVERT Invert, Invert selection of all elements.

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

Select curve points using border selection

Parameters:

• gesture_mode (int in [-inf, inf], (optional)) – Gesture Mode
• xmin (int in [-inf, inf], (optional)) – X Min
• xmax (int in [-inf, inf], (optional)) – X Max
• ymin (int in [-inf, inf], (optional)) – Y Min
• ymax (int in [-inf, inf], (optional)) – Y Max
• extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first

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

Select curve points using circle selection

Parameters:

• x (int in [-inf, inf], (optional)) – X
• y (int in [-inf, inf], (optional)) – Y
• radius (int in [-inf, inf], (optional)) – Radius
• gesture_mode (int in [-inf, inf], (optional)) – Gesture Mode

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

Select curve points using lasso selection

Parameters:

• path (bpy_prop_collection of OperatorMousePath, (optional)) – Path
• deselect (boolean, (optional)) – Deselect, Deselect rather than select items
• extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first

bpy.ops.mask.select_less()

Deselect spline points at the boundary of each selection region

bpy.ops.mask.select_linked()

Select all curve points linked to already selected ones

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

(De)select all points linked to the curve under the mouse cursor

Parameters:deselect (boolean, (optional)) – Deselect

bpy.ops.mask.select_more()

Select more spline points connected to initial selection

bpy.ops.mask.shape_key_clear()

Undocumented

bpy.ops.mask.shape_key_feather_reset()

Reset feather weights on all selected points animation values

bpy.ops.mask.shape_key_insert()

Undocumented

bpy.ops.mask.shape_key_rekey(location=True, feather=True)

Recalculate animation data on selected points for frames selected in the dopesheet

Parameters:

• location (boolean, (optional)) – Location
• feather (boolean, (optional)) – Feather

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

Slide control points

Parameters:

• slide_feather (boolean, (optional)) – Slide Feather, First try to slide feather instead of vertex
• is_new_point (boolean, (optional)) – Slide New Point, Newly created vertex is being slid

bpy.ops.mask.slide_spline_curvature()

Slide a point on the spline to define it’s curvature

bpy.ops.mask.switch_direction()

Switch direction of selected splines