KeyingSetInfo(bpy_struct)

base class — bpy_struct

subclasses — Whole Character, Rotation, Available, Scaling, Location, LocRotScale

class bpy.types.KeyingSetInfo(bpy_struct)

Callback function defines for builtin Keying Sets

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 Insert Keyframes - Only Needed, Only insert keyframes where they’re needed in the relevant F-Curves.
• INSERTKEY_VISUAL Insert Keyframes - Visual, Insert keyframes based on ‘visual transforms’.
• INSERTKEY_XYZ_TO_RGB F-Curve Colors - XYZ to RGB, 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’}

poll(context)

Test if Keying Set can be used or not

Return type:boolean

iterator(context, ks)

Call generate() on the structs which have properties to be keyframed

generate(context, ks, data)

Add Paths to the Keying Set to keyframe the properties of the given data

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

KeyingSet.type_info