KeyingSet(bpy_struct)

base class — bpy_struct

class bpy.types.KeyingSet(bpy_struct)

Settings that should be keyframed together

bl_description

A short description of the keying set

Type :string, default “”, (never None)

bl_idname

If this is set, the Keying Set gets a custom ID, otherwise it takes the name of the class used to define the Keying Set (for example, if the class name is “BUILTIN_KSI_location”, and bl_idname is not set by the script, then bl_idname = “BUILTIN_KSI_location”)

Type :string, default “”, (never None)

bl_label

Type :string, default “”, (never None)

bl_options

Keying set options

• INSERTKEY_NEEDED Only Needed, Only insert keyframes where they’re needed in the relevant F-Curves.
• INSERTKEY_VISUAL Visual Keying, Insert keyframes based on ‘visual transforms’.
• INSERTKEY_XYZ_TO_RGB XYZ=RGB Colors, Color for newly added transformation F-Curves (Location, Rotation, Scale) and also Color is based on the transform axis.

Type :enum set in {‘INSERTKEY_NEEDED’, ‘INSERTKEY_VISUAL’, ‘INSERTKEY_XYZ_TO_RGB’}, default {‘INSERTKEY_NEEDED’}

is_path_absolute

Keying Set defines specific paths/settings to be keyframed (i.e. is not reliant on context info)

Type :boolean, default False, (readonly)

paths

Keying Set Paths to define settings that get keyframed together

Type :KeyingSetPaths bpy_prop_collection of KeyingSetPath, (readonly)

type_info

Callback function defines for built-in Keying Sets

Type :KeyingSetInfo, (readonly)

refresh()

Refresh Keying Set to ensure that it is valid for the current context (call before each use of one)

Inherited Properties

bpy_struct.id_data

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_set

bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

KeyingSetInfo.generate KeyingSetInfo.iterator KeyingSets.active KeyingSets.new

KeyingSetsAll.active Scene.keying_sets Scene.keying_sets_all