Blender V5.3
blender::bAnimListElem Struct Reference

#include <ED_anim_api.hh>

Public Attributes

bAnimListElem * next
bAnimListElem * prev
void * data
eAnim_ChannelType type
int flag
int index
int32_t slot_handle
eAnim_Update_Flags update
char tag
eAnim_KeyType datatype
void * key_data
ID * id
AnimData * adt
Main * bmain
ID * fcurve_owner_id
void * owner

Detailed Description

This struct defines a structure used for quick and uniform access for channels of animation data.

Definition at line 306 of file ED_anim_api.hh.

Member Data Documentation

◆ adt

AnimData* blender::bAnimListElem::adt

source of the animation data attached to ID block

Definition at line 354 of file ED_anim_api.hh.

Referenced by blender::acf_fillactd_setting_ptr(), blender::acf_fillanim_setting_ptr(), blender::acf_nlaaction_backdrop(), blender::acf_nlaaction_color(), blender::acf_nlaaction_icon(), blender::acf_nlaaction_setting_ptr(), blender::acf_nlaaction_setting_valid(), blender::acf_nlatrack_color(), blender::acf_nlatrack_setting_valid(), blender::achannel_nlatrack_solo_widget_cb(), blender::achannel_setting_flush_widget_cb(), blender::actkeys_list_element_to_keylist(), blender::ANIM_animchannel_keyframes_loop(), blender::ANIM_channel_draw_widgets(), blender::ANIM_is_active_channel(), blender::ANIM_nla_mapping_apply_if_needed_fcurve(), blender::ANIM_nla_tweakedit_remap(), blender::ANIM_set_active_channel(), blender::animchannels_group_channels(), blender::ed::transform::bezt_to_transdata(), blender::cachefile_to_keylist(), blender::clean_fcurve(), blender::click_select_channel_dummy(), blender::ED_add_action_group_channel(), blender::ED_add_action_layered_channel(), blender::ED_add_action_slot_channel(), blender::ED_add_fcurve_channel(), blender::ED_add_grease_pencil_datablock_channel(), blender::ED_anim_ale_fcurve_delete(), blender::key_data_from_adt(), blender::make_new_animlistelem(), blender::mouse_nla_tracks(), blender::nlatracks_pushdown_exec(), blender::ob_keyframes_loop(), blender::ob_to_keylist(), blender::scene_keyframes_loop(), blender::scene_to_keylist(), blender::animrig::tests::TEST_F(), and blender::ed::transform::TimeToTransData().

◆ bmain

◆ data

void* blender::bAnimListElem::data

source data this elem represents

Definition at line 310 of file ED_anim_api.hh.

