blender::ed::animrig Namespace Reference

Classes
struct	PathValue

Enumerations
enum	AssetModifyMode { MODIFY_ADJUST = 0 , MODIFY_REPLACE , MODIFY_ADD , MODIFY_REMOVE }

Functions
static const EnumPropertyItem *	rna_asset_library_reference_itemf (bContext *, PointerRNA *, PropertyRNA *, bool *r_free)
static Vector< RNAPath >	construct_pose_rna_paths (const PointerRNA &bone_pointer)
static blender::animrig::Action &	extract_pose (Main &bmain, const blender::Span< Object * > pose_objects)
static void	ensure_asset_ui_visible (bContext &C)
static blender::Vector< Object * >	get_selected_pose_objects (bContext *C)
static wmOperatorStatus	create_pose_asset_local (bContext *C, wmOperator *op, const StringRefNull name, const AssetLibraryReference lib_ref)
static wmOperatorStatus	create_pose_asset_user_library (bContext *C, wmOperator *op, const char name[MAX_NAME], const AssetLibraryReference lib_ref)
static wmOperatorStatus	pose_asset_create_exec (bContext *C, wmOperator *op)
static wmOperatorStatus	pose_asset_create_invoke (bContext *C, wmOperator *op, const wmEvent *)
static bool	pose_asset_create_poll (bContext *C)
static void	visit_library_prop_catalogs_catalog_for_search_fn (const bContext *C, PointerRNA *ptr, PropertyRNA *, const char *edit_text, FunctionRef< void(StringPropertySearchVisitParams)> visit_fn)
void	POSELIB_OT_create_pose_asset (wmOperatorType *ot)
static bAction *	get_action_of_selected_asset (bContext *C)
static Vector< PathValue >	generate_path_values (Object &pose_object)
static void	replace_pose_key (Main &bmain, blender::animrig::StripKeyframeData &strip_data, const blender::animrig::Slot &slot, const float2 time_value, const blender::animrig::FCurveDescriptor &fcurve_descriptor)
static void	update_pose_action_from_scene (Main *bmain, blender::animrig::Action &pose_action, Object &pose_object, const AssetModifyMode mode)
static wmOperatorStatus	pose_asset_modify_exec (bContext *C, wmOperator *op)
static bool	pose_asset_modify_poll (bContext *C)
static std::string	pose_asset_modify_description (bContext *, wmOperatorType *, PointerRNA *ptr)
void	POSELIB_OT_asset_modify (wmOperatorType *ot)
static bool	pose_asset_delete_poll (bContext *C)
static wmOperatorStatus	pose_asset_delete_exec (bContext *C, wmOperator *op)
static wmOperatorStatus	pose_asset_delete_invoke (bContext *C, wmOperator *op, const wmEvent *)
void	POSELIB_OT_asset_delete (wmOperatorType *ot)
void	POSELIB_OT_screenshot_preview (wmOperatorType *ot)

Variables
static const EnumPropertyItem	prop_asset_overwrite_modes []

Enumeration Type Documentation

AssetModifyMode

enum blender::ed::animrig::AssetModifyMode

Enumerator
MODIFY_ADJUST
MODIFY_REPLACE
MODIFY_ADD
MODIFY_REMOVE

Definition at line 450 of file anim_asset_ops.cc.

Function Documentation

construct_pose_rna_paths()

Vector< RNAPath > blender::ed::animrig::construct_pose_rna_paths ( const PointerRNA & bone_pointer )

static

Definition at line 67 of file anim_asset_ops.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), BLI_assert, PointerRNA::data, blender::Vector< T, InlineBufferCapacity, Allocator >::extend(), blender::animrig::get_keyable_id_property_paths(), ROT_MODE_AXISANGLE, ROT_MODE_QUAT, ROT_MODE_XYZ, ROT_MODE_XZY, ROT_MODE_YXZ, ROT_MODE_YZX, ROT_MODE_ZXY, ROT_MODE_ZYX, bPoseChannel::rotmode, and PointerRNA::type.

Referenced by extract_pose(), and generate_path_values().

create_pose_asset_local()

wmOperatorStatus blender::ed::animrig::create_pose_asset_local ( bContext * C, wmOperator * op, const StringRefNull name, const AssetLibraryReference lib_ref )

static

Definition at line 246 of file anim_asset_ops.cc.

