GreasePencilHookModifier(Modifier)

base classes — bpy_struct, Modifier

class bpy.types.GreasePencilHookModifier(Modifier)

Hook modifier to modify the location of stroke points

center

(array of 3 items, in [-inf, inf], default (0.0, 0.0, 0.0))

Type:

bpy_prop_array[float]

custom_curve

Custom curve to apply effect (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_layer_filter

Invert layer filter (default False)

Type:

bool

invert_layer_pass_filter

Invert layer pass filter (default False)

Type:

bool

invert_material_filter

Invert material filter (default False)

Type:

bool

invert_material_pass_filter

Invert material pass filter (default False)

Type:

bool

invert_vertex_group

Invert vertex group weights (default False)

Type:

bool

layer_pass_filter

Layer pass filter (in [0, 100], default 0)

Type:

int

material_filter

Material used for filtering

Type:

Material

material_pass_filter

Material pass (in [0, 100], default 0)

Type:

int

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

open_falloff_panel

(default False)

Type:

bool

open_influence_panel

(default False)

Type:

bool

strength

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

Type:

float

subtarget

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

Type:

str

tree_node_filter

Layer name (default “”, never None)

Type:

str

use_custom_curve

Use a custom curve to define a factor along the strokes (default False)

Type:

bool

use_falloff_uniform

Compensate for non-uniform object scale (default False)

Type:

bool

use_layer_group_filter

Filter by layer group name (default False)

Type:

bool

use_layer_pass_filter

Use layer pass filter (default False)

Type:

bool

use_material_pass_filter

Use material pass filter (default False)

Type:

bool

vertex_group_name

Vertex group name for modulating the deform (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