GreasePencilShrinkwrapModifier(Modifier)

base classes — bpy_struct, Modifier

class bpy.types.GreasePencilShrinkwrapModifier(Modifier)

Shrink wrapping modifier to shrink wrap an object to a target

auxiliary_target

Additional mesh target to shrink to

Type:

Object

cull_face

Stop vertices from projecting to a face on the target when facing towards/away (default 'OFF')

Type:

Literal[Shrinkwrap Face Cull Items]

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

offset

Distance to keep from the target (in [-inf, inf], default 0.05)

Type:

float

open_influence_panel

(default False)

Type:

bool

project_limit

Limit the distance used for projection (zero disables) (in [0, inf], default 0.0)

Type:

float

smooth_factor

Amount of smoothing to apply (in [0, 1], default 0.05)

Type:

float

smooth_step

Number of times to apply smooth (high numbers can reduce FPS) (in [1, 10], default 1)

Type:

int

subsurf_levels

Number of subdivisions that must be performed before extracting vertices’ positions and normals (in [0, 6], default 0)

Type:

int

target

Mesh target to shrink to

Type:

Object

tree_node_filter

Layer name (default “”, never None)

Type:

str

use_invert_cull

When projecting in the negative direction invert the face cull mode (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

use_negative_direction

Allow vertices to move in the negative direction of axis (default False)

Type:

bool

use_positive_direction

Allow vertices to move in the positive direction of axis (default True)

Type:

bool

use_project_x

(default False)

Type:

bool

use_project_y

(default False)

Type:

bool

use_project_z

(default False)

Type:

bool

vertex_group_name

Vertex group name for modulating the deform (default “”, never None)

Type:

str

wrap_method

(default 'NEAREST_SURFACEPOINT')

Type:

Literal[Shrinkwrap Type Items]

wrap_mode

Select how vertices are constrained to the target surface (default 'ON_SURFACE')

Type:

Literal[Modifier Shrinkwrap Mode Items]

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