Referenced by blender::acf_action_slot_idtype_icon(), blender::acf_action_slot_name(), blender::acf_action_slot_name_prop(), blender::acf_action_slot_setting_ptr(), blender::acf_dsarm_setting_ptr(), blender::acf_dscachefile_setting_ptr(), blender::acf_dscam_setting_ptr(), blender::acf_dscur_icon(), blender::acf_dscur_setting_ptr(), blender::acf_dscurves_setting_ptr(), blender::acf_dsgpencil_setting_ptr(), blender::acf_dslat_setting_ptr(), blender::acf_dslight_setting_ptr(), blender::acf_dslightprobe_icon(), blender::acf_dslightprobe_setting_ptr(), blender::acf_dslinestyle_setting_ptr(), blender::acf_dsmat_setting_ptr(), blender::acf_dsmball_setting_ptr(), blender::acf_dsmclip_setting_ptr(), blender::acf_dsmesh_setting_ptr(), blender::acf_dsntree_offset(), blender::acf_dsntree_setting_ptr(), blender::acf_dspart_setting_ptr(), blender::acf_dspointcloud_setting_ptr(), blender::acf_dsskey_setting_ptr(), blender::acf_dsspk_setting_ptr(), blender::acf_dstex_setting_ptr(), blender::acf_dsvolume_setting_ptr(), blender::acf_dswor_setting_ptr(), blender::acf_fcurve_channel_color(), blender::acf_fcurve_name(), blender::acf_fcurve_name_prop(), blender::acf_fcurve_setting_ptr(), blender::acf_fillactd_setting_ptr(), blender::acf_filldrivers_setting_ptr(), blender::acf_generic_idblock_name(), blender::acf_generic_idblock_name_prop(), blender::acf_generic_idfill_name_prop(), blender::acf_generic_indentation_flexible(), blender::acf_gpl_channel_color(), blender::acf_gpl_name_legacy(), blender::acf_gpl_name_prop_legacy(), blender::acf_gpl_setting_ptr_legacy(), blender::acf_group_channel_color(), blender::acf_group_name(), blender::acf_group_name_prop(), blender::acf_group_setting_ptr(), blender::acf_mask_setting_ptr(), blender::acf_masklay_name(), blender::acf_masklay_name_prop(), blender::acf_masklay_setting_ptr(), blender::acf_nla_controls_setting_ptr(), blender::acf_nla_curve_name(), blender::acf_nlaaction_backdrop(), blender::acf_nlaaction_color(), blender::acf_nlaaction_name(), blender::acf_nlaaction_name_prop(), blender::acf_nlatrack_color(), blender::acf_nlatrack_name(), blender::acf_nlatrack_name_prop(), blender::acf_nlatrack_setting_ptr(), blender::acf_nlatrack_setting_valid(), blender::acf_object_icon(), blender::acf_object_name(), blender::acf_object_setting_ptr(), blender::acf_object_setting_valid(), blender::acf_scene_setting_ptr(), blender::acf_shapekey_name(), blender::acf_shapekey_name_prop(), blender::acf_shapekey_setting_ptr(), blender::acf_summary_setting_ptr(), blender::achannel_is_broken(), blender::achannel_is_part_of_disconnected_slot(), blender::achannel_nlatrack_solo_widget_cb(), blender::actkeys_list_element_to_keylist(), blender::actkeys_mselect_channel_only(), blender::actkeys_mselect_single(), blender::ANIM_animchannel_keyframes_loop(), blender::ANIM_channel_draw(), blender::ANIM_channel_draw_widgets(), blender::ANIM_flush_setting_anim_channels(), blender::ANIM_is_active_channel(), blender::anim_list_el_is_visibility_related_or_self(), blender::ANIM_set_active_channel(), blender::animchan_sync_fcurve(), blender::animchan_sync_fcurve_scene(), blender::animchan_sync_gplayer(), blender::animchan_sync_group(), blender::animchannel_select_range(), blender::animdata_filter_animchan(), blender::box_select_elem(), blender::cachefile_to_keylist(), blender::click_select_channel_action_slot(), blender::click_select_channel_fcurve(), blender::click_select_channel_gplayer(), blender::click_select_channel_grease_pencil_datablock(), blender::click_select_channel_grease_pencil_layer(), blender::click_select_channel_grease_pencil_layer_group(), blender::click_select_channel_group(), blender::click_select_channel_maskdatablock(), blender::click_select_channel_masklayer(), blender::click_select_channel_nlacontrols(), blender::click_select_channel_object(), blender::click_select_channel_scene(), blender::click_select_channel_shapekey(), blender::ed::animation::greasepencil::data_block_setting_ptr(), blender::draw_grease_pencil_layer_widgets(), blender::draw_keyframes(), blender::ED_anim_ale_fcurve_delete(), blender::get_channel_bounds(), blender::graph_fmodifier_copy_exec(), blender::graph_panel_context(), blender::graph_refresh_fcurve_colors(), blender::graphkeys_click_insert_exec(), blender::graphkeys_deselectall_exec(), blender::graphop_active_fcurve_poll(), blender::insert_gpencil_key(), blender::insert_grease_pencil_key(), blender::insert_nla_curve_key(), blender::ed::animation::greasepencil::layer_channel_color(), blender::ed::animation::greasepencil::layer_group_icon(), blender::ed::animation::greasepencil::layer_group_name(), blender::ed::animation::greasepencil::layer_group_setting_ptr(), blender::ed::animation::greasepencil::layer_name(), blender::ed::animation::greasepencil::layer_name_prop(), blender::ed::animation::greasepencil::layer_offset(), blender::ed::animation::greasepencil::layer_setting_ptr(), blender::make_new_animlistelem(), blender::mouse_action_keys(), blender::mouse_nla_strips(), blender::mouse_nla_tracks(), blender::nlaedit_strip_at_region_position(), blender::ob_keyframes_loop(), blender::ob_to_keylist(), blender::paste_animedit_keys(), blender::paste_get_y_offset(), blender::ed::animation::pastebuf_find_matching_copybuf_item(), blender::region_select_elem(), blender::rename_anim_channels(), blender::scene_keyframes_loop(), blender::scene_to_keylist(), blender::skip_fcurve_with_name(), blender::animrig::tests::TEST_F(), and blender::animrig::tests::TEST_F().

