VertexWeightProximityModifier(Modifier)

base classes — bpy_struct, Modifier

class bpy.types.VertexWeightProximityModifier(Modifier)

Set the weights of vertices in a group from a target object’s distance

falloff_type

How weights are mapped to their new values (default 'LINEAR')

  • LINEAR Linear – Null action.

  • CURVE Custom Curve.

  • SHARP Sharp.

  • SMOOTH Smooth.

  • ROOT Root.

  • ICON_SPHERECURVE Sphere.

  • RANDOM Random.

  • STEP Median Step – Map all values below 0.5 to 0.0, and all others to 1.0.

Type:

Literal[‘LINEAR’, ‘CURVE’, ‘SHARP’, ‘SMOOTH’, ‘ROOT’, ‘ICON_SPHERECURVE’, ‘RANDOM’, ‘STEP’]

invert_falloff

Invert the resulting falloff weight (default False)

Type:

bool

invert_mask_vertex_group

Invert vertex group mask influence (default False)

Type:

bool

map_curve

Custom mapping curve (readonly)

Type:

CurveMapping

mask_constant

Global influence of current modifications on vgroup (in [-inf, inf], default 1.0)

Type:

float

mask_tex_map_bone

Which bone to take texture coordinates from (default “”, never None)

Type:

str

mask_tex_map_object

Which object to take texture coordinates from

Type:

Object

mask_tex_mapping

Which texture coordinates to use for mapping (default 'LOCAL')

  • LOCAL Local – Use local generated coordinates.

  • GLOBAL Global – Use global coordinates.

  • OBJECT Object – Use local generated coordinates of another object.

  • UV UV – Use coordinates from a UV layer.

Type:

Literal[‘LOCAL’, ‘GLOBAL’, ‘OBJECT’, ‘UV’]

mask_tex_use_channel

Which texture channel to use for masking (default 'INT')

Type:

Literal[‘INT’, ‘RED’, ‘GREEN’, ‘BLUE’, ‘HUE’, ‘SAT’, ‘VAL’, ‘ALPHA’]

mask_tex_uv_layer

UV map name (default “”, never None)

Type:

str

mask_texture

Masking texture

Type:

Texture

mask_vertex_group

Masking vertex group name (default “”, never None)

Type:

str

max_dist

Distance mapping to weight 1.0 (in [0, inf], default 1.0)

Type:

float

min_dist

Distance mapping to weight 0.0 (in [0, inf], default 0.0)

Type:

float

normalize

Normalize the resulting weights (otherwise they are only clamped within 0.0 to 1.0 range) (default False)

Type:

bool

proximity_geometry

Use the shortest computed distance to target object’s geometry as weight (default {'FACE'})

  • VERTEX Vertex – Compute distance to nearest vertex.

  • EDGE Edge – Compute distance to nearest edge.

  • FACE Face – Compute distance to nearest face.

Type:

set[Literal[‘VERTEX’, ‘EDGE’, ‘FACE’]]

proximity_mode

Which distances to target object to use (default 'GEOMETRY')

  • OBJECT Object – Use distance between affected and target objects.

  • GEOMETRY Geometry – Use distance between affected object’s vertices and target object, or target object’s geometry.

Type:

Literal[‘OBJECT’, ‘GEOMETRY’]

target

Object to calculate vertices distances from

Type:

Object

vertex_group

Vertex group name (default “”, never None)

Type:

str

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