ShrinkwrapModifier(Modifier)

base classes — bpy_struct, Modifier

class bpy.types.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_keep_above_surface
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.
Type:enum in [‘NEAREST_SURFACEPOINT’, ‘PROJECT’, ‘NEAREST_VERTEX’], default ‘NEAREST_SURFACEPOINT’
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