Blender V4.3
BKE_key.hh File Reference
#include <optional>
#include <string>
#include "BLI_array.hh"

Go to the source code of this file.

Functions

void BKE_key_free_data (Key *key)
 
void BKE_key_free_nolib (Key *key)
 
KeyBKE_key_add (Main *bmain, ID *id)
 
void BKE_key_sort (Key *key)
 
void key_curve_position_weights (float t, float data[4], int type)
 
void key_curve_tangent_weights (float t, float data[4], int type)
 
void key_curve_normal_weights (float t, float data[4], int type)
 
floatBKE_key_evaluate_object_ex (Object *ob, int *r_totelem, float *arr, size_t arr_size, ID *obdata)
 
floatBKE_key_evaluate_object (Object *ob, int *r_totelem)
 
int BKE_keyblock_element_count_from_shape (const Key *key, int shape_index)
 
int BKE_keyblock_element_count (const Key *key)
 
size_t BKE_keyblock_element_calc_size_from_shape (const Key *key, int shape_index)
 
size_t BKE_keyblock_element_calc_size (const Key *key)
 
bool BKE_key_idtype_support (short id_type)
 
Key ** BKE_key_from_id_p (ID *id)
 
KeyBKE_key_from_id (ID *id)
 
Key ** BKE_key_from_object_p (Object *ob)
 
KeyBKE_key_from_object (Object *ob)
 
KeyBlockBKE_keyblock_from_object (Object *ob)
 
KeyBlockBKE_keyblock_from_object_reference (Object *ob)
 
KeyBlockBKE_keyblock_add (Key *key, const char *name)
 
KeyBlockBKE_keyblock_add_ctime (Key *key, const char *name, bool do_force)
 
KeyBlockBKE_keyblock_find_by_index (Key *key, int index)
 
KeyBlockBKE_keyblock_find_name (Key *key, const char name[])
 
KeyBlockBKE_keyblock_find_uid (Key *key, int uid)
 
void BKE_keyblock_copy_settings (KeyBlock *kb_dst, const KeyBlock *kb_src)
 copy shape-key attributes, but not key data or name/UID.
 
std::optional< std::string > BKE_keyblock_curval_rnapath_get (const Key *key, const KeyBlock *kb)
 
void BKE_keyblock_update_from_lattice (const Lattice *lt, KeyBlock *kb)
 
void BKE_keyblock_convert_from_lattice (const Lattice *lt, KeyBlock *kb)
 
void BKE_keyblock_convert_to_lattice (const KeyBlock *kb, Lattice *lt)
 
int BKE_keyblock_curve_element_count (const ListBase *nurb)
 
void BKE_keyblock_curve_data_transform (const ListBase *nurb, const float mat[4][4], const void *src, void *dst)
 
void BKE_keyblock_update_from_curve (const Curve *cu, KeyBlock *kb, const ListBase *nurb)
 
void BKE_keyblock_convert_from_curve (const Curve *cu, KeyBlock *kb, const ListBase *nurb)
 
void BKE_keyblock_convert_to_curve (KeyBlock *kb, Curve *cu, ListBase *nurb)
 
void BKE_keyblock_update_from_mesh (const Mesh *mesh, KeyBlock *kb)
 
void BKE_keyblock_convert_from_mesh (const Mesh *mesh, const Key *key, KeyBlock *kb)
 
void BKE_keyblock_convert_to_mesh (const KeyBlock *kb, float(*vert_positions)[3], int totvert)
 
void BKE_keyblock_mesh_calc_normals (const KeyBlock *kb, Mesh *mesh, float(*r_vert_normals)[3], float(*r_face_normals)[3], float(*r_loop_normals)[3])
 
void BKE_keyblock_update_from_vertcos (const Object *ob, KeyBlock *kb, const float(*vertCos)[3])
 
void BKE_keyblock_convert_from_vertcos (const Object *ob, KeyBlock *kb, const float(*vertCos)[3])
 
float(* BKE_keyblock_convert_to_vertcos (const Object *ob, const KeyBlock *kb))[3]
 
void BKE_keyblock_update_from_offset (const Object *ob, KeyBlock *kb, const float(*ofs)[3])
 
bool BKE_keyblock_move (Object *ob, int org_index, int new_index)
 
bool BKE_keyblock_is_basis (const Key *key, int index)
 
std::optional< blender::Array< bool > > BKE_keyblock_get_dependent_keys (const Key *key, int index)
 
Key-Block Data Access
void BKE_keyblock_data_get_from_shape (const Key *key, float(*arr)[3], int shape_index)
 
void BKE_keyblock_data_get (const Key *key, float(*arr)[3])
 
