KeyingSetInfo(bpy_struct)

base class — bpy_struct

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 to use when inserting keyframes

  • 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’}
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

classmethod bl_rna_get_subclass(id, default=None)
Parameters:id (string) – The RNA type identifier.
Returns:The RNA type or default when not found.
Return type:bpy.types.Struct subclass
classmethod bl_rna_get_subclass_py(id, default=None)
Parameters:id (string) – The RNA type identifier.
Returns:The class or default when not found.
Return type:type

Inherited Properties

Inherited Functions

References