blender/release/scripts/keyingsets/keyingsets_builtins.py

# Built-In Keying Sets
# None of these Keying Sets should be removed, as these
# are needed by various parts of Blender in order for them
# to work correctly.

import bpy
from keyingsets_utils import *

###############################
# Built-In KeyingSets

# Location
class BUILTIN_KSI_Location(bpy.types.KeyingSetInfo):
    bl_label = "Location"

    # poll - use predefined callback for selected bones/objects
    poll = RKS_POLL_selected_items

    # iterator - use callback for selected bones/objects
    iterator = RKS_ITER_selected_item

    # generator - use callback for location 
    generate = RKS_GEN_location

# Rotation
class BUILTIN_KSI_Rotation(bpy.types.KeyingSetInfo):
    bl_label = "Rotation"

    # poll - use predefined callback for selected bones/objects
    poll = RKS_POLL_selected_items

    # iterator - use callback for selected bones/objects
    iterator = RKS_ITER_selected_item

    # generator - use callback for location 
    generate = RKS_GEN_rotation

# Scale
class BUILTIN_KSI_Scaling(bpy.types.KeyingSetInfo):
    bl_label = "Scaling"

    # poll - use predefined callback for selected bones/objects
    poll = RKS_POLL_selected_items

    # iterator - use callback for selected bones/objects
    iterator = RKS_ITER_selected_item

    # generator - use callback for location 
    generate = RKS_GEN_scaling

# ------------

# LocRot
class BUILTIN_KSI_LocRot(bpy.types.KeyingSetInfo):
    bl_label = "LocRot"

    # poll - use predefined callback for selected bones/objects
    poll = RKS_POLL_selected_items

    # iterator - use callback for selected bones/objects
    iterator = RKS_ITER_selected_item

    # generator 
    def generate(self, context, ks, data):
        # location
        RKS_GEN_location(self, context, ks, data)
        # rotation
        RKS_GEN_rotation(self, context, ks, data)

# LocScale
class BUILTIN_KSI_LocScale(bpy.types.KeyingSetInfo):
    bl_label = "LocScale"

    # poll - use predefined callback for selected bones/objects
    poll = RKS_POLL_selected_items

    # iterator - use callback for selected bones/objects
    iterator = RKS_ITER_selected_item

    # generator 
    def generate(self, context, ks, data):
        # location
        RKS_GEN_location(self, context, ks, data)
        # scale
        RKS_GEN_scaling(self, context, ks, data)

# LocRotScale
class BUILTIN_KSI_LocRotScale(bpy.types.KeyingSetInfo):
    bl_label = "LocRotScale"

    # poll - use predefined callback for selected bones/objects
    poll = RKS_POLL_selected_items

    # iterator - use callback for selected bones/objects
    iterator = RKS_ITER_selected_item

    # generator 
    def generate(self, context, ks, data):
        # location
        RKS_GEN_location(self, context, ks, data)
        # rotation
        RKS_GEN_rotation(self, context, ks, data)
        # scale
        RKS_GEN_scaling(self, context, ks, data)

# RotScale
class BUILTIN_KSI_RotScale(bpy.types.KeyingSetInfo):
    bl_label = "RotScale"

    # poll - use predefined callback for selected bones/objects
    poll = RKS_POLL_selected_items

    # iterator - use callback for selected bones/objects
    iterator = RKS_ITER_selected_item

    # generator 
    def generate(self, context, ks, data):
        # rotation
        RKS_GEN_rotation(self, context, ks, data)
        # scaling
        RKS_GEN_scaling(self, context, ks, data)
        
# ------------

# Location
class BUILTIN_KSI_VisualLoc(bpy.types.KeyingSetInfo):
    bl_label = "Visual Location"

    bl_options = {'INSERTKEY_VISUAL'}

    # poll - use predefined callback for selected bones/objects
    poll = RKS_POLL_selected_items

    # iterator - use callback for selected bones/objects
    iterator = RKS_ITER_selected_item

    # generator - use callback for location 
    generate = RKS_GEN_location

# Rotation
class BUILTIN_KSI_VisualRot(bpy.types.KeyingSetInfo):
    bl_label = "Visual Rotation"

    bl_options = {'INSERTKEY_VISUAL'}

    # poll - use predefined callback for selected bones/objects
    poll = RKS_POLL_selected_items

    # iterator - use callback for selected bones/objects
    iterator = RKS_ITER_selected_item

    # generator - use callback for rotation 
    generate = RKS_GEN_rotation

# VisualLocRot
class BUILTIN_KSI_VisualLocRot(bpy.types.KeyingSetInfo):
    bl_label = "Visual LocRot"

    bl_options = {'INSERTKEY_VISUAL'}

    # poll - use predefined callback for selected bones/objects
    poll = RKS_POLL_selected_items

    # iterator - use callback for selected bones/objects
    iterator = RKS_ITER_selected_item

    # generator  
    def generate(self, context, ks, data):
        # location
        RKS_GEN_location(self, context, ks, data)
        # rotation
        RKS_GEN_rotation(self, context, ks, data)

# ------------

# Available
class BUILTIN_KSI_Available(bpy.types.KeyingSetInfo):
    bl_label = "Available"

    # poll - use predefined callback for selected objects
    # TODO: this should really check whether the selected object (or datablock) 
    #         has any animation data defined yet
    poll = RKS_POLL_selected_objects

    # iterator - use callback for selected bones/objects
    iterator = RKS_ITER_selected_item

    # generator - use callback for doing this 
    generate = RKS_GEN_available

