Blender V4.3
Public Member Functions | Static Public Attributes | List of all members
blender::animrig::StripKeyframeData Class Reference

#include <ANIM_action.hh>

Inherits ActionStripKeyframeData.

Public Member Functions

 StripKeyframeData ()=default
 StripKeyframeData (const StripKeyframeData &other)
 ~StripKeyframeData ()
blender::Span< const ChannelBag * > channelbags () const
blender::Span< ChannelBag * > channelbags ()
const ChannelBag * channelbag (int64_t index) const
ChannelBag * channelbag (int64_t index)
const ChannelBag * channelbag_for_slot (const Slot &slot) const
ChannelBag * channelbag_for_slot (const Slot &slot)
const ChannelBag * channelbag_for_slot (slot_handle_t slot_handle) const
ChannelBag * channelbag_for_slot (slot_handle_t slot_handle)
ChannelBag & channelbag_for_slot_add (const Slot &slot)
ChannelBag & channelbag_for_slot_ensure (const Slot &slot)
bool channelbag_remove (ChannelBag &channelbag_to_remove)
void slot_data_remove (slot_handle_t slot_handle)
int64_t find_channelbag_index (const ChannelBag &channelbag) const
SingleKeyingResult keyframe_insert (Main *bmain, const Slot &slot, FCurveDescriptor fcurve_descriptor, float2 time_value, const KeyframeSettings &settings, eInsertKeyFlags insert_key_flags=INSERTKEY_NOFLAGS)

Static Public Attributes

static constexpr Strip::Type TYPE = Strip::Type::Keyframe

Additional Inherited Members

Public Attributes inherited from ActionStripKeyframeData
struct ActionChannelBag ** channelbag_array
int channelbag_array_num
uint8_t _pad [4]

Detailed Description

Keyframe strips effectively contain a bag of F-Curves for each Slot.

Definition at line 737 of file ANIM_action.hh.

Constructor & Destructor Documentation

◆ StripKeyframeData() [1/2]

blender::animrig::StripKeyframeData::StripKeyframeData ( )
default

References channelbag(), channelbag_for_slot(), channelbag_for_slot_add(), channelbag_for_slot_ensure(), channelbag_remove(), channelbags(), find_channelbag_index(), INSERTKEY_NOFLAGS, keyframe_insert(), slot_data_remove(), and StripKeyframeData().

Referenced by channelbag_for_slot(), StripKeyframeData(), and StripKeyframeData().

◆ StripKeyframeData() [2/2]

blender::animrig::StripKeyframeData::StripKeyframeData ( const StripKeyframeData & other)
explicit

Definition at line 1556 of file animrig/intern/action.cc.

References channelbag(), ActionStripKeyframeData::channelbag_array, ActionStripKeyframeData::channelbag_array_num, channelbags(), blender::Span< T >::index_range(), and StripKeyframeData().

◆ ~StripKeyframeData()

blender::animrig::StripKeyframeData::~StripKeyframeData ( )

Definition at line 1568 of file animrig/intern/action.cc.

References ActionStripKeyframeData::channelbag_array, ActionStripKeyframeData::channelbag_array_num, channelbag_for_slot(), channelbags(), and MEM_SAFE_FREE.

Member Function Documentation

◆ channelbag() [1/2]

ChannelBag * blender::animrig::StripKeyframeData::channelbag ( int64_t index)

Definition at line 1591 of file animrig/intern/action.cc.

References ActionStripKeyframeData::channelbag_array.

◆ channelbag() [2/2]

const ChannelBag * blender::animrig::StripKeyframeData::channelbag ( int64_t index) const

Definition at line 1587 of file animrig/intern/action.cc.

References ActionStripKeyframeData::channelbag_array.

