KeyBlock Struct Reference

#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 21 of file DNA_key_types.h.

Member Data Documentation

_pad1

char KeyBlock::_pad1[2]

Definition at line 35 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 31 of file DNA_key_types.h.

Referenced by BKE_keyblock_copy_settings(), deform_matrices(), deform_matrices_EM(), key_evaluate_relative(), and ArmatureImporter::make_shape_keys().

data

void* KeyBlock::data

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

Definition at line 47 of file DNA_key_types.h.

Referenced by anim_channels_select_set(), BKE_editlattice_load(), 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_mesh_nomain_to_meshkey(), BKE_object_shapekey_remove(), blo_do_versions_250(), BM_mesh_bm_from_me(), blender::io::usd::create_blend_shapes(), deform_verts(), ED_mesh_join_objects_exec(), blender::bke::get_orco_coords(), blender::io::usd::import_blendshapes(), insert_curvekey(), insert_lattkey(), insert_meshkey(), join_mesh_single(), key_block_get_data(), key_evaluate_relative(), move_shapekey_layers_to_keyblocks(), blender::ed::object::object_shape_key_mirror(), sculpt_update_object(), shapekey_blend_write(), shapekey_copy_data(), blender::ed::sculpt_paint::undo::store_positions_mesh(), switch_endian_keyblock(), um_arraystore_expand(), and blender::ed::sculpt_paint::update_shape_keys().

flag

short KeyBlock::flag

Definition at line 39 of file DNA_key_types.h.

Referenced by acf_shapekey_setting_ptr(), BKE_key_evaluate_object_ex(), click_select_channel_shapekey(), key_evaluate_relative(), make_new_animlistelem(), blender::ed::sculpt_paint::report_if_shape_key_is_locked(), blender::ed::object::shape_key_report_if_active_locked(), and blender::ed::object::shape_key_report_if_locked().

name

char KeyBlock::name[64]

MAX_NAME (unique name, user assigned)

Definition at line 49 of file DNA_key_types.h.

Referenced by acf_shapekey_name(), acf_shapekey_name_prop(), BKE_keyblock_add(), BM_mesh_bm_from_me(), blender::deg::RNANodeQuery::construct_node_identifier(), draw_selected_name(), edbm_blend_from_shape_exec(), GeometryExporter::export_key_mesh(), blender::ed::sculpt_paint::undo::restore_active_shape_key(), and shapekey_adrcodes_to_paths().

next

struct KeyBlock* KeyBlock::next

Definition at line 22 of file DNA_key_types.h.

Referenced by BKE_key_sort(), BKE_keyblock_curve_data_set_with_mat4(), BKE_keyblock_data_get_from_shape(), BKE_keyblock_data_set(), BKE_keyblock_is_basis(), BKE_keyblock_move(), BM_mesh_bm_from_me(), bm_to_mesh_shape(), key_evaluate_relative(), keyblock_get_per_block_weights(), GeometryExporter::operator()(), setkeys(), shapekey_copy_data(), and um_arraystore_expand().

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 29 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(), and setkeys().

prev

struct KeyBlock * KeyBlock::prev

Definition at line 22 of file DNA_key_types.h.

Referenced by BKE_keyblock_move().

relative

short KeyBlock::relative

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

Definition at line 38 of file DNA_key_types.h.

Referenced by BKE_keyblock_copy_settings(), BKE_keyblock_get_dependent_keys(), BKE_keyblock_move(), ED_mesh_join_objects_exec(), edbm_blend_from_shape_exec(), and key_evaluate_relative().

slidermax

float KeyBlock::slidermax

Definition at line 55 of file DNA_key_types.h.

Referenced by BKE_keyblock_add(), and BKE_keyblock_copy_settings().

slidermin

float KeyBlock::slidermin

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

Definition at line 54 of file DNA_key_types.h.

Referenced by BKE_keyblock_add(), and BKE_keyblock_copy_settings().

totelem

int KeyBlock::totelem

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

Definition at line 42 of file DNA_key_types.h.

Referenced by 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_mesh_nomain_to_meshkey(), blo_do_versions_250(), BM_mesh_bm_from_me(), cp_key(), blender::io::usd::create_blend_shapes(), deform_matrices(), deform_matrices_EM(), do_key(), ED_mesh_join_objects_exec(), blender::bke::get_orco_coords(), blender::io::usd::get_shape_key_basis_mesh(), blender::io::usd::import_blendshapes(), insert_curvekey(), insert_lattkey(), insert_meshkey(), key_block_get_data(), key_evaluate_relative(), move_shapekey_layers_to_keyblocks(), blender::ed::object::object_shape_key_mirror(), blender::ed::sculpt_paint::undo::restore_position_mesh(), shapekey_blend_write(), switch_endian_keyblock(), um_arraystore_expand(), and blender::ed::sculpt_paint::update_shape_keys().

type

short KeyBlock::type

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

Definition at line 34 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 44 of file DNA_key_types.h.

Referenced by BKE_keyblock_add(), BM_mesh_bm_from_me(), bm_to_mesh_shape(), bm_to_mesh_shape_layer_index_from_kb(), find_object_active_key_uid(), keyblock_ensure_from_uid(), and move_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 51 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