ShrinkwrapGpencilModifier(GpencilModifier)#

base classes — bpy_struct, GpencilModifier

class bpy.types.ShrinkwrapGpencilModifier(GpencilModifier)#

Shrink wrapping modifier to shrink wrap and 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

Type:

enum in Shrinkwrap Face Cull Items, default ‘OFF’

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

offset#

Distance to keep from the target

Type:

float in [-inf, inf], default 0.05

pass_index#

Pass index

Type:

int in [0, 100], default 0

project_limit#

Limit the distance used for projection (zero disables)

Type:

float in [0, inf], default 0.0

smooth_factor#

Amount of smoothing to apply

Type:

float in [0, 1], default 0.05

smooth_step#

Number of times to apply smooth (high numbers can reduce FPS)

Type:

int in [1, 10], default 1

subsurf_levels#

Number of subdivisions that must be performed before extracting vertices’ positions and normals

Type:

int in [0, 6], default 0

target#

Mesh target to shrink to

Type:

Object

use_invert_cull#

When projecting in the negative direction invert the face cull mode

Type:

boolean, default False

use_negative_direction#

Allow vertices to move in the negative direction of axis

Type:

boolean, default False

use_positive_direction#

Allow vertices to move in the positive direction of axis

Type:

boolean, default True

use_project_x#
Type:

boolean, default False

use_project_y#
Type:

boolean, default False

use_project_z#
Type:

boolean, default False

vertex_group#

Vertex group name for modulating the deform

Type:

string, default “”, (never None)

wrap_method#
Type:

enum in Shrinkwrap Type Items, default ‘NEAREST_SURFACEPOINT’

wrap_mode#

Select how vertices are constrained to the target surface

Type:

enum in Modifier Shrinkwrap Mode Items, default ‘ON_SURFACE’

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#