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
- Type
int in [0, inf], default 0, (readonly)
-
lock_weight
¶ Maintain the relative weights for the group
- Type
boolean, default False
-
name
¶ Vertex group name
- Type
string, default “”, (never None)
-
add
(index, weight, type)¶ Add vertices to the group
- Parameters
index (int array of 1 items in [-inf, inf]) – Index List
weight (float in [0, 1]) – Vertex weight
type (enum in ['REPLACE', 'ADD', 'SUBTRACT']) –
Vertex assign mode
REPLACE
Replace, Replace.ADD
Add, Add.SUBTRACT
Subtract, Subtract.
-
remove
(index)¶ Remove a vertex from the group
- Parameters
index (int array of 1 items in [-inf, inf]) – Index List
-
weight
(index)¶ Get a vertex weight from the group
- Parameters
index (int in [0, inf]) – Index, The index of the vertex
- Returns
Vertex weight
- Return type
float in [0, 1]
-
classmethod
bl_rna_get_subclass
(id, default=None)¶ - Parameters
id (string) – The RNA type identifier.
- Returns
The RNA type or default when not found.
- Return type
bpy.types.Struct
subclass
-
classmethod
bl_rna_get_subclass_py
(id, default=None)¶ - Parameters
id (string) – The RNA type identifier.
- Returns
The class or default when not found.
- Return type
type
-
Inherited Properties
Inherited Functions
References