References AS_asset_library_load(), ID::asset_data, BKE_asset_metadata_catalog_id_set(), BKE_id_rename(), BLI_assert, C, blender::asset_system::AssetCatalog::catalog_id, CTX_data_main(), ensure_asset_ui_visible(), extract_pose(), G, blender::ed::asset::generate_preview(), get_selected_pose_objects(), bAction::id, blender::Vector< T, InlineBufferCapacity, Allocator >::is_empty(), blender::ed::asset::library_ensure_catalogs_in_path(), blender::ed::asset::mark_id(), MAX_NAME, NA_ADDED, name, NC_ASSET, ND_ASSET_LIST, OPERATOR_CANCELLED, OPERATOR_FINISHED, wmOperator::ptr, blender::ed::asset::refresh_asset_library(), RNA_string_get(), blender::ed::asset::shelf::show_catalog_in_visible_shelves(), blender::asset_system::AssetCatalog::simple_name, and WM_main_add_notifier().

Referenced by pose_asset_create_exec().

create_pose_asset_user_library()

wmOperatorStatus blender::ed::animrig::create_pose_asset_user_library ( bContext * C, wmOperator * op, const char name[MAX_NAME], const AssetLibraryReference lib_ref )

static

Definition at line 292 of file anim_asset_ops.cc.

References AS_asset_library_load(), ID::asset_data, blender::bke::asset_edit_id_save_as(), ASSET_LIBRARY_CUSTOM, BKE_asset_metadata_catalog_id_set(), BKE_id_free(), BKE_preferences_asset_library_find_index(), BKE_report(), BLI_assert, BLI_assert_msg, C, blender::asset_system::AssetCatalog::catalog_id, blender::asset_system::AssetLibrary::catalog_service(), CTX_data_main(), AssetLibraryReference::custom_library_index, ensure_asset_ui_visible(), extract_pose(), G, blender::ed::asset::generate_preview(), get_selected_pose_objects(), bAction::id, blender::Vector< T, InlineBufferCapacity, Allocator >::is_empty(), blender::ed::asset::library_ensure_catalogs_in_path(), blender::ed::asset::mark_id(), MAX_NAME, NA_ADDED, name, NC_ASSET, ND_ASSET_LIST, OPERATOR_CANCELLED, OPERATOR_FINISHED, wmOperator::ptr, blender::ed::asset::refresh_asset_library(), wmOperator::reports, RNA_string_get(), RPT_ERROR, blender::ed::asset::shelf::show_catalog_in_visible_shelves(), blender::asset_system::AssetCatalog::simple_name, AssetLibraryReference::type, U, WM_main_add_notifier(), and blender::asset_system::AssetCatalogService::write_to_disk().

Referenced by pose_asset_create_exec().

ensure_asset_ui_visible()

void blender::ed::animrig::ensure_asset_ui_visible ( bContext & C )

static

Check that the newly created asset is visible SOMEWHERE in Blender. If not already visible, open the asset shelf on the current 3D view. The reason for not always doing that is that it might be annoying in case you have 2 3D viewports open, but you want the asset shelf on only one of them, or you work out of the asset browser.

Definition at line 183 of file anim_asset_ops.cc.

References bScreen::areabase, BKE_area_find_region_type(), SpaceFile::browse_mode, C, CTX_wm_area(), CTX_wm_manager(), ED_region_visibility_change_update(), FILE_BROWSE_MODE_ASSETS, ARegion::flag, LISTBASE_FOREACH, RGN_FLAG_HIDDEN, RGN_TYPE_ASSET_SHELF, ARegion::runtime, SPACE_FILE, SPACE_VIEW3D, SpaceType::spaceid, ScrArea::type, and WM_window_get_active_screen().

Referenced by create_pose_asset_local(), and create_pose_asset_user_library().

extract_pose()

blender::animrig::Action & blender::ed::animrig::extract_pose ( Main & bmain, const blender::Span< Object * > pose_objects )

static

Definition at line 109 of file anim_asset_ops.cc.

