blender::bke::greasepencil::convert::AnimDataConvertor Class Reference

Public Member Functions
	AnimDataConvertor (ConversionData &conversion_data, ID &id_src, const Array< AnimDataFCurveConvertor > fcurve_convertors={})
	AnimDataConvertor (ConversionData &conversion_data, ID &id_dst, ID &id_src, const Array< AnimDataFCurveConvertor > fcurve_convertors={})
	AnimDataConvertor ()=delete
bool	source_has_animation_to_convert () const
void	fcurves_convert ()
void	fcurves_convert_finalize ()

Public Attributes
std::string	root_path_src
std::string	root_path_dst

Detailed Description

This class contains data and logic to handle conversion of animation data (FCurves).

It can be used to either:

• Convert FCurves within a same animation data (essentially updating the RNA paths).
• Convert FCurves and move them from the source to the destination IDs animation data. The constructor used defines which of these two 'modes' will be the used by a given convertor.

RNA paths to convert can be specified in two ways:

• Complete paths, with a list of source to destination pairs of paths (relative to the relevant root paths).
• Only by the source and destination root paths (in which case all FCurves starting by these paths will be converted).

Note

In case of transfer of animation data between IDs, NLA animation in source data is not converted. This would require (partially) re-creating a copy of the potential source NLA into the destination NLA, which is too complex for the few potential use cases.

Definition at line 139 of file grease_pencil_convert_legacy.cc.

Constructor & Destructor Documentation

AnimDataConvertor() [1/3]

blender::bke::greasepencil::convert::AnimDataConvertor::AnimDataConvertor ( ConversionData & conversion_data, ID & id_src, const Array< AnimDataFCurveConvertor > fcurve_convertors = {} )

inline

Constructor to use when only processing FCurves within a same ID animation data.

Definition at line 192 of file grease_pencil_convert_legacy.cc.

AnimDataConvertor() [2/3]

blender::bke::greasepencil::convert::AnimDataConvertor::AnimDataConvertor ( ConversionData & conversion_data, ID & id_dst, ID & id_src, const Array< AnimDataFCurveConvertor > fcurve_convertors = {} )

inline

Constructor to use when moving FCurves from one ID to another.

Definition at line 206 of file grease_pencil_convert_legacy.cc.

AnimDataConvertor() [3/3]

blender::bke::greasepencil::convert::AnimDataConvertor::AnimDataConvertor ( )

delete

Member Function Documentation

fcurves_convert()

void blender::bke::greasepencil::convert::AnimDataConvertor::fcurves_convert ( )

inline

Convert relevant FCurves, i.e. modify their RNA path to match destination data.

Note

Edited FCurves will remain in the source animation data after this process. Once all source animation data has been processed, fcurves_convert_finalize has to be called.

Definition at line 447 of file grease_pencil_convert_legacy.cc.

References AnimData::action, blender::Vector< T, InlineBufferCapacity, Allocator >::append(), BLI_strdupn(), blender::bke::greasepencil::convert::AnimDataFCurveConvertor::convert_cb, blender::Array< T, InlineBufferCapacity, Allocator >::is_empty(), MEM_freeN(), blender::bke::greasepencil::convert::AnimDataFCurveConvertor::relative_rna_path_dst, blender::bke::greasepencil::convert::AnimDataFCurveConvertor::relative_rna_path_src, blender::StringRefBase::substr(), and AnimData::tmpact.

Referenced by blender::bke::greasepencil::convert::legacy_object_modifier_common().

fcurves_convert_finalize()

void blender::bke::greasepencil::convert::AnimDataConvertor::fcurves_convert_finalize ( )

inline

Finalize FCurves conversion. Typically, this AnimDataConvertor should not be used after this call.

Currently, this call merely ensure depsgraph update in case of conversion of animation data within a same ID.

When transferring animation between source and destination IDs, this call actually moves the processed fcurves accumulated by previous call(s) to fcurves_convert.

Definition at line 530 of file grease_pencil_convert_legacy.cc.

References AnimData::action, blender::animrig::action_add(), blender::animrig::action_fcurve_move(), blender::animrig::assign_action(), blender::animrig::assign_tmpaction(), BKE_animdata_action_ensure_idroot(), BKE_animdata_ensure_id(), BLI_addtail(), BLI_assert, BLI_assert_msg, BLI_findindex(), BLI_remlink(), blender::bke::greasepencil::convert::ConversionData::bmain, blender::Vector< T, InlineBufferCapacity, Allocator >::clear(), DEG_id_tag_update(), DEG_relations_tag_update(), AnimData::drivers, GS, ID_RECALC_ANIMATION, blender::Vector< T, InlineBufferCapacity, Allocator >::is_empty(), ID::name, blender::animrig::Action::slot_add_for_id(), AnimData::tmpact, and UNUSED_VARS_NDEBUG.

Referenced by blender::bke::greasepencil::convert::legacy_object_modifier_common().

source_has_animation_to_convert()

bool blender::bke::greasepencil::convert::AnimDataConvertor::source_has_animation_to_convert ( ) const

inline

Check whether the source animation data contains FCurves that need to be converted/moved to the destination animation data.

Definition at line 402 of file grease_pencil_convert_legacy.cc.

References GS, blender::Array< T, InlineBufferCapacity, Allocator >::is_empty(), and FCurve::rna_path.

Member Data Documentation

root_path_dst

std::string blender::bke::greasepencil::convert::AnimDataConvertor::root_path_dst

Definition at line 172 of file grease_pencil_convert_legacy.cc.

Referenced by blender::bke::greasepencil::convert::legacy_object_modifier_common().

root_path_src

std::string blender::bke::greasepencil::convert::AnimDataConvertor::root_path_src

Source and destination RNA root path. These can be modified by user code at any time (e.g. when processing animation data for different modifiers...).

Definition at line 171 of file grease_pencil_convert_legacy.cc.

Referenced by blender::bke::greasepencil::convert::legacy_object_modifier_common(), and blender::bke::greasepencil::convert::legacy_object_modifier_opacity().

---

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

• grease_pencil_convert_legacy.cc