Blender: KeyBlock Struct Reference

Blender V2.93

#include <DNA_key_types.h>

Public Attributes
struct KeyBlock *	next

struct KeyBlock *	prev

float	pos

float	curval

short	type

char	_pad1 [2]

short	relative

short	flag

int	totelem

int	uid

void *	data

char	name [64]

char	vgroup [64]

float	slidermin

float	slidermax

Detailed Description

Definition at line 40 of file DNA_key_types.h.

Member Data Documentation

◆ _pad1

char KeyBlock::_pad1[2]

Definition at line 54 of file DNA_key_types.h.

◆ curval

float KeyBlock::curval

influence (typically [0 - 1] but can be more), (Key->type == KEY_RELATIVE) only.

Definition at line 50 of file DNA_key_types.h.

Referenced by BKE_keyblock_copy_settings(), deformMatrices(), deformMatricesEM(), key_evaluate_relative(), ArmatureImporter::make_shape_keys(), and shape_key_clear_exec().

◆ data

void* KeyBlock::data

array of shape key values, size is (Key->elemsize * KeyBlock->totelem)

Definition at line 66 of file DNA_key_types.h.

Referenced by add_shapekey_layers(), BKE_editlattice_load(), BKE_key_free_nolib(), BKE_keyblock_convert_from_curve(), BKE_keyblock_convert_from_lattice(), BKE_keyblock_convert_from_mesh(), BKE_keyblock_convert_from_vertcos(), BKE_keyblock_convert_to_curve(), BKE_keyblock_convert_to_lattice(), BKE_keyblock_convert_to_mesh(), BKE_keyblock_convert_to_vertcos(), BKE_keyblock_update_from_curve(), BKE_keyblock_update_from_lattice(), BKE_keyblock_update_from_mesh(), BKE_keyblock_update_from_offset(), BKE_keyblock_update_from_vertcos(), BKE_lattice_transform(), BKE_lattice_translate(), BKE_mesh_nomain_to_meshkey(), BKE_mesh_transform(), BKE_mesh_translate(), BKE_object_shapekey_remove(), blo_do_versions_250(), BM_mesh_bm_from_me(), BM_mesh_bm_to_me(), deformVerts(), ED_mesh_join_objects_exec(), get_orco_coords(), insert_curvekey(), insert_lattkey(), insert_meshkey(), join_mesh_single(), key_block_get_data(), key_evaluate_relative(), object_shape_key_mirror(), shapekey_blend_write(), shapekey_copy_data(), shapekey_free_data(), shapekey_layers_to_keyblocks(), switch_endian_keyblock(), um_arraystore_compact_ex(), um_arraystore_expand(), and undomesh_to_editmesh().

◆ flag

short KeyBlock::flag

Definition at line 58 of file DNA_key_types.h.

Referenced by acf_shapekey_setting_ptr(), BKE_key_evaluate_object_ex(), click_select_channel_shapekey(), key_evaluate_relative(), and make_new_animlistelem().

◆ name

char KeyBlock::name[64]

MAX_NAME (unique name, user assigned)

Definition at line 68 of file DNA_key_types.h.

Referenced by acf_shapekey_name(), acf_shapekey_name_prop(), add_shapekey_layers(), animdata_filter_shapekey(), BKE_keyblock_add(), blo_do_versions_pre250(), BM_mesh_bm_from_me(), blender::deg::RNANodeQuery::construct_node_identifier(), draw_selected_name(), ED_mesh_join_objects_exec(), edbm_blend_from_shape_exec(), GeometryExporter::export_key_mesh(), SCULPT_undo_push_node(), sculpt_undo_restore_coords(), shapekey_adrcodes_to_paths(), and shapekey_layers_to_keyblocks().

◆ next

◆ pos

float KeyBlock::pos

point in time (Key->type == KEY_NORMAL) only, for historic reasons this is relative to (Key->ctime / 100), so this value increments by 0.1f per frame.

Definition at line 48 of file DNA_key_types.h.

