Lattice(ID)

base classes — bpy_struct, ID

class bpy.types.Lattice(ID)

Lattice data-block defining a grid for deforming other objects

animation_data

Animation data for this data-block (readonly)

Type:

AnimData

interpolation_type_u

(default 'KEY_BSPLINE')

Type:

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

interpolation_type_v

(default 'KEY_BSPLINE')

Type:

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

interpolation_type_w

(default 'KEY_BSPLINE')

Type:

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

is_editmode

True when used in editmode (default False, readonly)

Type:

bool

points

Points of the lattice (default None, readonly)

Type:

bpy_prop_collection[LatticePoint]

points_u

Points in U direction (cannot be changed when there are shape keys) (in [1, 64], default 0)

Type:

int

points_v

Points in V direction (cannot be changed when there are shape keys) (in [1, 64], default 0)

Type:

int

points_w

Points in W direction (cannot be changed when there are shape keys) (in [1, 64], default 0)

Type:

int

shape_keys

(readonly)

Type:

Key

use_outside

Only display and take into account the outer vertices (default False)

Type:

bool

vertex_group

Vertex group to apply the influence of the lattice (default “”, never None)

Type:

str

transform(matrix, *, shape_keys=False)

Transform lattice by a matrix

Parameters:

  • matrix (mathutils.Matrix) – Matrix (multi-dimensional array of 4 * 4 items, in [-inf, inf])

  • shape_keys (bool) – Transform Shape Keys (optional)

update_gpu_tag()

update_gpu_tag

unit_test_compare(*, lattice=None, threshold=7.1526e-06)

unit_test_compare

Parameters:

  • lattice (Lattice) – Lattice to compare to (optional)

  • threshold (float) – Threshold, Comparison tolerance threshold (in [0, inf], optional)

Returns:

Return value, String description of result of comparison (never None)

Return type:

str

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

id (str) – The RNA type identifier.

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.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References