HookModifier(Modifier)

base classes — bpy_struct, Modifier

class bpy.types.HookModifier(Modifier)

Hook modifier to modify the location of vertices

center

Center of the hook, used for falloff and display (array of 3 items, in [-inf, inf], default (0.0, 0.0, 0.0))

Type:

mathutils.Vector

falloff_curve

Custom falloff curve (readonly)

Type:

CurveMapping

falloff_radius

If not zero, the distance from the hook where influence ends (in [0, inf], default 0.0)

Type:

float

falloff_type

(default 'SMOOTH')

Type:

Literal[‘NONE’, ‘CURVE’, ‘SMOOTH’, ‘SPHERE’, ‘ROOT’, ‘INVERSE_SQUARE’, ‘SHARP’, ‘LINEAR’, ‘CONSTANT’]

invert_vertex_group

Invert vertex group influence (default False)

Type:

bool

matrix_inverse

Reverse the transformation between this object and its target (multi-dimensional array of 4 * 4 items, in [-inf, inf], default ((1.0, 0.0, 0.0, 0.0), (0.0, 1.0, 0.0, 0.0), (0.0, 0.0, 1.0, 0.0), (0.0, 0.0, 0.0, 1.0)))

Type:

mathutils.Matrix

object

Parent Object for hook, also recalculates and clears offset

Type:

Object

strength

Relative force of the hook (in [0, 1], default 1.0)

Type:

float

subtarget

Name of Parent Bone for hook (if applicable), also recalculates and clears offset (default “”, never None)

Type:

str

use_falloff_uniform

Compensate for non-uniform object scale (default False)

Type:

bool

vertex_group

Name of Vertex Group which determines influence of modifier per point (default “”, never None)

Type:

str

vertex_indices

Indices of vertices bound to the modifier. For Bézier curves, handles count as additional vertices. (array of 64 items, in [0, inf], default (0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0), readonly)

Type:

bpy_prop_array[int]

vertex_indices_set(indices)

Validates and assigns the array of vertex indices bound to the modifier

Parameters:

indices (Sequence[int]) – Vertex Indices (array of 64 items, in [-inf, inf])

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