void BKE_keyblock_data_set_with_mat4 (Key *key, int shape_index, const float(*coords)[3], const float mat[4][4])
 
void BKE_keyblock_curve_data_set_with_mat4 (Key *key, const ListBase *nurb, int shape_index, const void *data, const float mat[4][4])
 
void BKE_keyblock_data_set (Key *key, int shape_index, const void *data)
 

Function Documentation

◆ BKE_key_add()

◆ BKE_key_evaluate_object()

float * BKE_key_evaluate_object ( Object * ob,
int * r_totelem )

◆ BKE_key_evaluate_object_ex()

◆ BKE_key_free_data()

void BKE_key_free_data ( Key * key)

Free (or release) any data used by this shape-key (does not free the key itself).

Definition at line 241 of file key.cc.

References Key::id, and shapekey_free_data().

Referenced by undomesh_free_data().

◆ BKE_key_free_nolib()

void BKE_key_free_nolib ( Key * key)

Definition at line 246 of file key.cc.

References BLI_pophead(), Key::block, and MEM_freeN().

◆ BKE_key_from_id()

◆ BKE_key_from_id_p()

◆ BKE_key_from_object()

◆ BKE_key_from_object_p()

Key ** BKE_key_from_object_p ( Object * ob)

Definition at line 1811 of file key.cc.

References BKE_key_from_id_p(), and Object::data.

Referenced by BKE_key_from_object(), and BKE_object_shapekey_free().

◆ BKE_key_idtype_support()

bool BKE_key_idtype_support ( short id_type)

Definition at line 1763 of file key.cc.

References ID_CU_LEGACY, ID_LT, and ID_ME.

Referenced by BLO_main_validate_shapekeys().

◆ BKE_key_sort()

void BKE_key_sort ( Key * key)

Sort shape keys after a change. This assumes that at most one key was moved, which is a valid assumption for the places it's currently being called.

Definition at line 308 of file key.cc.

References BLI_insertlinkafter(), BLI_remlink(), Key::block, ListBase::first, LISTBASE_FOREACH, KeyBlock::next, KeyBlock::pos, and Key::refkey.

Referenced by BKE_keyblock_add_ctime(), and ED_mesh_join_objects_exec().

◆ BKE_keyblock_add()

◆ BKE_keyblock_add_ctime()

KeyBlock * BKE_keyblock_add_ctime ( Key * key,
const char * name,
bool do_force )
Note
sorting is a problematic side effect in some cases, better only do this explicitly by having its own function,
Parameters
keyThe key datablock to add to.
nameOptional name for the new keyblock.
do_forcealways use ctime even for relative keys.

Definition at line 1878 of file key.cc.

References BKE_key_sort(), BKE_keyblock_add(), Key::block, compare_ff(), Key::ctime, KEY_RELATIVE, LISTBASE_FOREACH, KeyBlock::pos, and Key::type.

Referenced by insert_curvekey(), insert_lattkey(), insert_meshkey(), and ArmatureImporter::make_shape_keys().

◆ BKE_keyblock_convert_from_curve()

void BKE_keyblock_convert_from_curve ( const Curve * cu,
KeyBlock * kb,
const ListBase * nurb )

◆ BKE_keyblock_convert_from_lattice()

void BKE_keyblock_convert_from_lattice ( const Lattice * lt,
KeyBlock * kb )

◆ BKE_keyblock_convert_from_mesh()

◆ BKE_keyblock_convert_from_vertcos()

◆ BKE_keyblock_convert_to_curve()

void BKE_keyblock_convert_to_curve ( KeyBlock * kb,
Curve * cu,
ListBase * nurb )

◆ BKE_keyblock_convert_to_lattice()

void BKE_keyblock_convert_to_lattice ( const KeyBlock * kb,
Lattice * lt )

◆ BKE_keyblock_convert_to_mesh()

◆ BKE_keyblock_convert_to_vertcos()

◆ BKE_keyblock_copy_settings()

void BKE_keyblock_copy_settings ( KeyBlock * kb_dst,
const KeyBlock * kb_src )

copy shape-key attributes, but not key data or name/UID.

Definition at line 1947 of file key.cc.

References KeyBlock::curval, KeyBlock::pos, KeyBlock::relative, KeyBlock::slidermax, KeyBlock::slidermin, STRNCPY, KeyBlock::type, and KeyBlock::vgroup.

Referenced by ED_mesh_join_objects_exec().

◆ BKE_keyblock_curval_rnapath_get()

std::optional< std::string > BKE_keyblock_curval_rnapath_get ( const Key * key,
const KeyBlock * kb )

Get RNA-Path for 'value' setting of the given shape-key.

Note
the user needs to free the returned string once they're finished with it.

