Anim Operators¶
-
bpy.ops.anim.
change_frame
(frame=0.0, snap=False)¶ Interactively change the current frame number
- Parameters
frame (float in [-1.04857e+06, 1.04857e+06], (optional)) – Frame
snap (boolean, (optional)) – Snap
-
bpy.ops.anim.
channel_select_keys
(extend=False)¶ Select all keyframes of channel under mouse
- Parameters
extend (boolean, (optional)) – Extend, Extend selection
-
bpy.ops.anim.
channels_clean_empty
()¶ Delete all empty animation data containers from visible data-blocks
-
bpy.ops.anim.
channels_click
(extend=False, children_only=False)¶ Handle mouse-clicks over animation channels
- Parameters
extend (boolean, (optional)) – Extend Select
children_only (boolean, (optional)) – Select Children Only
-
bpy.ops.anim.
channels_collapse
(all=True)¶ Collapse (i.e. close) all selected expandable animation channels
- Parameters
all (boolean, (optional)) – All, Collapse all channels (not just selected ones)
-
bpy.ops.anim.
channels_delete
()¶ Delete all selected animation channels
-
bpy.ops.anim.
channels_editable_toggle
(mode='TOGGLE', type='PROTECT')¶ Toggle editability of selected channels
- Parameters
mode (enum in ['TOGGLE', 'DISABLE', 'ENABLE', 'INVERT'], (optional)) – Mode
type (enum in ['PROTECT', 'MUTE'], (optional)) – Type
-
bpy.ops.anim.
channels_expand
(all=True)¶ Expand (i.e. open) all selected expandable animation channels
- Parameters
all (boolean, (optional)) – All, Expand all channels (not just selected ones)
-
bpy.ops.anim.
channels_fcurves_enable
()¶ Clears ‘disabled’ tag from all F-Curves to get broken F-Curves working again
-
bpy.ops.anim.
channels_find
(query="Query")¶ Filter the set of channels shown to only include those with matching names
- Parameters
query (string, (optional, never None)) – Text to search for in channel names
-
bpy.ops.anim.
channels_group
(name="New Group")¶ Add selected F-Curves to a new group
- Parameters
name (string, (optional, never None)) – Name, Name of newly created group
-
bpy.ops.anim.
channels_move
(direction='DOWN')¶ Rearrange selected animation channels
- Parameters
direction (enum in ['TOP', 'UP', 'DOWN', 'BOTTOM'], (optional)) – Direction
-
bpy.ops.anim.
channels_rename
()¶ Rename animation channel under mouse
-
bpy.ops.anim.
channels_select_all
(action='TOGGLE')¶ Toggle selection of all animation channels
- Parameters
action (enum in ['TOGGLE', 'SELECT', 'DESELECT', 'INVERT'], (optional)) –
Action, Selection action to execute
TOGGLE
Toggle, Toggle selection for all elements.SELECT
Select, Select all elements.DESELECT
Deselect, Deselect all elements.INVERT
Invert, Invert selection of all elements.
-
bpy.ops.anim.
channels_select_box
(xmin=0, xmax=0, ymin=0, ymax=0, wait_for_input=True, deselect=False, extend=True)¶ Select all animation channels within the specified region
- Parameters
xmin (int in [-inf, inf], (optional)) – X Min
xmax (int in [-inf, inf], (optional)) – X Max
ymin (int in [-inf, inf], (optional)) – Y Min
ymax (int in [-inf, inf], (optional)) – Y Max
wait_for_input (boolean, (optional)) – Wait for Input
deselect (boolean, (optional)) – Deselect, Deselect rather than select items
extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first
-
bpy.ops.anim.
channels_setting_disable
(mode='DISABLE', type='PROTECT')¶ Disable specified setting on all selected animation channels
- Parameters
mode (enum in ['TOGGLE', 'DISABLE', 'ENABLE', 'INVERT'], (optional)) – Mode
type (enum in ['PROTECT', 'MUTE'], (optional)) – Type
-
bpy.ops.anim.
channels_setting_enable
(mode='ENABLE', type='PROTECT')¶ Enable specified setting on all selected animation channels
- Parameters
mode (enum in ['TOGGLE', 'DISABLE', 'ENABLE', 'INVERT'], (optional)) – Mode
type (enum in ['PROTECT', 'MUTE'], (optional)) – Type
-
bpy.ops.anim.
channels_setting_toggle
(mode='TOGGLE', type='PROTECT')¶ Toggle specified setting on all selected animation channels
- Parameters
mode (enum in ['TOGGLE', 'DISABLE', 'ENABLE', 'INVERT'], (optional)) – Mode
type (enum in ['PROTECT', 'MUTE'], (optional)) – Type
-
bpy.ops.anim.
channels_ungroup
()¶ Remove selected F-Curves from their current groups
-
bpy.ops.anim.
clear_useless_actions
(only_unused=True)¶ Mark actions with no F-Curves for deletion after save & reload of file preserving “action libraries”
- Parameters
only_unused (boolean, (optional)) – Only Unused, Only unused (Fake User only) actions get considered
- File
Copy the driver for the highlighted button
Add driver for the property under the cursor
Edit the drivers for the property connected represented by the highlighted button
Remove the driver(s) for the property(s) connected represented by the highlighted button
- Parameters
all (boolean, (optional)) – All, Delete drivers for all elements of the array
-
bpy.ops.anim.
end_frame_set
()¶ Set the current frame as the preview or scene end frame
Clear all keyframes on the currently active property
- Parameters
all (boolean, (optional)) – All, Clear keyframes from all elements of the array
-
bpy.ops.anim.
keyframe_clear_v3d
()¶ Remove all keyframe animation for selected objects
-
bpy.ops.anim.
keyframe_delete
(type='DEFAULT', confirm_success=True)¶ Delete keyframes on the current frame for all properties in the specified Keying Set
- Parameters
type (enum in ['DEFAULT'], (optional)) – Keying Set, The Keying Set to use
confirm_success (boolean, (optional)) – Confirm Successful Delete, Show a popup when the keyframes get successfully removed
Delete current keyframe of current UI-active property
- Parameters
all (boolean, (optional)) – All, Delete keyframes from all elements of the array
-
bpy.ops.anim.
keyframe_delete_by_name
(type="Type", confirm_success=True)¶ Alternate access to ‘Delete Keyframe’ for keymaps to use
- Parameters
confirm_success (boolean, (optional)) – Confirm Successful Delete, Show a popup when the keyframes get successfully removed
-
bpy.ops.anim.
keyframe_delete_v3d
()¶ Remove keyframes on current frame for selected objects and bones
-
bpy.ops.anim.
keyframe_insert
(type='DEFAULT', confirm_success=True)¶ Insert keyframes on the current frame for all properties in the specified Keying Set
- Parameters
type (enum in ['DEFAULT'], (optional)) – Keying Set, The Keying Set to use
confirm_success (boolean, (optional)) – Confirm Successful Insert, Show a popup when the keyframes get successfully added
Insert a keyframe for current UI-active property
- Parameters
all (boolean, (optional)) – All, Insert a keyframe for all element of the array
-
bpy.ops.anim.
keyframe_insert_by_name
(type="Type", confirm_success=True)¶ Alternate access to ‘Insert Keyframe’ for keymaps to use
- Parameters
confirm_success (boolean, (optional)) – Confirm Successful Insert, Show a popup when the keyframes get successfully added
Insert Keyframes for specified Keying Set, with menu of available Keying Sets if undefined
- Parameters
type (enum in ['DEFAULT'], (optional)) – Keying Set, The Keying Set to use
confirm_success (boolean, (optional)) – Confirm Successful Insert, Show a popup when the keyframes get successfully added
always_prompt (boolean, (optional)) – Always Show Menu
-
bpy.ops.anim.
keying_set_active_set
(type='DEFAULT')¶ Select a new keying set as the active one
- Parameters
type (enum in ['DEFAULT'], (optional)) – Keying Set, The Keying Set to use
-
bpy.ops.anim.
keying_set_add
()¶ Add a new (empty) Keying Set to the active Scene
-
bpy.ops.anim.
keying_set_export
(filepath="", filter_folder=True, filter_text=True, filter_python=True)¶ Export Keying Set to a python script
- Parameters
filepath (string, (optional, never None)) – filepath
filter_folder (boolean, (optional)) – Filter folders
filter_text (boolean, (optional)) – Filter text
filter_python (boolean, (optional)) – Filter python
- File
-
bpy.ops.anim.
keying_set_path_add
()¶ Add empty path to active Keying Set
-
bpy.ops.anim.
keying_set_path_remove
()¶ Remove active Path from active Keying Set
-
bpy.ops.anim.
keying_set_remove
()¶ Remove the active Keying Set
Add current UI-active property to current keying set
- Parameters
all (boolean, (optional)) – All, Add all elements of the array to a Keying Set
Remove current UI-active property from current keying set
Paste the driver in the copy/paste buffer for the highlighted button
-
bpy.ops.anim.
previewrange_clear
()¶ Clear Preview Range
-
bpy.ops.anim.
previewrange_set
(xmin=0, xmax=0, ymin=0, ymax=0, wait_for_input=True)¶ Interactively define frame range used for playback
- Parameters
xmin (int in [-inf, inf], (optional)) – X Min
xmax (int in [-inf, inf], (optional)) – X Max
ymin (int in [-inf, inf], (optional)) – Y Min
ymax (int in [-inf, inf], (optional)) – Y Max
wait_for_input (boolean, (optional)) – Wait for Input
-
bpy.ops.anim.
start_frame_set
()¶ Set the current frame as the preview or scene start frame
-
bpy.ops.anim.
update_animated_transform_constraints
(use_convert_to_radians=True)¶ Update fcurves/drivers affecting Transform constraints (use it with files from 2.70 and earlier)
- Parameters
use_convert_to_radians (boolean, (optional)) – Convert To Radians, Convert fcurves/drivers affecting rotations to radians (Warning: use this only once!)
- File