Blender V5.3
blender::KeyBlock Struct Reference

#include <DNA_key_types.h>

Public Attributes

struct KeyBlock * next = nullptr
struct KeyBlock * prev = nullptr
float pos = 0
float curval = 0
KeyInterpolationType type = KEY_LINEAR
char _pad1 [2] = {}
short relative = 0
KeyBlockFlag flag = {}
int totelem = 0
int uid = 0
void * data = nullptr
char name [64] = ""
char vgroup [64] = ""
float slidermin = 0
float slidermax = 0

Detailed Description

The struct that holds the data for an individual Shape Key. Depending on which object owns the Key, the contained data type can vary (see void *data;).

Definition at line 70 of file DNA_key_types.h.

Member Data Documentation

◆ _pad1

char blender::KeyBlock::_pad1[2] = {}

Definition at line 84 of file DNA_key_types.h.

◆ curval

◆ data

void* blender::KeyBlock::data = nullptr

Array of shape key values, size is (Key::elemsize * KeyBlock->totelem). E.g. meshes use float3.

Definition at line 97 of file DNA_key_types.h.

Referenced by blender::ed::geometry::add_shape_keys_as_attributes(), blender::BKE_curve_transform_ex(), blender::BKE_curve_translate(), blender::BKE_editlattice_load(), blender::BKE_keyblock_convert_from_curve(), blender::BKE_keyblock_convert_from_lattice(), blender::BKE_keyblock_convert_from_mesh(), blender::BKE_keyblock_convert_to_curve(), blender::BKE_keyblock_convert_to_lattice(), blender::BKE_keyblock_convert_to_mesh(), blender::BKE_keyblock_duplicate(), blender::BKE_keyblock_update_from_curve(), blender::BKE_keyblock_update_from_lattice(), blender::BKE_keyblock_update_from_mesh(), blender::BKE_lattice_transform(), blender::BKE_lattice_translate(), blender::BKE_mesh_nomain_to_meshkey(), blender::BKE_object_shapekey_remove(), blender::blo_do_versions_250(), blender::BM_mesh_bm_from_me(), blender::io::usd::create_blend_shapes(), blender::deform_verts(), blender::do_versions_after_linking_280(), blender::ed::sculpt_paint::ShapeKeyData::from_object(), blender::bke::get_orco_coords(), blender::io::fbx::import_blend_shapes(), blender::io::usd::import_blendshapes(), blender::insert_curvekey(), blender::insert_lattkey(), blender::insert_meshkey(), blender::ed::mesh::join_shape_keys(), blender::key_block_get_data(), blender::key_evaluate_relative_float3(), blender::bke::mesh_transform(), blender::bke::mesh_translate(), blender::move_shapekey_layers_to_keyblocks(), blender::multires_reshape_apply_base_update_shape_key(), blender::sculptsession_update(), blender::ed::object::shape_key_apply_to_basis_exec(), blender::ed::object::shape_key_mirror(), blender::shapekey_blend_read_data(), blender::shapekey_blend_write(), blender::shapekey_copy_data(), blender::ed::geometry::store_attributes_to_shape_keys(), blender::ed::sculpt_paint::undo::store_positions_mesh(), blender::switch_keys_direction(), blender::bke::tests::TEST_F(), blender::bke::tests::TEST_F(), blender::bke::tests::TEST_F(), blender::bke::tests::TEST_F(), blender::bke::tests::TEST_F(), blender::um_arraystore_compact(), blender::um_arraystore_expand(), and blender::um_arraystore_expand_clear().

◆ flag

◆ name

◆ next

◆ pos

float blender::KeyBlock::pos = 0

◆ prev

struct KeyBlock * blender::KeyBlock::prev = nullptr

Definition at line 71 of file DNA_key_types.h.

Referenced by blender::BKE_key_sort(), and blender::BKE_keyblock_move().

◆ relative

◆ slidermax

◆ slidermin

float blender::KeyBlock::slidermin = 0

Ranges, for RNA and UI only to clamp 'curval'.

Definition at line 104 of file DNA_key_types.h.

Referenced by blender::BKE_keyblock_add(), blender::BKE_keyblock_copy_settings(), blender::blo_do_versions_250(), and blender::ed::object::shape_key_clear_exec().

◆ totelem

int blender::KeyBlock::totelem = 0

Total number of items in the keyblock (compare with mesh/curve verts to check we match).

Definition at line 91 of file DNA_key_types.h.

Referenced by blender::ed::geometry::add_shape_keys_as_attributes(), blender::BKE_curve_transform_ex(), blender::BKE_curve_translate(), blender::BKE_editlattice_load(), blender::BKE_keyblock_convert_from_curve(), blender::BKE_keyblock_convert_from_lattice(), blender::BKE_keyblock_convert_from_mesh(), blender::BKE_keyblock_convert_to_curve(), blender::BKE_keyblock_convert_to_lattice(), blender::BKE_keyblock_convert_to_mesh(), blender::BKE_keyblock_duplicate(), blender::BKE_keyblock_update_from_curve(), blender::BKE_keyblock_update_from_lattice(), blender::BKE_keyblock_update_from_mesh(), blender::BKE_lattice_transform(), blender::BKE_lattice_translate(), blender::BKE_mesh_nomain_to_meshkey(), blender::blo_do_versions_250(), blender::BM_mesh_bm_from_me(), blender::copy_key_float3(), blender::copy_key_float3_weighted(), blender::io::usd::create_blend_shapes(), blender::deform_matrices(), blender::deform_matrices_EM(), blender::do_versions_after_linking_280(), blender::ed::sculpt_paint::ShapeKeyData::from_object(), blender::bke::get_orco_coords(), blender::io::usd::get_shape_key_basis_mesh(), blender::io::usd::import_blendshapes(), blender::insert_curvekey(), blender::insert_lattkey(), blender::insert_meshkey(), blender::ed::mesh::join_shape_keys(), blender::key_block_get_data(), blender::key_evaluate_absolute(), blender::key_evaluate_relative_float3(), blender::bke::mesh_transform(), blender::bke::mesh_translate(), blender::move_shapekey_layers_to_keyblocks(), blender::ed::object::shape_key_apply_to_basis_exec(), blender::ed::object::shape_key_mirror(), blender::shapekey_blend_read_data(), blender::shapekey_blend_write(), blender::ed::geometry::store_attributes_to_shape_keys(), blender::bke::tests::TEST_F(), blender::bke::tests::TEST_F(), blender::bke::tests::TEST_F(), blender::um_arraystore_compact(), and blender::um_arraystore_expand().

◆ type

KeyInterpolationType blender::KeyBlock::type = KEY_LINEAR

Interpolation type. Used for (Key::type == KEY_NORMAL) only.

Definition at line 83 of file DNA_key_types.h.

Referenced by blender::BKE_keyblock_add(), and blender::BKE_keyblock_copy_settings().

◆ uid

◆ vgroup

char blender::KeyBlock::vgroup[64] = ""

Optional vertex group, array gets allocated into 'weights' when set.

Definition at line 101 of file DNA_key_types.h.

Referenced by blender::BKE_key_evaluate_object_ex(), blender::BKE_keyblock_copy_settings(), and blender::io::fbx::import_blend_shape_full_weights().


The documentation for this struct was generated from the following file: