Package bpy :: Package ops :: Module anim
[hide private]
[frames] | no frames]

Module anim

Functions [hide private]
 
change_frame(frame=0)
Interactively change the current frame number.
 
channels_click(extend=False, children_only=False)
Handle mouse-clicks over animation channels.
 
channels_collapse(all=False)
Collapse (i.e.
 
channels_delete()
Delete all selected animation channels.
 
channels_editable_toggle(mode='TOGGLE', type='PROTECT')
Toggle editability of selected channels.
 
channels_expand(all=False)
Expand (i.e.
 
channels_select_all_toggle(invert=False)
Toggle selection of all animation channels.
 
channels_select_border(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0)
Select all animation channels within the specified region.
 
channels_setting_disable(mode='DISABLE', type='PROTECT')
Disable specified setting on all selected animation channels.
 
channels_setting_enable(mode='ENABLE', type='PROTECT')
Enable specified setting on all selected animation channels.
 
channels_setting_toggle(mode='TOGGLE', type='PROTECT')
Toggle specified setting on all selected animation channels.
 
channels_visibility_set()
Make only the selected animation channels visible in the Graph Editor.
 
channels_visibility_toggle()
Toggle visibility in Graph Editor of all selected animation channels.
 
copy_clipboard_button()
Copy the RNA data path for this property to the clipboard.
 
copy_driver_button()
Copy the driver for the highlighted button.
 
driver_button_add(all=True)
Add driver(s) for the property(s) connected represented by the highlighted button.
 
driver_button_remove(all=True)
Remove the driver(s) for the property(s) connected represented by the highlighted button.
 
keyframe_delete(type=0, confirm_success=True)
Delete keyframes on the current frame for all properties in the specified Keying Set.
 
keyframe_delete_button(all=True)
(undocumented operator)
 
keyframe_delete_v3d()
(undocumented operator)
 
keyframe_insert(type=0, confirm_success=True)
Insert keyframes on the current frame for all properties in the specified Keying Set.
 
keyframe_insert_button(all=True)
(undocumented operator)
 
keyframe_insert_menu(type=0, confirm_success=False, always_prompt=False)
(undocumented operator)
 
keying_set_add()
Add a new (empty) Keying Set to the active Scene.
 
keying_set_path_add()
Add empty path to active Keying Set
 
keying_set_path_remove()
Remove active Path from active Keying Set.
 
keying_set_remove()
Remove the active Keying Set.
 
keyingset_button_add(all=True)
(undocumented operator)
 
keyingset_button_remove()
(undocumented operator)
 
paste_driver_button()
Paste the driver in the copy/paste buffer for the highlighted button.
 
previewrange_clear()
(undocumented operator)
 
previewrange_set(xmin=0, xmax=0, ymin=0, ymax=0)
(undocumented operator)
 
time_toggle()
(undocumented operator)
Function Details [hide private]

change_frame(frame=0)

 

Interactively change the current frame number.

Parameters:
  • frame (int) - in (-300000, 300000)

channels_click(extend=False, children_only=False)

 

Handle mouse-clicks over animation channels.

Parameters:
  • children_only (boolean)
  • extend (boolean)

channels_collapse(all=False)

 

Collapse (i.e. close) all selected expandable animation channels.

Parameters:
  • all (boolean)

channels_editable_toggle(mode='TOGGLE', type='PROTECT')

 

Toggle editability of selected channels.

Parameters:
  • mode (enum) - in (DISABLE, ENABLE, TOGGLE)
  • type (enum) - in (PROTECT, MUTE)

channels_expand(all=False)

 

Expand (i.e. open) all selected expandable animation channels.

Parameters:
  • all (boolean)

channels_select_all_toggle(invert=False)

 

Toggle selection of all animation channels.

Parameters:
  • invert (boolean)

channels_select_border(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0)

 

Select all animation channels within the specified region.

Parameters:
  • gesture_mode (int) - in (-inf, inf)
  • xmin (int) - in (-inf, inf)
  • xmax (int) - in (-inf, inf)
  • ymin (int) - in (-inf, inf)
  • ymax (int) - in (-inf, inf)

channels_setting_disable(mode='DISABLE', type='PROTECT')

 

Disable specified setting on all selected animation channels.

Parameters:
  • mode (enum) - in (DISABLE, ENABLE, TOGGLE)
  • type (enum) - in (PROTECT, MUTE)

channels_setting_enable(mode='ENABLE', type='PROTECT')

 

Enable specified setting on all selected animation channels.

Parameters:
  • mode (enum) - in (DISABLE, ENABLE, TOGGLE)
  • type (enum) - in (PROTECT, MUTE)

channels_setting_toggle(mode='TOGGLE', type='PROTECT')

 

Toggle specified setting on all selected animation channels.

Parameters:
  • mode (enum) - in (DISABLE, ENABLE, TOGGLE)
  • type (enum) - in (PROTECT, MUTE)

driver_button_add(all=True)

 

Add driver(s) for the property(s) connected represented by the highlighted button.

Parameters:
  • all (boolean)

driver_button_remove(all=True)

 

Remove the driver(s) for the property(s) connected represented by the highlighted button.

Parameters:
  • all (boolean)

keyframe_delete(type=0, confirm_success=True)

 

Delete keyframes on the current frame for all properties in the specified Keying Set.

Parameters:
  • type (int) - Index (determined internally) of the Keying Set to use in (-inf, inf)
  • confirm_success (boolean)

keyframe_delete_button(all=True)

 

(undocumented operator)

Parameters:
  • all (boolean)

keyframe_insert(type=0, confirm_success=True)

 

Insert keyframes on the current frame for all properties in the specified Keying Set.

Parameters:
  • type (int) - Index (determined internally) of the Keying Set to use in (-inf, inf)
  • confirm_success (boolean)

keyframe_insert_button(all=True)

 

(undocumented operator)

Parameters:
  • all (boolean)

keyframe_insert_menu(type=0, confirm_success=False, always_prompt=False)

 

(undocumented operator)

Parameters:
  • type (int) - Index (determined internally) of the Keying Set to use in (-inf, inf)
  • always_prompt (boolean)
  • confirm_success (boolean)

keyingset_button_add(all=True)

 

(undocumented operator)

Parameters:
  • all (boolean)

previewrange_set(xmin=0, xmax=0, ymin=0, ymax=0)

 

(undocumented operator)

Parameters:
  • xmin (int) - in (-inf, inf)
  • xmax (int) - in (-inf, inf)
  • ymin (int) - in (-inf, inf)
  • ymax (int) - in (-inf, inf)