Referenced by find_channelbag_index(), slot_data_remove(), StripKeyframeData(), StripKeyframeData(), blender::animrig::tests::TEST_F(), blender::animrig::tests::TEST_F(), blender::animrig::tests::TEST_F(), blender::animrig::tests::TEST_F(), blender::animrig::tests::TEST_F(), blender::animrig::tests::TEST_F(), blender::animrig::tests::TEST_F(), blender::animrig::tests::TEST_F(), blender::animrig::tests::TEST_F(), blender::animrig::tests::TEST_F(), blender::animrig::tests::TEST_F(), and blender::animrig::tests::TEST_F().

◆ channelbag_for_slot() [1/4]

ChannelBag * blender::animrig::StripKeyframeData::channelbag_for_slot ( const Slot & slot)

Definition at line 1623 of file animrig/intern/action.cc.

References channelbag_for_slot(), and ActionSlot::handle.

◆ channelbag_for_slot() [2/4]

const ChannelBag * blender::animrig::StripKeyframeData::channelbag_for_slot ( const Slot & slot) const

Find the animation channels for this slot.

Returns
nullptr if there is none yet for this slot.

Definition at line 1619 of file animrig/intern/action.cc.

References channelbag_for_slot(), and ActionSlot::handle.

Referenced by blender::deg::DepsgraphRelationBuilder::build_animdata_action_targets(), blender::animrig::channelbag_for_action_slot(), channelbag_for_slot(), channelbag_for_slot(), channelbag_for_slot_add(), channelbag_for_slot_ensure(), blender::animrig::evaluate_keyframe_data(), blender::animrig::fcurve_find_by_rna_path(), keyframe_insert(), blender::animrig::move_slot(), slot_data_remove(), StripKeyframeData(), blender::animrig::tests::TEST_F(), blender::animrig::tests::TEST_F(), blender::animrig::tests::TEST_F(), blender::animrig::tests::TEST_F(), blender::animrig::tests::TEST_F(), and ~StripKeyframeData().

◆ channelbag_for_slot() [3/4]

ChannelBag * blender::animrig::StripKeyframeData::channelbag_for_slot ( slot_handle_t slot_handle)

Definition at line 1613 of file animrig/intern/action.cc.

References StripKeyframeData().

◆ channelbag_for_slot() [4/4]

const ChannelBag * blender::animrig::StripKeyframeData::channelbag_for_slot ( slot_handle_t slot_handle) const

Definition at line 1595 of file animrig/intern/action.cc.

References channelbags(), and channels().

◆ channelbag_for_slot_add()

ChannelBag & blender::animrig::StripKeyframeData::channelbag_for_slot_add ( const Slot & slot)

Add the animation channels for this slot.

Should only be called when there is no ChannelBag for this slot yet.

Definition at line 1628 of file animrig/intern/action.cc.

References BLI_assert_msg, ActionStripKeyframeData::channelbag_array, ActionStripKeyframeData::channelbag_array_num, channelbag_for_slot(), channels(), blender::animrig::grow_array_and_append(), and ActionSlot::handle.

Referenced by channelbag_for_slot_ensure(), and StripKeyframeData().

◆ channelbag_for_slot_ensure()

ChannelBag & blender::animrig::StripKeyframeData::channelbag_for_slot_ensure ( const Slot & slot)

Find the ChannelBag for slot, or if none exists, create it.

Definition at line 1642 of file animrig/intern/action.cc.

References channelbag_for_slot(), and channelbag_for_slot_add().

Referenced by blender::animrig::action_fcurve_attach(), blender::animrig::action_fcurve_ensure(), blender::animrig::tests::add_fcurve_to_action(), keyframe_insert(), StripKeyframeData(), and blender::animrig::tests::TEST_F().

◆ channelbag_remove()

bool blender::animrig::StripKeyframeData::channelbag_remove ( ChannelBag & channelbag_to_remove)

Remove the ChannelBag from this slot.

After this call the reference is no longer valid, as the memory will have been freed.

Returns
true when the ChannelBag was found & removed, false if it wasn't found.

Definition at line 1657 of file animrig/intern/action.cc.