Definition at line 1958 of file key.cc.

References ELEM, Key::id, ptr, RNA_path_from_ID_to_property(), RNA_pointer_create(), and RNA_struct_find_property().

Referenced by achannel_setting_slider_shapekey_cb(), ANIM_channel_draw_widgets(), and make_new_animlistelem().

◆ BKE_keyblock_curve_data_set_with_mat4()

void BKE_keyblock_curve_data_set_with_mat4 ( Key * key,
const ListBase * nurb,
int shape_index,
const void * data,
const float mat[4][4] )

Set the data for all key-blocks (or shape_index if != -1), transforming by mat.

Definition at line 1733 of file key.cc.

References BKE_keyblock_curve_data_transform(), Key::block, data, ELEM, Key::elemsize, ListBase::first, and KeyBlock::next.

Referenced by blender::ed::object::data_xform_by_mat4().

◆ BKE_keyblock_curve_data_transform()

void BKE_keyblock_curve_data_transform ( const ListBase * nurb,
const float mat[4][4],
const void * src,
void * dst )

◆ BKE_keyblock_curve_element_count()

◆ BKE_keyblock_data_get()

void BKE_keyblock_data_get ( const Key * key,
float(*) arr[3] )

Definition at line 1701 of file key.cc.

References BKE_keyblock_data_get_from_shape().

◆ BKE_keyblock_data_get_from_shape()

void BKE_keyblock_data_get_from_shape ( const Key * key,
float(*) arr[3],
int shape_index )
Parameters
shape_indexThe index to use or all (when -1).

Definition at line 1686 of file key.cc.

References Key::block, ELEM, Key::elemsize, ListBase::first, and KeyBlock::next.

Referenced by BKE_keyblock_data_get(), and blender::ed::object::data_xform_create_ex().

◆ BKE_keyblock_data_set()

void BKE_keyblock_data_set ( Key * key,
int shape_index,
const void * data )

Set the data for all key-blocks (or shape_index if != -1).

Definition at line 1748 of file key.cc.

References Key::block, data, ELEM, Key::elemsize, ListBase::first, and KeyBlock::next.

Referenced by blender::ed::object::data_xform_restore().

◆ BKE_keyblock_data_set_with_mat4()

void BKE_keyblock_data_set_with_mat4 ( Key * key,
int shape_index,
const float(*) coords[3],
const float mat[4][4] )

Set the data to all key-blocks (or shape_index if != -1).

Definition at line 1706 of file key.cc.

References BLI_assert_msg, Key::block, ELEM, Key::elemsize, ListBase::first, float, and mul_v3_m4v3().

Referenced by blender::ed::object::data_xform_by_mat4().

◆ BKE_keyblock_element_calc_size()

size_t BKE_keyblock_element_calc_size ( const Key * key)

Definition at line 1674 of file key.cc.

References BKE_keyblock_element_calc_size_from_shape().

◆ BKE_keyblock_element_calc_size_from_shape()

size_t BKE_keyblock_element_calc_size_from_shape ( const Key * key,
int shape_index )
Parameters
shape_indexThe index to use or all (when -1).

Definition at line 1669 of file key.cc.

References BKE_keyblock_element_count_from_shape(), and Key::elemsize.

Referenced by BKE_keyblock_element_calc_size(), and blender::ed::object::data_xform_create_ex().

◆ BKE_keyblock_element_count()

int BKE_keyblock_element_count ( const Key * key)

Definition at line 1664 of file key.cc.

References BKE_keyblock_element_count_from_shape().

◆ BKE_keyblock_element_count_from_shape()

int BKE_keyblock_element_count_from_shape ( const Key * key,
int shape_index )
Parameters
shape_indexThe index to use or all (when -1).

Definition at line 1650 of file key.cc.

References Key::block, ELEM, ListBase::first, and result.

Referenced by BKE_keyblock_element_calc_size_from_shape(), and BKE_keyblock_element_count().

◆ BKE_keyblock_find_by_index()

KeyBlock * BKE_keyblock_find_by_index ( Key * key,
int index )

◆ BKE_keyblock_find_name()

KeyBlock * BKE_keyblock_find_name ( Key * key,
const char name[] )

Get the appropriate KeyBlock given a name to search for.

Definition at line 1932 of file key.cc.

References BLI_findstring(), Key::block, and offsetof.

Referenced by ED_mesh_join_objects_exec(), edbm_blend_from_shape_exec(), join_mesh_single(), and blender::ed::sculpt_paint::undo::restore_active_shape_key().

◆ BKE_keyblock_find_uid()

KeyBlock * BKE_keyblock_find_uid ( Key * key,
int uid )

