KeyingSet Struct Reference

#include <DNA_anim_types.h>

Public Attributes
struct KeyingSet *	next
struct KeyingSet *	prev
ListBase	paths
char	idname [64]
char	name [64]
char	description [1024]
char	typeinfo [64]
int	active_path
short	flag
short	keyingflag
short	keyingoverride
char	_pad [6]

Detailed Description

KeyingSet definition (ks)

A KeyingSet defines a group of properties that should be keyframed together, providing a convenient way for animators to insert keyframes without resorting to Auto-Keyframing.

A few 'generic' (non-absolute and dependent on templates) KeyingSets are defined 'built-in' to facilitate easy animating for the casual animator without the need to add extra steps to the rigging process.

Definition at line 579 of file DNA_anim_types.h.

Member Data Documentation

_pad

char KeyingSet::_pad[6]

Definition at line 605 of file DNA_anim_types.h.

active_path

int KeyingSet::active_path

Index of the active path.

Definition at line 595 of file DNA_anim_types.h.

Referenced by add_empty_ks_path_exec(), add_keyingset_button_exec(), blender::ed::outliner::do_outliner_keyingset_editop(), keyingset_poll_activePath_edit(), and remove_active_ks_path_exec().

description

char KeyingSet::description[1024]

(RNA_DYN_DESCR_MAX) help text.

Definition at line 590 of file DNA_anim_types.h.

Referenced by build_keyingset_enum(), and blender::animrig::keyingset_info_register().

flag

short KeyingSet::flag

Settings for KeyingSet.

Definition at line 598 of file DNA_anim_types.h.

Referenced by ANIM_keyingset_context_ok_poll(), BKE_keyingset_add(), pose_select_same_keyingset(), blender::ed::object::select_grouped_keyingset(), and blender::animrig::validate_keyingset().

idname

char KeyingSet::idname[64]

Unique name (for search, etc.).

Definition at line 586 of file DNA_anim_types.h.

Referenced by BKE_keyingset_add(), and build_keyingset_enum().

keyingflag

short KeyingSet::keyingflag

(eInsertKeyFlags) settings to supply insertkey() with.

Definition at line 601 of file DNA_anim_types.h.

Referenced by blender::animrig::apply_keyingset(), and BKE_keyingset_add().

keyingoverride

short KeyingSet::keyingoverride

(eInsertKeyFlags) for each flag set, the relevant keyingflag bit overrides the default.

Definition at line 603 of file DNA_anim_types.h.

Referenced by blender::animrig::apply_keyingset(), and BKE_keyingset_add().

name

char KeyingSet::name[64]

User-viewable name for KeyingSet (for menus, etc.).

Definition at line 588 of file DNA_anim_types.h.

Referenced by add_keyingset_button_exec(), blender::animrig::apply_keyingset(), BKE_keyingset_add(), build_keyingset_enum(), delete_key_using_keying_set(), blender::animrig::insert_key_to_keying_set_path(), insert_key_with_keyingset(), and remove_keyingset_button_exec().

next

struct KeyingSet* KeyingSet::next

Definition at line 580 of file DNA_anim_types.h.

Referenced by BKE_keyingsets_free(), and build_keyingset_enum().

paths

ListBase KeyingSet::paths

(KS_Path) paths to keyframe to.

Definition at line 583 of file DNA_anim_types.h.

Referenced by add_empty_ks_path_exec(), add_keyingset_button_exec(), blender::animrig::apply_keyingset(), BKE_keyingset_add_path(), BKE_keyingset_find_path(), BKE_keyingset_free_path(), BKE_keyingset_free_paths(), blender::ed::outliner::do_outliner_keyingset_editop(), blender::animrig::keyingset_find_id(), keyingset_poll_activePath_edit(), pose_select_same_keyingset(), remove_active_ks_path_exec(), blender::ed::object::select_grouped_keyingset(), and blender::animrig::validate_keyingset().

prev

struct KeyingSet * KeyingSet::prev

Definition at line 580 of file DNA_anim_types.h.

typeinfo

char KeyingSet::typeinfo[64]

Name of the typeinfo data used for the relative paths.

Definition at line 592 of file DNA_anim_types.h.

Referenced by ANIM_keyingset_context_ok_poll(), blender::animrig::keyingset_info_register(), and blender::animrig::validate_keyingset().

---

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

• DNA_anim_types.h