Blender: blender::animrig::CombinedKeyingResult Class Reference

Blender V5.0

#include <ANIM_keyframing.hh>

Public Member Functions
	CombinedKeyingResult ()
void	add (SingleKeyingResult result, int count=1)
void	merge (const CombinedKeyingResult &other)
int	get_count (const SingleKeyingResult result) const
bool	has_errors () const
void	generate_reports (ReportList *reports, eReportType report_level=RPT_ERROR)

Detailed Description

Class for tracking the result of inserting keyframes. Tracks how often each of SingleKeyingResult has happened.

Definition at line 66 of file ANIM_keyframing.hh.

Constructor & Destructor Documentation

◆ CombinedKeyingResult()

blender::animrig::CombinedKeyingResult::CombinedKeyingResult ( )

Definition at line 52 of file animrig/intern/keyframing.cc.

Referenced by merge().

Member Function Documentation

◆ add()

void blender::animrig::CombinedKeyingResult::add	(	SingleKeyingResult	result,
		int	count = 1 )

Increase the count of the given SingleKeyingResult by count.

Definition at line 57 of file animrig/intern/keyframing.cc.

References count, and result.

Referenced by blender::animrig::insert_key_layered_action(), blender::animrig::insert_key_legacy_action(), and blender::animrig::insert_keyframes().

◆ generate_reports()

void blender::animrig::CombinedKeyingResult::generate_reports	(	ReportList *	reports,
		eReportType	report_level = RPT_ERROR )

Definition at line 87 of file animrig/intern/keyframing.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), BKE_report(), BKE_reportf(), blender::animrig::CANNOT_CREATE_FCURVE, blender::animrig::CANNOT_RESOLVE_PATH, error(), blender::animrig::FCURVE_NOT_KEYFRAMEABLE, get_count(), has_errors(), blender::animrig::ID_NOT_ANIMATABLE, blender::animrig::ID_NOT_EDITABLE, blender::Vector< T, InlineBufferCapacity, Allocator >::is_empty(), blender::animrig::NO_KEY_NEEDED, blender::animrig::NO_VALID_LAYER, blender::animrig::NO_VALID_SLOT, blender::animrig::NO_VALID_STRIP, RPT_, RPT_WARNING, blender::Vector< T, InlineBufferCapacity, Allocator >::size(), blender::animrig::SUCCESS, blender::animrig::UNABLE_TO_INSERT_TO_NLA_STACK, and blender::animrig::UNKNOWN_FAILURE.

Referenced by blender::animrig::autokeyframe_object(), blender::animrig::autokeyframe_pose_channel(), insert_key(), blender::animrig::insert_key_to_keying_set_path(), and pyrna_struct_keyframe_insert().

◆ get_count()

int blender::animrig::CombinedKeyingResult::get_count ( const SingleKeyingResult result ) const

Definition at line 69 of file animrig/intern/keyframing.cc.

References result.

Referenced by blender::animrig::autokeyframe_object(), blender::animrig::autokeyframe_pose_channel(), generate_reports(), insert_key(), blender::animrig::insert_key_to_keying_set_path(), blender::animrig::insert_keyframes(), pyrna_struct_keyframe_insert(), 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(), 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().

◆ has_errors()

bool blender::animrig::CombinedKeyingResult::has_errors ( ) const

Definition at line 74 of file animrig/intern/keyframing.cc.

References i, and blender::animrig::SUCCESS.

Referenced by generate_reports().

◆ merge()

void blender::animrig::CombinedKeyingResult::merge ( const CombinedKeyingResult & other )

Definition at line 62 of file animrig/intern/keyframing.cc.

References CombinedKeyingResult(), and i.

Referenced by blender::animrig::autokeyframe_object(), blender::animrig::autokeyframe_pose_channel(), insert_key(), blender::animrig::insert_key_to_keying_set_path(), and blender::animrig::insert_keyframes().

The documentation for this class was generated from the following files: