ANIM_keyingsets.hh File Reference

Functionality to interact with keying sets. More...

#include "RNA_types.hh"

Go to the source code of this file.

Classes
struct	KeyingSetInfo

Namespaces
namespace	blender
namespace	blender::animrig

Typedefs
using	cbKeyingSet_Poll = bool (*)(KeyingSetInfo *ksi, bContext *C)
using	cbKeyingSet_Iterator = void (*)(KeyingSetInfo *ksi, bContext *C, KeyingSet *ks)
using	cbKeyingSet_Generate

Enumerations
enum class	blender::animrig::ModifyKeyMode { blender::animrig::INSERT = 0 , blender::animrig::DELETE_KEY }
enum class	blender::animrig::ModifyKeyReturn { blender::animrig::SUCCESS = 0 , blender::animrig::INVALID_CONTEXT = -1 , blender::animrig::MISSING_TYPEINFO = -2 }

Functions
Keyingset Usage
ModifyKeyReturn	blender::animrig::validate_keyingset (bContext *C, blender::Vector< PointerRNA > *sources, KeyingSet *keyingset)
int	blender::animrig::apply_keyingset (bContext *C, blender::Vector< PointerRNA > *sources, KeyingSet *keyingset, ModifyKeyMode mode, float cfra)
Queries
KeyingSet *	blender::animrig::builtin_keyingset_get_named (const char name[])
KeyingSetInfo *	blender::animrig::keyingset_info_find_name (const char name[])
bool	blender::animrig::keyingset_find_id (KeyingSet *keyingset, ID *id)
KeyingSet *	blender::animrig::get_keyingset_for_autokeying (const Scene *scene, const char *transformKSName)
KeyingSet *	blender::animrig::scene_get_active_keyingset (const Scene *scene)
Creation, Destruction
void	blender::animrig::keyingset_info_register (KeyingSetInfo *keyingset_info)
void	blender::animrig::keyingset_info_unregister (Main *bmain, KeyingSetInfo *keyingset_info)
void	blender::animrig::keyingset_infos_exit ()
void	blender::animrig::relative_keyingset_add_source (blender::Vector< PointerRNA > &sources, ID *id, StructRNA *srna, void *data)
void	blender::animrig::relative_keyingset_add_source (blender::Vector< PointerRNA > &sources, ID *id)

Variables
static constexpr const char *	ANIM_KS_LOCATION_ID = "Location"
static constexpr const char *	ANIM_KS_ROTATION_ID = "Rotation"
static constexpr const char *	ANIM_KS_SCALING_ID = "Scaling"
static constexpr const char *	ANIM_KS_LOC_ROT_SCALE_ID = "LocRotScale"
static constexpr const char *	ANIM_KS_LOC_ROT_SCALE_CPROP_ID = "LocRotScaleCProp"
static constexpr const char *	ANIM_KS_AVAILABLE_ID = "Available"
static constexpr const char *	ANIM_KS_WHOLE_CHARACTER_ID = "WholeCharacter"
static constexpr const char *	ANIM_KS_WHOLE_CHARACTER_SELECTED_ID = "WholeCharacterSelected"

Detailed Description

Functionality to interact with keying sets.

Definition in file ANIM_keyingsets.hh.

Typedef Documentation

cbKeyingSet_Generate

using cbKeyingSet_Generate

Initial value:

void (*)(KeyingSetInfo *ksi,
                                     bContext *C,
                                     KeyingSet *ks,
                                     PointerRNA *ptr)

Property Specifier Callback for KeyingSets (called from iterators)

Definition at line 41 of file ANIM_keyingsets.hh.

cbKeyingSet_Iterator

using cbKeyingSet_Iterator = void (*)(KeyingSetInfo *ksi, bContext *C, KeyingSet *ks)

Context Iterator Callback for KeyingSets.

Definition at line 39 of file ANIM_keyingsets.hh.

cbKeyingSet_Poll

using cbKeyingSet_Poll = bool (*)(KeyingSetInfo *ksi, bContext *C)

Polling Callback for KeyingSets.

Definition at line 37 of file ANIM_keyingsets.hh.

Variable Documentation

ANIM_KS_AVAILABLE_ID

const char* ANIM_KS_AVAILABLE_ID = "Available"

staticconstexpr

Definition at line 32 of file ANIM_keyingsets.hh.

Referenced by blender::animrig::get_keyingset_for_autokeying().

ANIM_KS_LOC_ROT_SCALE_CPROP_ID

const char* ANIM_KS_LOC_ROT_SCALE_CPROP_ID = "LocRotScaleCProp"

staticconstexpr

Definition at line 31 of file ANIM_keyingsets.hh.

ANIM_KS_LOC_ROT_SCALE_ID

const char* ANIM_KS_LOC_ROT_SCALE_ID = "LocRotScale"

staticconstexpr

Definition at line 30 of file ANIM_keyingsets.hh.

Referenced by pose_clear_transforms_exec().

ANIM_KS_LOCATION_ID

const char* ANIM_KS_LOCATION_ID = "Location"

staticconstexpr

Definition at line 27 of file ANIM_keyingsets.hh.

Referenced by blender::ed::object::object_location_clear_exec(), pose_clear_loc_exec(), snap_sel_to_grid_exec(), and snap_selected_to_location_rotation().

ANIM_KS_ROTATION_ID

const char* ANIM_KS_ROTATION_ID = "Rotation"

staticconstexpr

Definition at line 28 of file ANIM_keyingsets.hh.

Referenced by blender::ed::object::object_rotation_clear_exec(), and pose_clear_rot_exec().

ANIM_KS_SCALING_ID

const char* ANIM_KS_SCALING_ID = "Scaling"

staticconstexpr

Definition at line 29 of file ANIM_keyingsets.hh.

Referenced by blender::ed::object::object_scale_clear_exec(), and pose_clear_scale_exec().

ANIM_KS_WHOLE_CHARACTER_ID

const char* ANIM_KS_WHOLE_CHARACTER_ID = "WholeCharacter"

staticconstexpr

Definition at line 33 of file ANIM_keyingsets.hh.

Referenced by pose_paste_exec(), and poseAnim_mapping_autoKeyframe().

ANIM_KS_WHOLE_CHARACTER_SELECTED_ID

const char* ANIM_KS_WHOLE_CHARACTER_SELECTED_ID = "WholeCharacterSelected"

staticconstexpr

Definition at line 34 of file ANIM_keyingsets.hh.