############################### 

# All properties that are likely to get animated in a character rig
class BUILTIN_KSI_WholeCharacter(bpy.types.KeyingSetInfo):
    bl_label = "Whole Character"
    
    # these prefixes should be avoided, as they are not really bones
    # that animators should be touching (or need to touch)
    badBonePrefixes = (
        'DEF', 
        'GEO', 
        'MCH', 
        'ORG',
        'COR',
        'VIS',
        # ... more can be added here as you need in your own rigs ...
    )
    
    # poll - pose-mode on active object only
    def poll(ksi, context):
        return ((context.active_object) and (context.active_object.pose) and
                (context.active_object.mode == 'POSE'))

    # iterator - all bones regardless of selection
    def iterator(ksi, context, ks):
        for bone in context.active_object.pose.bones:
            if not bone.name.startswith(BUILTIN_KSI_WholeCharacter.badBonePrefixes):
                ksi.generate(context, ks, bone)

    # generator - all unlocked bone transforms + custom properties
    def generate(ksi, context, ks, bone):
        # loc, rot, scale - only include unlocked ones
        ksi.doLoc(ks, bone)
        
        if bone.rotation_mode in ('QUATERNION', 'AXIS_ANGLE'):
            ksi.doRot4d(ks, bone)
        else:
            ksi.doRot3d(ks, bone)
        ksi.doScale(ks, bone)
        
        # custom props?
        ksi.doCustomProps(ks, bone)
        
    # ----------------
    
    # helper to add some bone's property to the Keying Set
    def addProp(ksi, ks, bone, prop, index=-1, use_groups=True):        
        # add the property name to the base path
        id_path = bone.path_from_id()
        id_block = bone.id_data
		
        if prop.startswith('['): 
            # custom properties
            path = id_path + prop
        else: 
            # standard transforms/properties
            path = path_add_property(id_path, prop)
        
        # add Keying Set entry for this...
        if use_groups:
            ks.paths.add(id_block, path, index, group_method='NAMED', group_name=bone.name)
        else:
            ks.paths.add(id_block, path, index)
    
    # ----------------
    
    # location properties
    def doLoc(ksi, ks, bone):
        if bone.lock_location == (False, False, False):
            ksi.addProp(ks, bone, "location")
        else:
            for i in range(3):
                if not bone.lock_location[i]:
                    ksi.addProp(ks, bone, "location", i)
    
    # rotation properties
    def doRot4d(ksi, ks, bone):
        # rotation mode affects the property used
        if bone.rotation_mode == 'QUATERNION':
            prop = "rotation_quaternion"
        elif bone.rotation_mode == 'AXIS_ANGLE':
            prop = "rotation_axis_angle"
        
        # add rotation properties if they will
        if bone.lock_rotations_4d:
            # can check individually
            if (bone.lock_rotation == (False, False, False)) and (bone.lock_rotation_w == False):
                ksi.addProp(ks, bone, prop)
            else:
                if bone.lock_rotation_w == False:
                    ksi.addProp(ks, bone, prop, 0) # w = 0
                
                for i in range(3):
                    if not bone.lock_rotation[i]:
                        ksi.addProp(ks, bone, prop, i+1) # i+1, since here x,y,z = 1,2,3, and w=0
        elif True not in bone.lock_rotation:
            # if axis-angle rotations get locked as eulers, then it's too messy to allow anything 
            # other than all open unless we keyframe the whole lot
            ksi.addProp(ks, bone, prop)
        
    def doRot3d(ksi, ks, bone):
        if bone.lock_rotation == (False, False, False):
            ksi.addProp(ks, bone, "rotation_euler")
        else:
            for i in range(3):
                if not bone.lock_rotation[i]:
                    ksi.addProp(ks, bone, "rotation_euler", i)
            
    # scale properties
    def doScale(ksi, ks, bone):
        if bone.lock_scale == (0,0,0):
            ksi.addProp(ks, bone, "scale")
        else:
            for i in range(3):
                if not bone.lock_scale[i]:
                    ksi.addProp(ks, bone, "scale", i)
                    
    # ----------------
    
    # custom properties
    def doCustomProps(ksi, ks, bone):
        # go over all custom properties for bone
        for prop,val in bone.items():
            # ignore special "_RNA_UI" used for UI editing
            if prop == "_RNA_UI":
                continue
            
            # for now, just add all of 'em
            ksi.addProp(ks, bone, '["%s"]' % (prop))

############################### 

classes = [
    BUILTIN_KSI_Location,
    BUILTIN_KSI_Rotation,
    BUILTIN_KSI_Scaling,

    BUILTIN_KSI_LocRot,
    BUILTIN_KSI_LocScale,
    BUILTIN_KSI_LocRotScale,
    BUILTIN_KSI_RotScale,
    
    BUILTIN_KSI_WholeCharacter,

    BUILTIN_KSI_VisualLoc,
    BUILTIN_KSI_VisualRot,
    BUILTIN_KSI_VisualLocRot,

    BUILTIN_KSI_Available,
]


def register():
    register = bpy.types.register
    for cls in classes:
        register(cls)


def unregister():
    unregister = bpy.types.unregister
    for cls in classes:
        unregister(cls)

if __name__ == "__main__":
    register()

###############################