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

use_gpu_deform

Deform mesh vertices using the GPU instead of the CPU (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

bpy_struct.id_data Modifier.name Modifier.type Modifier.show_viewport Modifier.show_render Modifier.show_in_editmode Modifier.show_on_cage

Modifier.show_expanded Modifier.is_active Modifier.use_pin_to_last Modifier.is_override_data Modifier.use_apply_on_spline Modifier.execution_time Modifier.persistent_uid

Inherited Functions

bpy_struct.as_pointer bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.id_properties_clear bpy_struct.id_properties_ensure bpy_struct.id_properties_ui bpy_struct.is_property_hidden bpy_struct.is_property_overridable_library bpy_struct.is_property_readonly bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete

bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_from_module bpy_struct.path_resolve bpy_struct.pop bpy_struct.property_overridable_library_set bpy_struct.property_unset bpy_struct.rna_ancestors bpy_struct.type_recast bpy_struct.values Modifier.bl_rna_get_subclass Modifier.bl_rna_get_subclass_py