DisplaceModifier(Modifier)

base classes — bpy_struct, Modifier

class bpy.types.DisplaceModifier(Modifier)

Displacement modifier

direction

(default 'NORMAL')

  • X X – Use the texture’s intensity value to displace in the X direction.

  • Y Y – Use the texture’s intensity value to displace in the Y direction.

  • Z Z – Use the texture’s intensity value to displace in the Z direction.

  • NORMAL Normal – Use the texture’s intensity value to displace along the vertex normal.

  • CUSTOM_NORMAL Custom Normal – Use the texture’s intensity value to displace along the (averaged) custom normal (falls back to vertex).

  • RGB_TO_XYZ RGB to XYZ – Use the texture’s RGB values to displace the mesh in the XYZ direction.

Type:

Literal[‘X’, ‘Y’, ‘Z’, ‘NORMAL’, ‘CUSTOM_NORMAL’, ‘RGB_TO_XYZ’]

invert_vertex_group

Invert vertex group influence (default False)

Type:

bool

mid_level

Material value that gives no displacement (in [-inf, inf], default 0.5)

Type:

float

space

(default 'LOCAL')

  • LOCAL Local – Direction is defined in local coordinates.

  • GLOBAL Global – Direction is defined in global coordinates.

Type:

Literal[‘LOCAL’, ‘GLOBAL’]

strength

Amount to displace geometry (in [-inf, inf], default 1.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

use_gpu_deform

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

Type:

bool

uv_layer

UV map name (default “”, never None)

Type:

str

vertex_group

Name of Vertex Group which determines influence of modifier per point (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