References blender::animrig::action_add(), blender::Set< Key, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add(), FCurve::array_index, BEZT_IPO_BEZ, BEZT_KEYTYPE_KEYFRAME, BLI_assert, blender::animrig::bone_is_selected(), construct_pose_rna_paths(), blender::Set< Key, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::contains(), Strip::data, blender::animrig::foreach_fcurve_in_action_slot(), blender::animrig::get_rna_values(), HD_AUTO, i, blender::Vector< T, InlineBufferCapacity, Allocator >::index_range(), blender::animrig::StripKeyframeData::keyframe_insert(), blender::animrig::Action::layer_add(), LISTBASE_FOREACH, FCurve::rna_path, RNA_path_from_ID_to_property(), RNA_path_resolve(), RNA_pointer_create_discrete(), RNA_property_is_idprop(), blender::animrig::Action::slot_add_for_id(), and blender::animrig::Slot::unassigned.

Referenced by create_pose_asset_local(), and create_pose_asset_user_library().

generate_path_values()

Vector< PathValue > blender::ed::animrig::generate_path_values ( Object & pose_object )

static

Definition at line 505 of file anim_asset_ops.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), blender::animrig::bone_is_selected(), bPose::chanbase, construct_pose_rna_paths(), Object::data, blender::animrig::get_rna_values(), i, Object::id, LISTBASE_FOREACH, Object::pose, RNA_path_from_ID_to_property(), RNA_path_resolve(), and RNA_pointer_create_discrete().

Referenced by update_pose_action_from_scene().

get_action_of_selected_asset()

bAction * blender::ed::animrig::get_action_of_selected_asset ( bContext * C )

static

Definition at line 483 of file anim_asset_ops.cc.

References blender::bke::asset_edit_id_from_weak_reference(), C, CTX_data_main(), CTX_wm_asset(), and ID_AC.

Referenced by pose_asset_delete_exec(), pose_asset_delete_invoke(), pose_asset_delete_poll(), pose_asset_modify_exec(), and pose_asset_modify_poll().

get_selected_pose_objects()

blender::Vector< Object * > blender::ed::animrig::get_selected_pose_objects ( bContext * C )

static

Definition at line 223 of file anim_asset_ops.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), C, blender::Vector< T, InlineBufferCapacity, Allocator >::contains(), CTX_data_active_object(), CTX_data_selected_objects(), Object::pose, and ptr.

Referenced by create_pose_asset_local(), and create_pose_asset_user_library().

pose_asset_create_exec()

wmOperatorStatus blender::ed::animrig::pose_asset_create_exec ( bContext * C, wmOperator * op )

static

Definition at line 355 of file anim_asset_ops.cc.

References ASSET_LIBRARY_CUSTOM, ASSET_LIBRARY_LOCAL, BKE_report(), BLI_assert_unreachable, C, create_pose_asset_local(), create_pose_asset_user_library(), blender::ed::asset::library_reference_from_enum_value(), MAX_NAME, name, OPERATOR_CANCELLED, OPERATOR_FINISHED, wmOperator::ptr, wmOperator::reports, RNA_enum_get(), RNA_property_is_set(), RNA_property_string_get(), RNA_struct_find_property(), RPT_ERROR, and AssetLibraryReference::type.

Referenced by POSELIB_OT_create_pose_asset().

pose_asset_create_invoke()

wmOperatorStatus blender::ed::animrig::pose_asset_create_invoke ( bContext * C, wmOperator * op, const wmEvent *  )

static

Definition at line 388 of file anim_asset_ops.cc.

References C, IFACE_, blender::ed::asset::library_reference_to_enum_value(), wmOperator::ptr, RNA_enum_set(), RNA_struct_property_is_set_ex(), U, blender::ed::asset::user_library_to_library_ref(), and WM_operator_props_dialog_popup().

Referenced by POSELIB_OT_create_pose_asset().

pose_asset_create_poll()

bool blender::ed::animrig::pose_asset_create_poll ( bContext * C )

static

Definition at line 404 of file anim_asset_ops.cc.

References C, and ED_operator_posemode_context().

Referenced by POSELIB_OT_create_pose_asset().

pose_asset_delete_exec()

wmOperatorStatus blender::ed::animrig::pose_asset_delete_exec ( bContext * C, wmOperator * op )

static

Definition at line 765 of file anim_asset_ops.cc.

References blender::bke::asset_edit_id_delete(), C, blender::ed::asset::clear_id(), CTX_data_main(), CTX_wm_asset(), ED_undo_push_op(), get_action_of_selected_asset(), bAction::id, ID_IS_LINKED, NA_REMOVED, NC_ASSET, ND_ASSET_LIST, OPERATOR_CANCELLED, OPERATOR_FINISHED, pose_asset_delete_exec(), blender::ed::asset::refresh_asset_library(), wmOperator::reports, and WM_main_add_notifier().

