WaveModifier(Modifier)

base classes — bpy_struct, Modifier

class bpy.types.WaveModifier(Modifier)

Wave effect modifier

damping_time

Number of frames in which the wave damps out after it dies (in [-1.04857e+06, 1.04857e+06], default 10.0)

Type:

float

falloff_radius

Distance after which it fades out (in [0, inf], default 0.0)

Type:

float

height

Height of the wave (in [-inf, inf], default 0.5)

Type:

float

invert_vertex_group

Invert vertex group influence (default False)

Type:

bool

lifetime

Lifetime of the wave in frames, zero means infinite (in [-1.04857e+06, 1.04857e+06], default 0.0)

Type:

float

narrowness

Distance between the top and the base of a wave, the higher the value, the more narrow the wave (in [0, inf], default 1.5)

Type:

float

speed

Speed of the wave, towards the starting point when negative (in [-inf, inf], default 0.25)

Type:

float

start_position_object

Object which defines the wave center

Type:

Object

start_position_x

X coordinate of the start position (in [-inf, inf], default 0.0)

Type:

float

start_position_y

Y coordinate of the start position (in [-inf, inf], default 0.0)

Type:

float

texture
Type:

Texture

texture_coords

(default 'LOCAL')

  • LOCAL Local – Use the local coordinate system for the texture coordinates.

  • GLOBAL Global – Use the global coordinate system for the texture coordinates.

  • OBJECT Object – Use the linked object’s local coordinate system for the texture coordinates.

  • UV UV – Use UV coordinates for the texture coordinates.

Type:

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

texture_coords_bone

Bone to set the texture coordinates (default “”, never None)

Type:

str

texture_coords_object

Object to set the texture coordinates

Type:

Object

time_offset

Either the starting frame (for positive speed) or ending frame (for negative speed) (in [-1.04857e+06, 1.04857e+06], default 0.0)

Type:

float

use_cyclic

Cyclic wave effect (default True)

Type:

bool

use_gpu_deform

Deform mesh vertices using the GPU instead of the CPU (default False)

Type:

bool

use_normal

Displace along normals (default False)

Type:

bool

use_normal_x

Enable displacement along the X normal (default True)

Type:

bool

use_normal_y

Enable displacement along the Y normal (default True)

Type:

bool

use_normal_z

Enable displacement along the Z normal (default True)

Type:

bool

use_x

X axis motion (default True)

Type:

bool

use_y

Y axis motion (default True)

Type:

bool

uv_layer

UV map name (default “”, never None)

Type:

str

vertex_group

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

Type:

str

width

Distance between the waves (in [0, inf], default 1.5)

Type:

float

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