HookGpencilModifier(GpencilModifier)

base classes — bpy_struct, GpencilModifier

class bpy.types.HookGpencilModifier(GpencilModifier)

Hook modifier to modify the location of stroke points

center
Type:

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

falloff_curve

Custom falloff curve

Type:

CurveMapping, (readonly)

falloff_radius

If not zero, the distance from the hook where influence ends

Type:

float in [0, inf], default 0.0

falloff_type
Type:

enum in [‘NONE’, ‘CURVE’, ‘SMOOTH’, ‘SPHERE’, ‘ROOT’, ‘INVERSE_SQUARE’, ‘SHARP’, ‘LINEAR’, ‘CONSTANT’], default ‘SMOOTH’

invert_layer_pass

Inverse filter

Type:

boolean, default False

invert_layers

Inverse filter

Type:

boolean, default False

invert_material_pass

Inverse filter

Type:

boolean, default False

invert_materials

Inverse filter

Type:

boolean, default False

invert_vertex

Inverse filter

Type:

boolean, default False

layer

Layer name

Type:

string, default “”, (never None)

layer_pass

Layer pass index

Type:

int in [0, 100], default 0

material

Material used for filtering effect

Type:

Material

matrix_inverse

Reverse the transformation between this object and its target

Type:

mathutils.Matrix 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))

object

Parent Object for hook, also recalculates and clears offset

Type:

Object

pass_index

Pass index

Type:

int in [0, 100], default 0

strength

Relative force of the hook

Type:

float in [0, 1], default 0.5

subtarget

Name of Parent Bone for hook (if applicable), also recalculates and clears offset

Type:

string, default “”, (never None)

use_falloff_uniform

Compensate for non-uniform object scale

Type:

boolean, default False

vertex_group

Vertex group name for modulating the deform

Type:

string, default “”, (never None)

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