Definition at line 1937 of file key.cc.

References Key::block, and LISTBASE_FOREACH.

Referenced by keyblock_ensure_from_uid().

◆ BKE_keyblock_from_object()

◆ BKE_keyblock_from_object_reference()

KeyBlock * BKE_keyblock_from_object_reference ( Object * ob)

Definition at line 1912 of file key.cc.

References BKE_key_from_object(), and Key::refkey.

◆ BKE_keyblock_get_dependent_keys()

std::optional< blender::Array< bool > > BKE_keyblock_get_dependent_keys ( const Key * key,
int index )

Returns a newly allocated array containing true for every key that has this one as basis. If none are found, returns null.

Definition at line 2578 of file key.cc.

References BLI_listbase_count(), Key::block, count, KEY_RELATIVE, LISTBASE_FOREACH_INDEX, KeyBlock::relative, and Key::type.

Referenced by bm_to_mesh_shape(), calc_shapeKeys(), blender::ed::sculpt_paint::PositionDeformData::PositionDeformData(), blender::ed::sculpt_paint::update_shape_keys(), and blender::ed::sculpt_paint::undo::update_shapekeys().

◆ BKE_keyblock_is_basis()

bool BKE_keyblock_is_basis ( const Key * key,
int index )

Check if given key-block (as index) is used as basis by others in given key.

Definition at line 2562 of file key.cc.

References Key::block, ListBase::first, KEY_RELATIVE, KeyBlock::next, and Key::type.

◆ BKE_keyblock_mesh_calc_normals()

void BKE_keyblock_mesh_calc_normals ( const KeyBlock * kb,
Mesh * mesh,
float(*) r_vert_normals[3],
float(*) r_face_normals[3],
float(*) r_loop_normals[3] )

Computes normals (vertices, faces and/or loops ones) of given mesh for given shape key.

Parameters
kbthe KeyBlock to use to compute normals.
meshthe Mesh to apply key-block to.
r_vert_normalsif non-NULL, an array of vectors, same length as number of vertices.
r_face_normalsif non-NULL, an array of vectors, same length as number of faces.
r_loop_normalsif non-NULL, an array of vectors, same length as number of loops.

Definition at line 2210 of file key.cc.

References BKE_keyblock_convert_to_mesh(), CD_CUSTOMLOOPNORMAL, CustomData_get_layer(), float, MEM_freeN(), and MEM_malloc_arrayN.

◆ BKE_keyblock_move()

bool BKE_keyblock_move ( Object * ob,
int org_index,
int new_index )

Move shape key from org_index to new_index. Safe, clamps index to valid range, updates reference keys, the object's active shape index, the 'frame' value in case of absolute keys, etc. Note indices are expected in real values (not fake shapenr +1 ones).

Parameters
org_indexif < 0, current object's active shape will be used as shape-key to move.
Returns
true if something was done, else false.

Definition at line 2481 of file key.cc.

References BKE_key_from_object(), BLI_listbase_swaplinks(), Key::block, CLAMP, ListBase::first, ListBase::last, KeyBlock::next, KeyBlock::pos, KeyBlock::prev, Key::refkey, KeyBlock::relative, Object::shapenr, Key::totkey, and true.

Referenced by blender::ed::object::shape_key_move_exec().

◆ BKE_keyblock_update_from_curve()

◆ BKE_keyblock_update_from_lattice()

void BKE_keyblock_update_from_lattice ( const Lattice * lt,
KeyBlock * kb )

◆ BKE_keyblock_update_from_mesh()

void BKE_keyblock_update_from_mesh ( const Mesh * mesh,
KeyBlock * kb )

Definition at line 2173 of file key.cc.

References BLI_assert, KeyBlock::data, and KeyBlock::totelem.

Referenced by BKE_keyblock_convert_from_mesh().

◆ BKE_keyblock_update_from_offset()

void BKE_keyblock_update_from_offset ( const Object * ob,
KeyBlock * kb,
const float(*) ofs[3] )

◆ BKE_keyblock_update_from_vertcos()

◆ key_curve_normal_weights()

void key_curve_normal_weights ( float t,
float data[4],
int type )

Second derivative.

Definition at line 418 of file key.cc.

References KEY_BSPLINE, KEY_CARDINAL, KEY_CATMULL_ROM, and KEY_LINEAR.

◆ key_curve_position_weights()

◆ key_curve_tangent_weights()

void key_curve_tangent_weights ( float t,
float data[4],
int type )

First derivative.

Definition at line 380 of file key.cc.

References KEY_BSPLINE, KEY_CARDINAL, KEY_CATMULL_ROM, and KEY_LINEAR.

Referenced by BKE_where_on_path().