References ActionStripKeyframeData::channelbag_array, ActionStripKeyframeData::channelbag_array_num, blender::animrig::channelbag_ptr_destructor(), find_channelbag_index(), and blender::dna::array::remove_index().

Referenced by slot_data_remove(), and StripKeyframeData().

◆ channelbags() [1/2]

blender::Span< ChannelBag * > blender::animrig::StripKeyframeData::channelbags ( )

Definition at line 1582 of file animrig/intern/action.cc.

References ActionStripKeyframeData::channelbag_array, and ActionStripKeyframeData::channelbag_array_num.

◆ channelbags() [2/2]

blender::Span< const ChannelBag * > blender::animrig::StripKeyframeData::channelbags ( ) const

Definition at line 1577 of file animrig/intern/action.cc.

References ActionStripKeyframeData::channelbag_array, and ActionStripKeyframeData::channelbag_array_num.

Referenced by blender::animrig::action_fcurve_detach(), blender::animrig::action_fcurve_remove(), blender::animrig::legacy::channel_groups_all(), channelbag_for_slot(), blender::animrig::fcurve_find_in_action(), blender::animrig::foreach_fcurve_in_action(), blender::animrig::foreach_fcurve_in_action_slot(), StripKeyframeData(), StripKeyframeData(), blender::animrig::tests::TEST_F(), blender::animrig::tests::TEST_F(), blender::animrig::tests::TEST_F(), blender::animrig::tests::TEST_F(), blender::animrig::tests::TEST_F(), blender::animrig::tests::TEST_F(), blender::animrig::tests::TEST_F(), blender::animrig::tests::TEST_F(), blender::animrig::tests::TEST_F(), blender::animrig::tests::TEST_F(), and ~StripKeyframeData().

◆ find_channelbag_index()

int64_t blender::animrig::StripKeyframeData::find_channelbag_index ( const ChannelBag & channelbag) const

Return the channelbag's index, or -1 if there is none for this slot handle.

Definition at line 1604 of file animrig/intern/action.cc.

References channelbag(), and ActionStripKeyframeData::channelbag_array_num.

Referenced by channelbag_remove(), blender::animrig::move_slot(), and StripKeyframeData().

◆ keyframe_insert()

SingleKeyingResult blender::animrig::StripKeyframeData::keyframe_insert ( Main * bmain,
const Slot & slot,
FCurveDescriptor fcurve_descriptor,
float2 time_value,
const KeyframeSettings & settings,
eInsertKeyFlags insert_key_flags = INSERTKEY_NOFLAGS )

Definition at line 1836 of file animrig/intern/action.cc.

References blender::animrig::FCurveDescriptor::array_index, BKE_fcurve_is_keyframable(), blender::StringRefNull::c_str(), blender::animrig::CANNOT_CREATE_FCURVE, channelbag_for_slot(), channelbag_for_slot_ensure(), channels(), blender::animrig::ChannelBag::fcurve_ensure(), blender::animrig::FCURVE_NOT_KEYFRAMEABLE, blender::animrig::insert_vert_fcurve(), blender::animrig::key_insertion_may_create_fcurve(), ActionSlot::name, blender::animrig::FCurveDescriptor::rna_path, and blender::animrig::SUCCESS.

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

◆ slot_data_remove()

void blender::animrig::StripKeyframeData::slot_data_remove ( slot_handle_t slot_handle)

Remove all strip data for the given slot.

Typically only called from #Strip::slot_data_remove().

Definition at line 1673 of file animrig/intern/action.cc.

References channelbag(), channelbag_for_slot(), and channelbag_remove().

Referenced by StripKeyframeData().

Member Data Documentation

◆ TYPE

Strip::Type blender::animrig::StripKeyframeData::TYPE = Strip::Type::Keyframe
staticconstexpr

Definition at line 740 of file ANIM_action.hh.

Referenced by blender::animrig::Strip::data(), and blender::animrig::Strip::data().

The documentation for this class was generated from the following files:
Generated on Sat Oct 4 2025 05:32:23 for Blender by  doxygen 1.14.0