ShapeKey(bpy_struct)

base class — bpy_struct

class bpy.types.ShapeKey(bpy_struct)

Shape key in a shape keys data-block

data

(default None, readonly)

Type:

bpy_prop_collection[UnknownType]

frame

Frame for absolute keys (in [-inf, inf], default 0.0, readonly)

Type:

float

interpolation

Interpolation type for absolute shape keys (default 'KEY_LINEAR')

Type:

Literal[‘KEY_LINEAR’, ‘KEY_CARDINAL’, ‘KEY_CATMULL_ROM’, ‘KEY_BSPLINE’]

lock_shape

Protect the shape key from accidental sculpting and editing (default False)

Type:

bool

mute

Toggle this shape key (default False)

Type:

bool

name

Name of Shape Key (default “”, never None)

Type:

str

points

Optimized access to shape keys point data, when using foreach_get/foreach_set accessors. Warning: Does not support legacy Curve shape keys. (default None, readonly)

Type:

bpy_prop_collection[ShapeKeyPoint]

relative_key

Shape used as a relative key (never None)

Type:

ShapeKey

select

Shape key selection state (default False)

Type:

bool

slider_max

Maximum for slider (in [-10, 10], default 1.0)

Type:

float

slider_min

Minimum for slider (in [-10, 10], default 0.0)

Type:

float

value

Value of shape key at the current frame (in [0, 1], default 0.0)

Type:

float

vertex_group

Vertex weight group, to blend with basis shape (default “”, never None)

Type:

str

normals_vertex_get()

Compute local space vertices’ normals for this shape key

Returns:

normals, (in [-1, 1])

Return type:

float

normals_polygon_get()

Compute local space faces’ normals for this shape key

Returns:

normals, (in [-1, 1])

Return type:

float

normals_split_get()

Compute local space face corners’ normals for this shape key

Returns:

normals, (in [-1, 1])

Return 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

References