ShrinkwrapModifier(Modifier)

base classes — bpy_struct, Modifier

class bpy.types.ShrinkwrapModifier.ShrinkwrapModifier(Modifier)

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

  • OFF Off, No culling.

  • FRONT Front, No projection when in front of the face.

  • BACK Back, No projection when behind the face.

Type

enum in [‘OFF’, ‘FRONT’, ‘BACK’], default ‘OFF’

invert_vertex_group

Invert vertex group influence

Type

boolean, default False

offset

Distance to keep from the target

Type

float in [-inf, inf], default 0.0

project_limit

Limit the distance used for projection (zero disables)

Type

float in [0, inf], default 0.0

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 False

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

Type

string, default “”, (never None)

wrap_method
  • NEAREST_SURFACEPOINT Nearest Surface Point, Shrink the mesh to the nearest target surface.

  • PROJECT Project, Shrink the mesh to the nearest target surface along a given axis.

  • NEAREST_VERTEX Nearest Vertex, Shrink the mesh to the nearest target vertex.

  • TARGET_PROJECT Target Normal Project, Shrink the mesh to the nearest target surface along the interpolated vertex normals of the target.

Type

enum in [‘NEAREST_SURFACEPOINT’, ‘PROJECT’, ‘NEAREST_VERTEX’, ‘TARGET_PROJECT’], default ‘NEAREST_SURFACEPOINT’

wrap_mode

Select how vertices are constrained to the target surface

  • ON_SURFACE On Surface, The point is constrained to the surface of the target object, with distance offset towards the original point location.

  • INSIDE Inside, The point is constrained to be inside the target object.

  • OUTSIDE Outside, The point is constrained to be outside the target object.

  • OUTSIDE_SURFACE Outside Surface, The point is constrained to the surface of the target object, with distance offset always to the outside, towards or away from the original location.

  • ABOVE_SURFACE Above Surface, The point is constrained to the surface of the target object, with distance offset applied exactly along the target normal.

Type

enum in [‘ON_SURFACE’, ‘INSIDE’, ‘OUTSIDE’, ‘OUTSIDE_SURFACE’, ‘ABOVE_SURFACE’], 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

  • bpy_struct.id_data

  • Modifier.name

  • Modifier.type

  • Modifier.show_viewport

  • Modifier.show_render

  • Modifier.show_in_editmode

  • Modifier.show_on_cage

  • Modifier.show_expanded

  • Modifier.use_apply_on_spline

Inherited Functions

  • bpy_struct.as_pointer

  • bpy_struct.driver_add

  • bpy_struct.driver_remove

  • bpy_struct.get

  • bpy_struct.is_property_hidden

  • bpy_struct.is_property_overridable_library

  • bpy_struct.is_property_readonly

  • bpy_struct.is_property_set

  • bpy_struct.items

  • bpy_struct.keyframe_delete

  • bpy_struct.keyframe_insert

  • bpy_struct.keys

  • bpy_struct.path_from_id

  • bpy_struct.path_resolve

  • bpy_struct.pop

  • bpy_struct.property_overridable_library_set

  • bpy_struct.property_unset

  • bpy_struct.type_recast

  • bpy_struct.values

  • Modifier.bl_rna_get_subclass

  • Modifier.bl_rna_get_subclass_py