ObjectGpencilModifiers(bpy_struct)

base class — bpy_struct

class bpy.types.ObjectGpencilModifiers(bpy_struct)

Collection of object grease pencil modifiers

new(name, type)

Add a new greasepencil_modifier

Parameters

  • name (string, (never None)) – New name for the greasepencil_modifier

  • type (enum in ['GP_ARRAY', 'GP_BUILD', 'GP_MIRROR', 'GP_MULTIPLY', 'GP_SIMPLIFY', 'GP_SUBDIV', 'GP_ARMATURE', 'GP_HOOK', 'GP_LATTICE', 'GP_NOISE', 'GP_OFFSET', 'GP_SMOOTH', 'GP_THICK', 'GP_TIME', 'GP_COLOR', 'GP_OPACITY', 'GP_TEXTURE', 'GP_TINT']) –

    Modifier type to add

    • GP_ARRAY Array, Create array of duplicate instances.

    • GP_BUILD Build, Create duplication of strokes.

    • GP_MIRROR Mirror, Duplicate strokes like a mirror.

    • GP_MULTIPLY Multiple Strokes, Produce multiple strokes along one stroke.

    • GP_SIMPLIFY Simplify, Simplify stroke reducing number of points.

    • GP_SUBDIV Subdivide, Subdivide stroke adding more control points.

    • GP_ARMATURE Armature, Deform stroke points using armature object.

    • GP_HOOK Hook, Deform stroke points using objects.

    • GP_LATTICE Lattice, Deform strokes using lattice.

    • GP_NOISE Noise, Add noise to strokes.

    • GP_OFFSET Offset, Change stroke location, rotation or scale.

    • GP_SMOOTH Smooth, Smooth stroke.

    • GP_THICK Thickness, Change stroke thickness.

    • GP_TIME Time Offset, Offset keyframes.

    • GP_COLOR Hue/Saturation, Apply changes to stroke colors.

    • GP_OPACITY Opacity, Opacity of the strokes.

    • GP_TEXTURE Texture Mapping, Change stroke uv texture values.

    • GP_TINT Tint, Tint strokes with new color.

Returns

Newly created modifier

Return type

GpencilModifier

remove(greasepencil_modifier)

Remove an existing greasepencil_modifier from the object

Parameters

greasepencil_modifier (GpencilModifier, (never None)) – Modifier to remove

clear()

Remove all grease pencil modifiers from the object

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