Referenced by pose_asset_delete_exec(), and POSELIB_OT_asset_delete().

pose_asset_delete_invoke()

wmOperatorStatus blender::ed::animrig::pose_asset_delete_invoke ( bContext * C, wmOperator * op, const wmEvent *  )

static

Definition at line 792 of file anim_asset_ops.cc.

References ALERT_ICON_WARNING, C, get_action_of_selected_asset(), ID_IS_LINKED, IFACE_, pose_asset_delete_invoke(), and WM_operator_confirm_ex().

Referenced by pose_asset_delete_invoke(), and POSELIB_OT_asset_delete().

pose_asset_delete_poll()

bool blender::ed::animrig::pose_asset_delete_poll ( bContext * C )

static

Definition at line 740 of file anim_asset_ops.cc.

References blender::bke::asset_edit_id_is_editable(), blender::bke::asset_edit_id_is_writable(), C, CTX_wm_operator_poll_msg_set(), get_action_of_selected_asset(), bAction::id, ID_IS_LINKED, and pose_asset_delete_poll().

Referenced by pose_asset_delete_poll(), and POSELIB_OT_asset_delete().

pose_asset_modify_description()

std::string blender::ed::animrig::pose_asset_modify_description ( bContext * , wmOperatorType * , PointerRNA * ptr )

static

Definition at line 711 of file anim_asset_ops.cc.

References pose_asset_modify_description(), prop_asset_overwrite_modes, ptr, RNA_enum_get(), and TIP_.

Referenced by pose_asset_modify_description(), and POSELIB_OT_asset_modify().

pose_asset_modify_exec()

wmOperatorStatus blender::ed::animrig::pose_asset_modify_exec ( bContext * C, wmOperator * op )

static

Definition at line 647 of file anim_asset_ops.cc.

References blender::bke::asset_edit_id_save(), BLI_assert_msg, C, CTX_data_active_object(), CTX_data_main(), CTX_wm_asset(), ED_undo_push_op(), G, blender::ed::asset::generate_preview(), get_action_of_selected_asset(), bAction::id, ID_IS_LINKED, NA_EDITED, NC_ASSET, ND_ASSET_LIST, OPERATOR_CANCELLED, OPERATOR_FINISHED, Object::pose, pose_asset_modify_exec(), wmOperator::ptr, blender::ed::asset::refresh_asset_library_from_asset(), wmOperator::reports, RNA_enum_get(), update_pose_action_from_scene(), and WM_main_add_notifier().

Referenced by pose_asset_modify_exec(), and POSELIB_OT_asset_modify().

pose_asset_modify_poll()

bool blender::ed::animrig::pose_asset_modify_poll ( bContext * C )

static

Definition at line 681 of file anim_asset_ops.cc.

References blender::bke::asset_edit_id_is_editable(), blender::bke::asset_edit_id_is_writable(), C, CTX_wm_operator_poll_msg_set(), ED_operator_posemode_context(), get_action_of_selected_asset(), bAction::id, ID_IS_LINKED, and pose_asset_modify_poll().

Referenced by pose_asset_modify_poll(), and POSELIB_OT_asset_modify().

POSELIB_OT_asset_delete()

void blender::ed::animrig::POSELIB_OT_asset_delete

(

wmOperatorType *

ot

)

Definition at line 810 of file anim_asset_ops.cc.

References ot, pose_asset_delete_exec(), pose_asset_delete_invoke(), pose_asset_delete_poll(), and POSELIB_OT_asset_delete().

Referenced by ED_operatortypes_anim(), and POSELIB_OT_asset_delete().

POSELIB_OT_asset_modify()

void blender::ed::animrig::POSELIB_OT_asset_modify

(

wmOperatorType *

ot

)

Definition at line 720 of file anim_asset_ops.cc.

References MODIFY_ADJUST, ot, pose_asset_modify_description(), pose_asset_modify_exec(), pose_asset_modify_poll(), POSELIB_OT_asset_modify(), prop_asset_overwrite_modes, and RNA_def_enum().

Referenced by ED_operatortypes_anim(), and POSELIB_OT_asset_modify().

POSELIB_OT_create_pose_asset()

void blender::ed::animrig::POSELIB_OT_create_pose_asset

