Key Struct Reference

#include <DNA_key_types.h>

Public Attributes
ID	id
struct AnimData *	adt
KeyBlock *	refkey
char	elemstr [32]
int	elemsize
char	_pad [4]
ListBase	block
struct Ipo *ipo	DNA_DEPRECATED
ID *	from
int	totkey
short	flag
char	type
char	_pad2
float	ctime
int	uidgen

Detailed Description

Definition at line 65 of file DNA_key_types.h.

Member Data Documentation

_pad

char Key::_pad[4]

Definition at line 89 of file DNA_key_types.h.

_pad2

char Key::_pad2

Definition at line 104 of file DNA_key_types.h.

adt

struct AnimData* Key::adt

Animation data (must be immediately after id for utilities to use it).

Definition at line 73 of file DNA_key_types.h.

block

ListBase Key::block

A list of KeyBlock's.

Definition at line 92 of file DNA_key_types.h.

Referenced by blender::ed::object::add_shapekey_layers(), BKE_curve_transform_ex(), BKE_curve_translate(), BKE_editlattice_load(), BKE_lattice_transform(), BKE_lattice_translate(), BM_mesh_bm_from_me(), calc_shapeKeys(), blender::ed::object::create_applied_mesh_for_modifier(), ED_mesh_join_objects_exec(), edbm_blend_from_shape_exec(), blender::ed::sculpt_paint::ShapeKeyData::from_object(), blender::io::usd::get_shape_key_basis_mesh(), blender::bke::mesh_transform(), blender::bke::mesh_translate(), move_shapekey_layers_to_keyblocks(), object_shapenr_basis_index_ensured(), blender::ed::object::shape_key_lock_exec(), shapekey_copy_data(), switch_keys_direction(), and um_arraystore_expand().

ctime

float Key::ctime

Only used when (Key::type == KEY_NORMAL), this value is used as a time slider, rather than using the scene's time, this value can be animated to give greater control

Definition at line 108 of file DNA_key_types.h.

DNA_DEPRECATED

struct Ipo* ipo Key::DNA_DEPRECATED

Old animation system, deprecated for 2.5.

Definition at line 94 of file DNA_key_types.h.

elemsize

int Key::elemsize

Size of each element in KeyBlock.data, use for allocation and stride.

Definition at line 88 of file DNA_key_types.h.

Referenced by BKE_editlattice_load(), BKE_keyblock_convert_from_curve(), BKE_keyblock_convert_from_lattice(), BKE_mesh_nomain_to_meshkey(), calc_shapeKeys(), um_arraystore_expand(), and um_arraystore_free().

elemstr

char Key::elemstr[32]

This is not a regular string, although it is \0 terminated this is an array of (element_array_size, element_type) pairs (each one char) used for calculating shape key-blocks.

Definition at line 86 of file DNA_key_types.h.

flag

short Key::flag

Definition at line 101 of file DNA_key_types.h.

from

ID* Key::from

Definition at line 96 of file DNA_key_types.h.

Referenced by BKE_lib_override_library_update(), BLO_main_validate_shapekeys(), and gather_local_ids_to_write().

id

ID Key::id

Definition at line 71 of file DNA_key_types.h.

Referenced by BKE_blendfile_library_relocate(), BKE_lib_override_library_create_from_id(), BKE_lib_override_library_create_from_tag(), BKE_lib_override_library_make_local(), BKE_lib_override_library_update(), BKE_mesh_nomain_to_mesh(), blendfile_library_relocate_id_remap(), blendfile_relocate_postprocess_cleanup(), BLO_main_validate_shapekeys(), blender::ed::object::convert_mesh_to_mesh(), curve_copy_data(), blender::io::fbx::gather_animated_properties(), id_delete(), lattice_copy_data(), lib_override_library_create_from(), lib_override_library_resync(), lib_override_prefill_newid_from_existing_overrides(), lib_override_remapper_overrides_add(), mesh_copy_data(), and shapekey_blend_write().

refkey

KeyBlock* Key::refkey

Commonly called 'Basis', (Key::type == KEY_RELATIVE) only. Looks like this is always 'key->block.first', perhaps later on it could be defined as some other KeyBlock - campbell.

Definition at line 80 of file DNA_key_types.h.

Referenced by calc_shapeKeys(), blender::ed::sculpt_paint::ShapeKeyData::from_object(), and shapekey_copy_data().

totkey

int Key::totkey

(totkey == BLI_listbase_count(&key->block)).

Definition at line 99 of file DNA_key_types.h.

Referenced by bmo_mesh_to_bmesh_exec(), ED_mesh_join_objects_exec(), um_arraystore_expand(), and um_arraystore_free().

type

char Key::type

Absolute or relative shape key (ShapekeyContainerType).

Definition at line 103 of file DNA_key_types.h.

Referenced by calc_shapeKeys(), ED_mesh_shapes_join_objects_exec(), and blender::io::fbx::import_blend_shapes().

uidgen

int Key::uidgen

Can never be 0, this is used for detecting old data. current free UID for key-blocks.

Definition at line 114 of file DNA_key_types.h.

Referenced by BM_mesh_bm_from_me().

---

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

• DNA_key_types.h