Referenced by BKE_key_sort(), BKE_keyblock_add(), BKE_keyblock_add_ctime(), BKE_keyblock_copy_settings(), BKE_keyblock_move(), setkeys(), and shape_key_retime_exec().

◆ prev

struct KeyBlock * KeyBlock::prev

Definition at line 41 of file DNA_key_types.h.

Referenced by BKE_key_sort(), and BKE_keyblock_move().

◆ relative

short KeyBlock::relative

relative == 0 means first key is reference, otherwise the index of Key->blocks

Definition at line 57 of file DNA_key_types.h.

Referenced by BKE_keyblock_copy_settings(), BKE_keyblock_is_basis(), BKE_keyblock_move(), BKE_object_shapekey_remove(), BM_mesh_bm_to_me(), ED_mesh_join_objects_exec(), edbm_blend_from_shape_exec(), key_evaluate_relative(), and SCULPT_vertcos_to_key().

◆ slidermax

float KeyBlock::slidermax

Definition at line 74 of file DNA_key_types.h.

Referenced by BKE_keyblock_add(), BKE_keyblock_copy_settings(), and blo_do_versions_250().

◆ slidermin

float KeyBlock::slidermin

ranges, for RNA and UI only to clamp 'curval'

Definition at line 73 of file DNA_key_types.h.

Referenced by BKE_keyblock_add(), BKE_keyblock_copy_settings(), and blo_do_versions_250().

◆ totelem

int KeyBlock::totelem

total number if items in the keyblock (compare with mesh/curve verts to check we match)

Definition at line 61 of file DNA_key_types.h.

Referenced by add_shapekey_layers(), BKE_editlattice_load(), BKE_keyblock_convert_from_curve(), BKE_keyblock_convert_from_lattice(), BKE_keyblock_convert_from_mesh(), BKE_keyblock_convert_to_curve(), BKE_keyblock_convert_to_lattice(), BKE_keyblock_convert_to_mesh(), BKE_keyblock_update_from_curve(), BKE_keyblock_update_from_lattice(), BKE_keyblock_update_from_mesh(), BKE_keyblock_update_from_offset(), BKE_keyblock_update_from_vertcos(), BKE_lattice_transform(), BKE_lattice_translate(), BKE_mesh_nomain_to_meshkey(), BKE_mesh_transform(), BKE_mesh_translate(), blo_do_versions_250(), BM_mesh_bm_from_me(), BM_mesh_bm_to_me(), cp_key(), deformMatrices(), deformMatricesEM(), do_key(), ED_mesh_join_objects_exec(), insert_curvekey(), insert_lattkey(), insert_meshkey(), key_block_get_data(), key_evaluate_relative(), object_shape_key_mirror(), sculpt_undo_restore_coords(), shapekey_blend_write(), shapekey_layers_to_keyblocks(), switch_endian_keyblock(), um_arraystore_compact_ex(), um_arraystore_expand(), and undomesh_to_editmesh().

◆ type

short KeyBlock::type

interpolation type (Key->type == KEY_NORMAL) only.

Definition at line 53 of file DNA_key_types.h.

Referenced by BKE_keyblock_add(), and BKE_keyblock_copy_settings().

◆ uid

int KeyBlock::uid

for meshes only, match the unique number with the customdata layer

Definition at line 63 of file DNA_key_types.h.

Referenced by add_shapekey_layers(), BKE_keyblock_add(), BKE_mesh_nomain_to_mesh(), BM_mesh_bm_from_me(), BM_mesh_bm_to_me(), bm_to_mesh_shape_layer_index_from_kb(), and shapekey_layers_to_keyblocks().

◆ vgroup

char KeyBlock::vgroup[64]

MAX_VGROUP_NAME (optional vertex group), array gets allocated into 'weights' when set

Definition at line 70 of file DNA_key_types.h.

Referenced by BKE_key_evaluate_object_ex(), BKE_keyblock_copy_settings(), and keyblock_get_per_block_weights().

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

DNA_key_types.h