◆ datatype

◆ fcurve_owner_id

ID* blender::bAnimListElem::fcurve_owner_id

For list elements that correspond to an f-curve, a channel group, or an action slot, this is the ID which owns that data.

For channel groups and action slots, that will always be an Action. For f-curves it's more complicated, because f-curves are sometimes owned by other ID types (e.g. driver f-curves are owned by objects, materials, etc.), so you have to be careful.

NOTE: this is different from id above. The id above will be set to an object if the f-curve is coming from action associated with that object.

TODO: the responsibilities for this are getting overloaded, which makes it difficult to use confidently, and also makes its name misleading. Split off a separate bAction pointer that is simply null when the data isn't owned by an action.

Definition at line 375 of file ED_anim_api.hh.

Referenced by blender::acf_action_slot_name_prop(), blender::acf_fcurve_name(), blender::acf_fcurve_name_prop(), blender::acf_group_name_prop(), blender::acf_nlaaction_name_prop(), blender::achannel_is_part_of_disconnected_slot(), blender::ANIM_channel_action_get(), blender::click_select_channel_action_slot(), blender::draw_setting_widget(), blender::ED_anim_ale_fcurve_delete(), blender::graph_panel_key_properties(), blender::graph_panel_modifiers(), blender::graph_panel_properties(), blender::insert_fcurve_key(), blender::make_new_animlistelem(), blender::mouse_action_keys(), blender::ed::animation::pastebuf_find_matching_copybuf_item(), blender::rename_anim_channels(), and blender::animrig::tests::TEST_F().

◆ flag

int blender::bAnimListElem::flag

copy of elem's flags for quick access

Definition at line 314 of file ED_anim_api.hh.

Referenced by blender::acf_group_color(), blender::make_new_animlistelem(), and blender::animrig::tests::TEST_F().

◆ id

ID* blender::bAnimListElem::id
Note
id here is the "IdAdtTemplate"-style datablock (e.g. Object, Material, Texture, NodeTree) from which evaluation of the RNA-paths takes place. It's used to figure out how deep channels should be nested (e.g. for Textures/NodeTrees) in the tree, and allows property lookups (e.g. for sliders and for inserting keyframes) to work. If we had instead used bAction or something similar, none of this would be possible: although it's trivial to use an IdAdtTemplate type to find the source action a channel (e.g. F-Curve) comes from (i.e. in the AnimEditors, it must be the active action, as only that can be edited), it's impossible to go the other way (i.e. one action may be used in multiple places). ID block that channel is attached to

Definition at line 352 of file ED_anim_api.hh.

Referenced by blender::acf_fcurve_name(), blender::acf_generic_group_offset(), blender::acf_gpl_name_prop_legacy(), blender::acf_masklay_name_prop(), blender::acf_nlatrack_name_prop(), blender::acf_object_name_prop(), blender::acf_shapekey_name_prop(), blender::achannel_nlatrack_solo_widget_cb(), blender::achannel_setting_flush_widget_cb(), blender::actkeys_list_element_to_keylist(), blender::ANIM_channel_draw_widgets(), blender::ANIM_flush_setting_anim_channels(), blender::ANIM_is_active_channel(), blender::anim_list_el_is_visibility_related_or_self(), blender::ANIM_list_elem_update(), blender::animchan_sync_fcurve(), blender::animchan_sync_fcurve_scene(), blender::animchan_sync_group(), blender::animdata_filter_animchan(), blender::cachefile_to_keylist(), blender::clean_fcurve(), blender::click_select_channel_gplayer(), blender::click_select_channel_grease_pencil_layer(), blender::click_select_channel_group(), blender::click_select_channel_shapekey(), blender::draw_fcurve(), blender::draw_grease_pencil_layer_widgets(), blender::draw_setting_widget(), blender::ED_add_action_group_channel(), blender::ED_add_action_layered_channel(), blender::ED_add_action_slot_channel(), blender::ED_add_fcurve_channel(), blender::ED_add_grease_pencil_datablock_channel(), blender::get_channel_bounds(), blender::graph_panel_driven_property(), blender::graph_panel_drivers(), blender::graph_panel_drivers_header(), blender::graph_panel_key_properties(), blender::graph_panel_properties(), blender::graphkeys_click_insert_exec(), blender::insert_fcurve_key(), blender::insert_gpencil_key(), blender::insert_grease_pencil_key(), blender::insert_nla_curve_key(), blender::is_animating_bone(), blender::ed::animation::greasepencil::layer_name_prop(), blender::make_new_animlistelem(), blender::mouse_action_keys(), blender::mouse_nla_tracks(), blender::nlatracks_pushdown_exec(), blender::ob_keyframes_loop(), blender::ob_to_keylist(), blender::rename_anim_channels(), blender::scene_keyframes_loop(), blender::scene_to_keylist(), blender::select_pchan_for_action_group(), blender::skip_fcurve_with_name(), blender::tag_update_animation_element(), and blender::animrig::tests::TEST_F().

