VertexGroup(bpy_struct)

base class — bpy_struct

class bpy.types.VertexGroup(bpy_struct)

Group of vertices, used for armature deform and other purposes

index

Index number of the vertex group (in [0, inf], default 0, readonly)

Type:

int

lock_weight

Maintain the relative weights for the group (default False)

Type:

bool

name

Vertex group name (default “”, never None)

Type:

str

add(index, weight, type)

Add vertices to the group

Parameters:

  • index (Sequence[int]) – List of indices (array of 1 items, in [-inf, inf])

  • weight (float) – Vertex weight (in [0, 1])

  • type (Literal['REPLACE', 'ADD', 'SUBTRACT']) –

    Vertex assign mode

    • REPLACE Replace – Replace.

    • ADD Add – Add.

    • SUBTRACT Subtract – Subtract.

remove(index)

Remove vertices from the group

Parameters:

index (Sequence[int]) – List of indices (array of 1 items, in [-inf, inf])

weight(index)

Get a vertex weight from the group

Parameters:

index (int) – Index, The index of the vertex (in [0, inf])

Returns:

Vertex weight (in [0, 1])

Return type:

float

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

References