(

wmOperatorType *

ot

)

Definition at line 426 of file anim_asset_ops.cc.

References MAX_NAME, OPTYPE_REGISTER, OPTYPE_UNDO, ot, pose_asset_create_exec(), pose_asset_create_invoke(), pose_asset_create_poll(), PROP_ENUM, PROP_NONE, PROP_STRING_SEARCH_SUGGESTION, rna_asset_library_reference_itemf(), RNA_def_enum_funcs(), RNA_def_property(), RNA_def_property_string_search_func_runtime(), RNA_def_property_ui_text(), RNA_def_string(), and visit_library_prop_catalogs_catalog_for_search_fn().

Referenced by ED_operatortypes_anim().

POSELIB_OT_screenshot_preview()

void blender::ed::animrig::POSELIB_OT_screenshot_preview

(

wmOperatorType *

ot

)

References ot.

replace_pose_key()

void blender::ed::animrig::replace_pose_key ( Main & bmain, blender::animrig::StripKeyframeData & strip_data, const blender::animrig::Slot & slot, const float2 time_value, const blender::animrig::FCurveDescriptor & fcurve_descriptor )

inlinestatic

Definition at line 543 of file anim_asset_ops.cc.

References BEZT_IPO_BEZ, BEZT_KEYTYPE_KEYFRAME, BKE_fcurve_delete_keys_all(), blender::animrig::StripKeyframeData::channelbag_for_slot_ensure(), blender::animrig::Channelbag::fcurve_ensure(), HD_AUTO, blender::animrig::insert_vert_fcurve(), and INSERTKEY_NOFLAGS.

rna_asset_library_reference_itemf()

const EnumPropertyItem * blender::ed::animrig::rna_asset_library_reference_itemf ( bContext * , PointerRNA * , PropertyRNA * , bool * r_free )

static

Definition at line 55 of file anim_asset_ops.cc.

References BLI_assert, and blender::ed::asset::library_reference_to_rna_enum_itemf().

Referenced by POSELIB_OT_create_pose_asset().

update_pose_action_from_scene()

void blender::ed::animrig::update_pose_action_from_scene ( Main * bmain, blender::animrig::Action & pose_action, Object & pose_object, const AssetModifyMode mode )

static

Definition at line 560 of file anim_asset_ops.cc.

References BLI_assert, BLI_assert_unreachable, blender::animrig::foreach_fcurve_in_action_slot(), generate_path_values(), blender::animrig::get_best_pose_slot_for_id(), ActionSlot::handle, Object::id, blender::animrig::Action::layers(), bAction::slot_array_num, and blender::animrig::Action::strip_keyframe_data().

Referenced by pose_asset_modify_exec().

visit_library_prop_catalogs_catalog_for_search_fn()

void blender::ed::animrig::visit_library_prop_catalogs_catalog_for_search_fn ( const bContext * C, PointerRNA * ptr, PropertyRNA * , const char * edit_text, FunctionRef< void(StringPropertySearchVisitParams)> visit_fn )

static

Definition at line 412 of file anim_asset_ops.cc.

References C, CTX_data_main(), blender::ed::asset::library_reference_from_enum_value(), ptr, RNA_enum_get(), and blender::ed::asset::visit_library_catalogs_catalog_for_search().

Referenced by POSELIB_OT_create_pose_asset().

Variable Documentation

prop_asset_overwrite_modes

const EnumPropertyItem blender::ed::animrig::prop_asset_overwrite_modes[]

static

Initial value:

                                                         = {
    {MODIFY_ADJUST,
     "ADJUST",
     0,
     "Adjust",
     "Update existing channels in the pose asset but don't remove or add any channels"},
    {MODIFY_REPLACE,
     "REPLACE",
     0,
     "Replace with Selection",
     "Completely replace all channels in the pose asset with the current selection"},
    {MODIFY_ADD,
     "ADD",
     0,
     "Add Selected Bones",
     "Add channels of the selection to the pose asset. Existing channels will be updated"},
    {MODIFY_REMOVE,
     "REMOVE",
     0,
     "Remove Selected Bones",
     "Remove channels of the selection from the pose asset"},
    {0, nullptr, 0, nullptr, nullptr},
}

Definition at line 457 of file anim_asset_ops.cc.

Referenced by pose_asset_modify_description(), and POSELIB_OT_asset_modify().