◆ index

int blender::bAnimListElem::index

for un-named data, the index of the data in its collection

Definition at line 316 of file ED_anim_api.hh.

Referenced by blender::acf_shapekey_name(), and blender::make_new_animlistelem().

◆ key_data

◆ next

◆ owner

void* blender::bAnimListElem::owner

◆ prev

bAnimListElem * blender::bAnimListElem::prev

◆ slot_handle

int32_t blender::bAnimListElem::slot_handle

For data that is owned by a specific slot, its handle.

This is not declared as #animrig::slot_handle_t to avoid all the users of this header file to get the animrig module as extra dependency (which would spread to the undo system, line-art, etc). It's probably best to split off this struct definition from the rest of this header, as most code that uses this header doesn't need to know the definition of this struct.

TODO: split off into separate header file.

Definition at line 328 of file ED_anim_api.hh.

Referenced by blender::acf_fcurve_name(), blender::achannel_is_part_of_disconnected_slot(), blender::animfilter_fcurves_span(), blender::insert_fcurve_key(), blender::ed::animation::pastebuf_find_matching_copybuf_item(), and blender::animrig::tests::TEST_F().

◆ tag

char blender::bAnimListElem::tag

tag the included data. Temporary always

Definition at line 333 of file ED_anim_api.hh.

◆ type

eAnim_ChannelType blender::bAnimListElem::type

One of the ANIMTYPE_* values.

Definition at line 312 of file ED_anim_api.hh.

Referenced by blender::acf_generic_group_offset(), blender::acf_generic_indentation_flexible(), blender::achannel_is_broken(), blender::achannel_is_part_of_disconnected_slot(), blender::achannel_setting_flush_widget_cb(), blender::actkeys_list_element_to_keylist(), blender::actkeys_mselect_channel_only(), blender::actkeys_mselect_single(), blender::ANIM_channel_action_get(), blender::ANIM_channel_debug_print_info(), blender::ANIM_channel_draw(), blender::ANIM_channel_draw_widgets(), blender::ANIM_channel_get_typeinfo(), blender::ANIM_flush_setting_anim_channels(), blender::ANIM_is_active_channel(), blender::anim_list_el_is_visibility_related_or_self(), blender::ANIM_list_elem_update(), blender::ANIM_nla_mapping_allowed(), blender::ANIM_set_active_channel(), blender::animchannel_select_range(), blender::animdata_filter_animchan(), blender::box_select_elem(), blender::cachefile_to_keylist(), blender::click_select_channel_fcurve(), blender::draw_backdrops(), blender::draw_setting_widget(), blender::ED_anim_ale_fcurve_delete(), blender::graph_panel_properties(), blender::graph_refresh_fcurve_colors(), blender::graphop_active_fcurve_poll(), blender::make_new_animlistelem(), blender::mouse_action_keys(), blender::mouse_anim_channels(), blender::mouse_nla_strips(), blender::mouse_nla_tracks(), blender::nlaedit_strip_at_region_position(), blender::nlatracks_pushdown_exec(), blender::ob_keyframes_loop(), blender::ob_to_keylist(), blender::region_select_elem(), blender::rename_anim_channels(), blender::scene_keyframes_loop(), blender::scene_to_keylist(), blender::skip_fcurve_with_name(), blender::animrig::tests::TEST_F(), and blender::animrig::tests::TEST_F().

◆ update


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