MaskModifier(Modifier)

base classes — bpy_struct, Modifier

class bpy.types.MaskModifier(Modifier)

Mask modifier to hide parts of the mesh

armature

Armature to use as source of bones to mask

Type:

Object

invert_vertex_group

Use vertices that are not part of region defined (default False)

Type:

bool

mode

(default 'VERTEX_GROUP')

Type:

Literal[‘VERTEX_GROUP’, ‘ARMATURE’]

threshold

Weights over this threshold remain (in [0, 1], default 0.0)

Type:

float

use_smooth

Use vertex group weights to cut faces at the weight contour (default False)

Type:

bool

vertex_group

Vertex group name (default “”, never None)

Type:

str

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:
  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:
  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions