Blender Indexall=True) Add driver(s) for the property(s) connected represented by the highlighted...
Transcript of Blender Indexall=True) Add driver(s) for the property(s) connected represented by the highlighted...
-
Blender IndexRelease 2.54 - UNSTABLE API
Blender Foundation
October 23, 2010
-
CONTENTS
1 Application Modules 31.1 Data Access (bpy.data) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.2 Operators (bpy.ops) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41.3 Types (bpy.types) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1411.4 Utilities (bpy.utils) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10051.5 Path Utilities (bpy.path) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10071.6 Application Data (bpy.app) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10081.7 Property Definitions (bpy.props) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1008
2 Standalone Modules 10112.1 Math Types & Utilities (mathutils) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10112.2 Font Drawing (blf) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10402.3 Audio System (aud) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1042
3 Game Engine Modules 10513.1 Game Engine bge.types Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10513.2 Game Engine bge.logic Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11223.3 Game Engine bge.render Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11363.4 Game Engine bge.events module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1139
Python Module Index 1145
Index 1147
i
-
ii
-
Blender Index, Release 2.54 - UNSTABLE API
This document is an API reference for Blender 2.54 . built Unknown.
An introduction to Blender and Python can be found at
A PDF version of this document is also available
Warning: The Python API in Blender is UNSTABLE, It should only be used for testing, any script written nowmay break in future releases.The following areas are subject to change.
operator names and arguments render api function calls with the data api (any function calls with values accessed from bpy.data), including
functions for importing and exporting meshes class registration (Operator, Panels, Menus, Headers) modules: bpy.props, blf) members in the bpy.context have to be reviewed python defined modal operators, especially drawing callbacks are highly experemental
These parts of the API are relatively stable and are unlikely to change significantly data API, access to attributes of blender data such as mesh verts, material color, timeline frames and
scene objects user interface functions for defining buttons, creation of menus, headers, panels modules: bgl, mathutils and geometry game engine modules
CONTENTS 1
http://wiki.blender.org/index.php/Dev:2.5/Py/API/Intro
-
Blender Index, Release 2.54 - UNSTABLE API
2 CONTENTS
-
CHAPTER
ONE
APPLICATION MODULES
1.1 Data Access (bpy.data)
This module is used for all blender/python access.
import bpy
# print all objectsfor obj in bpy.data.objects:
print(obj.name)
# print all scene names in a listprint(bpy.data.scenes.keys())
# remove mesh Cubeif "Cube" in bpy.data.meshes:
mesh = bpy.data.meshes["Cube"]print("removing mesh", mesh)bpy.data.meshes.unlink(mesh)
# write images into a file next to the blendimport osfile = open(os.path.splitext(bpy.data.filepath)[0] + ".txt", w)
for image in bpy.data.images:file.write("%s %dx%d\n" % (image.filepath, image.size[0], image.size[1]))
file.close()
bpy.dataAccess to blenders internal data
Type bpy.types.BlendData
3
-
Blender Index, Release 2.54 - UNSTABLE API
1.2 Operators (bpy.ops)
1.2.1 Action Operators
bpy.ops.action.clean(threshold=0.001)Simplify F-Curves by removing closely spaced keyframes
Parameters
threshold (float in [0, inf], (optional)) Threshold
bpy.ops.action.clickselect(left_right=OFF, extend=False, column=False)Select keyframes by clicking on them
Parameters
left_right (enum in [CHECK, OFF, LEFT, RIGHT], (optional, never None)) LeftRight
extend (boolean, (optional)) Extend Select
column (boolean, (optional)) Column Select
bpy.ops.action.copy()Copy selected keyframes to the copy/paste buffer
bpy.ops.action.delete()Remove all selected keyframes
bpy.ops.action.duplicate(mode=17)Make a copy of all selected keyframes
Parameters
mode (int in [0, inf], (optional)) Mode
bpy.ops.action.extrapolation_type(type=CONSTANT)Set extrapolation mode for selected F-Curves
Parameters
type (enum in [CONSTANT, LINEAR], (optional, never None)) Type
bpy.ops.action.frame_jump()Set the current frame to the average frame of the selected keyframes
bpy.ops.action.handle_type(type=FREE)Set type of handle for selected keyframes
Parameters
type (enum in [FREE, VECTOR, ALIGNED, AUTO, ANIM_CLAMPED], (optional,never None)) Type
bpy.ops.action.interpolation_type(type=CONSTANT)Set interpolation mode for the F-Curve segments starting from the selected keyframes
Parameters
type (enum in [CONSTANT, LINEAR, BEZIER], (optional, never None)) Type
bpy.ops.action.keyframe_insert(type=ALL)Insert keyframes for the specified channels
Parameters
4 Chapter 1. Application Modules
-
Blender Index, Release 2.54 - UNSTABLE API
type (enum in [ALL, SEL, GROUP], (optional, never None)) Type
bpy.ops.action.keyframe_type(type=KEYFRAME)Set type of keyframe for the seleced keyframes
Parameters
type (enum in [KEYFRAME, BREAKDOWN, EXTREME], (optional, never None)) Type
bpy.ops.action.mirror(type=CFRA)Flip selected keyframes over the selected mirror line
Parameters
type (enum in [CFRA, XAXIS, MARKER], (optional, never None)) Type
bpy.ops.action.new()Create new action
bpy.ops.action.paste()Paste keyframes from copy/paste buffer for the selected channels, starting on the current frame
bpy.ops.action.previewrange_set()Set Preview Range based on extents of selected Keyframes
bpy.ops.action.sample()Add keyframes on every frame between the selected keyframes
bpy.ops.action.select_all_toggle(invert=False)Toggle selection of all keyframes
Parameters
invert (boolean, (optional)) Invert
bpy.ops.action.select_border(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0,axis_range=False)
Select all keyframes within the specified region
Parameters
gesture_mode (int in [-inf, inf], (optional)) Gesture Mode
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
axis_range (boolean, (optional)) Axis Range
bpy.ops.action.select_column(mode=KEYS)Select all keyframes on the specified frame(s)
Parameters
mode (enum in [KEYS, CFRA, MARKERS_COLUMN, MARKERS_BETWEEN], (op-tional, never None)) Mode
bpy.ops.action.select_less()Deselect keyframes on ends of selection islands
bpy.ops.action.select_linked()Select keyframes occurring the same F-Curves as selected ones
1.2. Operators (bpy.ops) 5
-
Blender Index, Release 2.54 - UNSTABLE API
bpy.ops.action.select_more()Select keyframes beside already selected ones
bpy.ops.action.snap(type=CFRA)Snap selected keyframes to the times specified
Parameters
type (enum in [CFRA, NEAREST_FRAME, NEAREST_SECOND, NEAR-EST_MARKER], (optional, never None)) Type
bpy.ops.action.view_all()Reset viewable area to show full keyframe range
1.2.2 Anim Operators
bpy.ops.anim.change_frame(frame=0)Interactively change the current frame number
Parameters
frame (int in [-300000, 300000], (optional)) Frame
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, never None)) Mode
type (enum in [PROTECT, MUTE], (optional, never None)) 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_select_all_toggle(invert=False)Toggle selection of all animation channels
Parameters
invert (boolean, (optional)) Invert
6 Chapter 1. Application Modules
-
Blender Index, Release 2.54 - UNSTABLE API
bpy.ops.anim.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], (optional)) Gesture Mode
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
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, never None)) Mode
type (enum in [PROTECT, MUTE], (optional, never None)) 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, never None)) Mode
type (enum in [PROTECT, MUTE], (optional, never None)) Type
bpy.ops.anim.channels_setting_toggle(mode=INVERT, type=PROTECT)Invert specified setting on all selected animation channels
Parameters
mode (enum in [TOGGLE, DISABLE, ENABLE, INVERT], (optional, never None)) Mode
type (enum in [PROTECT, MUTE], (optional, never None)) Type
bpy.ops.anim.channels_visibility_set()Make only the selected animation channels visible in the Graph Editor
bpy.ops.anim.channels_visibility_toggle()Toggle visibility in Graph Editor of all selected animation channels
bpy.ops.anim.copy_driver_button()Copy the driver for the highlighted button
bpy.ops.anim.driver_button_add(all=True)Add driver(s) for the property(s) connected represented by the highlighted button
Parameters
all (boolean, (optional)) All, Create drivers for all elements of the array.
bpy.ops.anim.driver_button_remove(all=True)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.
1.2. Operators (bpy.ops) 7
-
Blender Index, Release 2.54 - UNSTABLE API
bpy.ops.anim.keyframe_delete(type=0, confirm_success=True)Delete keyframes on the current frame for all properties in the specified Keying Set
Parameters
type (int in [-inf, inf], (optional)) Keying Set Number, Index (determined internally) ofthe Keying Set to use
confirm_success (boolean, (optional)) Confirm Successful Insert, Show a popup whenthe keyframes get successfully added
bpy.ops.anim.keyframe_delete_button(all=True)Undocumented (contribute)
Parameters
all (boolean, (optional)) All, Delete keyfames from all elements of the array.
bpy.ops.anim.keyframe_delete_v3d()Undocumented (contribute)
bpy.ops.anim.keyframe_insert(type=0, confirm_success=True)Insert keyframes on the current frame for all properties in the specified Keying Set
Parameters
type (int in [-inf, inf], (optional)) Keying Set Number, Index (determined internally) ofthe Keying Set to use
confirm_success (boolean, (optional)) Confirm Successful Insert, Show a popup whenthe keyframes get successfully added
bpy.ops.anim.keyframe_insert_button(all=True)Undocumented (contribute)
Parameters
all (boolean, (optional)) All, Insert a keyframe for all element of the array.
bpy.ops.anim.keyframe_insert_menu(type=0, confirm_success=False, always_prompt=False)Undocumented (contribute)
Parameters
type (int in [-inf, inf], (optional)) Keying Set Number, Index (determined internally) ofthe Keying Set to use
confirm_success (boolean, (optional)) Confirm Successful Insert, Show a popup whenthe keyframes get successfully added
always_prompt (boolean, (optional)) Always Show Menu
bpy.ops.anim.keying_set_active_set(type=0)Undocumented (contribute)
Parameters
type (int in [-inf, inf], (optional)) Keying Set Number, Index (determined internally) ofthe 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, fil-ter_python=True)
Export Keying Set to a python script.
8 Chapter 1. Application Modules
http://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.anim.keyframe_delete_buttonhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.anim.keyframe_delete_v3dhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.anim.keyframe_insert_buttonhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.anim.keyframe_insert_menuhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.anim.keying_set_active_set
-
Blender Index, Release 2.54 - UNSTABLE API
Parameters
filepath (string, (optional)) File Path, Filepath to write file to.
filter_folder (boolean, (optional)) Filter folders
filter_text (boolean, (optional)) Filter text
filter_python (boolean, (optional)) Filter python
File ui/properties_scene.py:218
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
bpy.ops.anim.keyingset_button_add(all=True)Undocumented (contribute)
Parameters
all (boolean, (optional)) All, Add all elements of the array to a Keying Set.
bpy.ops.anim.keyingset_button_remove()Undocumented (contribute)
bpy.ops.anim.paste_driver_button()Paste the driver in the copy/paste buffer for the highlighted button
bpy.ops.anim.previewrange_clear()Undocumented (contribute)
bpy.ops.anim.previewrange_set(xmin=0, xmax=0, ymin=0, ymax=0)Undocumented (contribute)
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
bpy.ops.anim.time_toggle()Undocumented (contribute)
bpy.ops.anim.update_data_paths()Update data paths from 2.53 to edited data paths of drivers and fcurves
File op/animsys_update.py:692
1.2.3 Armature Operators
bpy.ops.armature.align()Align selected bones to the active bone (or to their parent)
1.2. Operators (bpy.ops) 9
https://svn.blender.org/svnroot/bf-blender/trunk/blender/release/scripts/ui/properties_scene.pyhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.anim.keyingset_button_addhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.anim.keyingset_button_removehttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.anim.previewrange_clearhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.anim.previewrange_sethttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.anim.time_togglehttps://svn.blender.org/svnroot/bf-blender/trunk/blender/release/scripts/op/animsys_update.py
-
Blender Index, Release 2.54 - UNSTABLE API
bpy.ops.armature.armature_layers(layers=(False, False, False, False, False, False, False, False,False, False, False, False, False, False, False, False, False,False, False, False, False, False, False, False, False, False,False, False, False, False, False, False))
Change the visible armature layers
Parameters
layers (boolean array of 32 items, (optional)) Layer, Armature layers to make visible
bpy.ops.armature.autoside_names(type=XAXIS)Automatically renames the selected bones according to which side of the target axis they fall on
Parameters
type (enum in [XAXIS, YAXIS, ZAXIS], (optional)) Axis, Axis tag names with.
bpy.ops.armature.bone_layers(layers=(False, False, False, False, False, False, False, False, False,False, False, False, False, False, False, False, False, False, False,False, False, False, False, False, False, False, False, False, False,False, False, False))
Change the layers that the selected bones belong to
Parameters
layers (boolean array of 32 items, (optional)) Layer, Armature layers that bone belongsto
bpy.ops.armature.bone_primitive_add(name=Bone)Undocumented (contribute)
Parameters
name (string, (optional)) Name, Name of the newly created bone
bpy.ops.armature.calculate_roll(type=GLOBALUP)Undocumented (contribute)
Parameters
type (enum in [GLOBALUP, CURSOR], (optional, never None)) Type
bpy.ops.armature.click_extrude()Undocumented (contribute)
bpy.ops.armature.delete()Undocumented (contribute)
bpy.ops.armature.duplicate()Undocumented (contribute)
bpy.ops.armature.duplicate_move(ARMATURE_OT_duplicate=None, TRANS-FORM_OT_translate=None)
Undocumented (contribute)
Parameters
ARMATURE_OT_duplicate (ARMATURE_OT_duplicate, (optional)) Duplicate Se-lected Bone(s)
TRANSFORM_OT_translate (TRANSFORM_OT_translate, (optional)) Translate,Translate selected items
bpy.ops.armature.extrude(forked=False)Undocumented (contribute)
10 Chapter 1. Application Modules
http://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.armature.bone_primitive_addhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.armature.calculate_rollhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.armature.click_extrudehttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.armature.deletehttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.armature.duplicatehttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.armature.duplicate_movehttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.armature.extrude
-
Blender Index, Release 2.54 - UNSTABLE API
Parameters
forked (boolean, (optional)) Forked
bpy.ops.armature.extrude_forked(ARMATURE_OT_extrude=None, TRANS-FORM_OT_translate=None)
Undocumented (contribute)
Parameters
ARMATURE_OT_extrude (ARMATURE_OT_extrude, (optional)) Extrude
TRANSFORM_OT_translate (TRANSFORM_OT_translate, (optional)) Translate,Translate selected items
bpy.ops.armature.extrude_move(ARMATURE_OT_extrude=None, TRANS-FORM_OT_translate=None)
Undocumented (contribute)
Parameters
ARMATURE_OT_extrude (ARMATURE_OT_extrude, (optional)) Extrude
TRANSFORM_OT_translate (TRANSFORM_OT_translate, (optional)) Translate,Translate selected items
bpy.ops.armature.fill()Add bone between selected joint(s) and/or 3D-Cursor
bpy.ops.armature.flags_set(type=DRAWWIRE, mode=CLEAR)Set flags for armature bones
Parameters
type (enum in [DRAWWIRE, DEFORM, MULT_VG, HINGE, NO_SCALE,LOCKED], (optional, never None)) Type
mode (enum in [CLEAR, ENABLE, TOGGLE], (optional, never None)) Mode
bpy.ops.armature.flip_names()Flips (and corrects) the names of selected bones
bpy.ops.armature.hide()Undocumented (contribute)
bpy.ops.armature.merge(type=WITHIN_CHAIN)Merge continuous chains of selected bones
Parameters
type (enum in [WITHIN_CHAIN], (optional, never None)) Type
bpy.ops.armature.parent_clear(type=CLEAR)Undocumented (contribute)
Parameters
type (enum in [CLEAR, DISCONNECT], (optional, never None)) ClearType, Whatway to clear parenting
bpy.ops.armature.parent_set(type=CONNECTED)Undocumented (contribute)
Parameters
type (enum in [CONNECTED, OFFSET], (optional, never None)) ParentType, Typeof parenting
1.2. Operators (bpy.ops) 11
http://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.armature.extrude_forkedhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.armature.extrude_movehttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.armature.hidehttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.armature.parent_clearhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.armature.parent_set
-
Blender Index, Release 2.54 - UNSTABLE API
bpy.ops.armature.reveal()Undocumented (contribute)
bpy.ops.armature.select_all(action=TOGGLE)Undocumented (contribute)
Parameters
action (enum in [TOGGLE, SELECT, DESELECT, INVERT], (optional, neverNone)) Action, Selection action to execute
bpy.ops.armature.select_hierarchy(direction=PARENT, extend=False)Undocumented (contribute)
Parameters
direction (enum in [PARENT, CHILD], (optional, never None)) Direction
extend (boolean, (optional)) Add to Selection
bpy.ops.armature.select_inverse()Undocumented (contribute)
bpy.ops.armature.select_linked(extend=False)Undocumented (contribute)
Parameters
extend (boolean, (optional)) Extend, Extend selection instead of deselecting everythingfirst.
bpy.ops.armature.separate()Isolate selected bones into a separate armature
bpy.ops.armature.subdivide(number_cuts=1)Undocumented (contribute)
Parameters
number_cuts (int in [1, inf], (optional)) Number of Cuts
bpy.ops.armature.switch_direction()Undocumented (contribute)
1.2.4 Boid Operators
bpy.ops.boid.rule_add(type=GOAL)Add a boid rule to the current boid state
Parameters
type (enum in [GOAL, AVOID, AVOID_COLLISION, SEPARATE, FLOCK, FOL-LOW_LEADER, AVERAGE_SPEED, FIGHT], (optional)) Type
bpy.ops.boid.rule_del()Undocumented (contribute)
bpy.ops.boid.rule_move_down()Move boid rule down in the list
bpy.ops.boid.rule_move_up()Move boid rule up in the list
12 Chapter 1. Application Modules
http://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.armature.revealhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.armature.select_allhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.armature.select_hierarchyhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.armature.select_inversehttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.armature.select_linkedhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.armature.subdividehttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.armature.switch_directionhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.boid.rule_del
-
Blender Index, Release 2.54 - UNSTABLE API
bpy.ops.boid.state_add()Add a boid state to the particle system
bpy.ops.boid.state_del()Undocumented (contribute)
bpy.ops.boid.state_move_down()Move boid state down in the list
bpy.ops.boid.state_move_up()Move boid state up in the list
1.2.5 Brush Operators
bpy.ops.brush.add()Add brush by mode type
bpy.ops.brush.curve_preset(shape=SMOOTH)Set brush shape
Parameters
shape (enum in [SHARP, SMOOTH, MAX, LINE, ROUND, ROOT], (optional)) Mode
bpy.ops.brush.reset()Return brush to defaults based on current tool
bpy.ops.brush.scale_size(scalar=1.0)Change brush size by a scalar
Parameters
scalar (float in [0, 2], (optional)) Scalar, Factor to scale brush size by
1.2.6 Buttons Operators
bpy.ops.buttons.file_browse(filepath=, filter_blender=False, filter_image=False, fil-ter_movie=False, filter_python=False, filter_font=False, fil-ter_sound=False, filter_text=False, filter_btx=False, fil-ter_collada=False, filter_folder=False, filemode=9, rela-tive_path=False)
Open a file browser, Hold Shift to open the file, Alt to browse containing directory
Parameters
filepath (string, (optional)) File Path, Path to file
filter_blender (boolean, (optional)) Filter .blend files
filter_image (boolean, (optional)) Filter image files
filter_movie (boolean, (optional)) Filter movie files
filter_python (boolean, (optional)) Filter python files
filter_font (boolean, (optional)) Filter font files
filter_sound (boolean, (optional)) Filter sound files
filter_text (boolean, (optional)) Filter text files
1.2. Operators (bpy.ops) 13
http://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.boid.state_del
-
Blender Index, Release 2.54 - UNSTABLE API
filter_btx (boolean, (optional)) Filter btx files
filter_collada (boolean, (optional)) Filter COLLADA files
filter_folder (boolean, (optional)) Filter folders
filemode (int in [1, 9], (optional)) File Browser Mode, The setting for the file browsermode to load a .blend file, a library or a special file
relative_path (boolean, (optional)) Relative Path, Select the file relative to the blend file
bpy.ops.buttons.toolbox()Display button panel toolbox
1.2.7 Cloth Operators
bpy.ops.cloth.preset_add(name=, remove_active=False)Add a Cloth Preset
Parameters
name (string, (optional)) Name, Name of the preset, used to make the path name
File op/presets.py:42
1.2.8 Console Operators
bpy.ops.console.autocomplete()Evaluate the namespace up until the cursor and give a list of options or complete the name if there is only one
File ui/space_console.py:145
bpy.ops.console.banner()Print a message whem the terminal initializes
File ui/space_console.py:162
bpy.ops.console.clear(scrollback=True, history=False)Clear text by type
Parameters
scrollback (boolean, (optional)) Scrollback, Clear the scrollback history
history (boolean, (optional)) History, Clear the command history
bpy.ops.console.copy()Copy selected text to clipboard
bpy.ops.console.delete(type=NEXT_CHARACTER)Delete text by cursor position
Parameters
type (enum in [NEXT_CHARACTER, PREVIOUS_CHARACTER], (optional, neverNone)) Type, Which part of the text to delete.
bpy.ops.console.execute()Execute the current console line as a python expression
File ui/space_console.py:123
14 Chapter 1. Application Modules
https://svn.blender.org/svnroot/bf-blender/trunk/blender/release/scripts/op/presets.pyhttps://svn.blender.org/svnroot/bf-blender/trunk/blender/release/scripts/ui/space_console.pyhttps://svn.blender.org/svnroot/bf-blender/trunk/blender/release/scripts/ui/space_console.pyhttps://svn.blender.org/svnroot/bf-blender/trunk/blender/release/scripts/ui/space_console.py
-
Blender Index, Release 2.54 - UNSTABLE API
bpy.ops.console.history_append(text=, current_character=0, remove_duplicates=False)Append history at cursor position
Parameters
text (string, (optional)) Text, Text to insert at the cursor position.
current_character (int in [0, inf], (optional)) Cursor, The index of the cursor.
remove_duplicates (boolean, (optional)) Remove Duplicates, Remove duplicate items inthe history
bpy.ops.console.history_cycle(reverse=False)Cycle through history
Parameters
reverse (boolean, (optional)) Reverse, reverse cycle history
bpy.ops.console.insert(text=)Insert text at cursor position
Parameters
text (string, (optional)) Text, Text to insert at the cursor position.
bpy.ops.console.language(language=)Set the current language for this console
Parameters
language (string, (optional)) Language
File ui/space_console.py:185
bpy.ops.console.move(type=LINE_BEGIN)Move cursor position
Parameters
type (enum in [LINE_BEGIN, LINE_END, PREVIOUS_CHARACTER,NEXT_CHARACTER, PREVIOUS_WORD, NEXT_WORD], (optional, never None)) Type, Where to move cursor to.
bpy.ops.console.paste()Paste text from clipboard
bpy.ops.console.report_copy()Copy selected reports to Clipboard
bpy.ops.console.report_delete()Delete selected reports
bpy.ops.console.report_replay()Replay selected reports
bpy.ops.console.scrollback_append(text=, type=OUTPUT)Append scrollback text by type
Parameters
text (string, (optional)) Text, Text to insert at the cursor position.
type (enum in [OUTPUT, INPUT, INFO, ERROR], (optional)) Type, Console out-put type.
1.2. Operators (bpy.ops) 15
https://svn.blender.org/svnroot/bf-blender/trunk/blender/release/scripts/ui/space_console.py
-
Blender Index, Release 2.54 - UNSTABLE API
bpy.ops.console.select_all_toggle()(de)select all reports
bpy.ops.console.select_border(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0)Toggle border selection
Parameters
gesture_mode (int in [-inf, inf], (optional)) Gesture Mode
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
bpy.ops.console.select_pick(report_index=0)Select reports by index
Parameters
report_index (int in [0, inf], (optional)) Report, The index of the report.
bpy.ops.console.select_set()Set the console selection
1.2.9 Constraint Operators
bpy.ops.constraint.childof_clear_inverse(constraint=, owner=OBJECT)Clear inverse correction for ChildOf constraint
Parameters
constraint (string, (optional)) Constraint, Name of the constraint to edit
owner (enum in [OBJECT, BONE], (optional)) Owner, The owner of this constraint
bpy.ops.constraint.childof_set_inverse(constraint=, owner=OBJECT)Set inverse correction for ChildOf constraint
Parameters
constraint (string, (optional)) Constraint, Name of the constraint to edit
owner (enum in [OBJECT, BONE], (optional)) Owner, The owner of this constraint
bpy.ops.constraint.delete()Remove constraint from constraint stack
bpy.ops.constraint.limitdistance_reset(constraint=, owner=OBJECT)Reset limiting distance for Limit Distance Constraint
Parameters
constraint (string, (optional)) Constraint, Name of the constraint to edit
owner (enum in [OBJECT, BONE], (optional)) Owner, The owner of this constraint
bpy.ops.constraint.move_down(constraint=, owner=OBJECT)Move constraint down in constraint stack
Parameters
constraint (string, (optional)) Constraint, Name of the constraint to edit
16 Chapter 1. Application Modules
-
Blender Index, Release 2.54 - UNSTABLE API
owner (enum in [OBJECT, BONE], (optional)) Owner, The owner of this constraint
bpy.ops.constraint.move_up(constraint=, owner=OBJECT)Move constraint up in constraint stack
Parameters
constraint (string, (optional)) Constraint, Name of the constraint to edit
owner (enum in [OBJECT, BONE], (optional)) Owner, The owner of this constraint
bpy.ops.constraint.stretchto_reset(constraint=, owner=OBJECT)Reset original length of bone for Stretch To Constraint
Parameters
constraint (string, (optional)) Constraint, Name of the constraint to edit
owner (enum in [OBJECT, BONE], (optional)) Owner, The owner of this constraint
1.2.10 Curve Operators
bpy.ops.curve.cyclic_toggle(direction=CYCLIC_U)Undocumented (contribute)
Parameters
direction (enum in [CYCLIC_U, CYCLIC_V], (optional, never None)) Direction, Di-rection to make surface cyclic in.
bpy.ops.curve.de_select_first()Undocumented (contribute)
bpy.ops.curve.de_select_last()Undocumented (contribute)
bpy.ops.curve.delete(type=SELECTED)Undocumented (contribute)
Parameters
type (enum in [SELECTED, SEGMENT, ALL], (optional, never None)) Type, Whichelements to delete.
bpy.ops.curve.duplicate(mode=1)Undocumented (contribute)
Parameters
mode (int in [0, inf], (optional)) Mode
bpy.ops.curve.extrude(mode=1)Undocumented (contribute)
Parameters
mode (int in [0, inf], (optional)) Mode
bpy.ops.curve.handle_type_set(type=AUTOMATIC)Undocumented (contribute)
Parameters
type (enum in [AUTOMATIC, VECTOR, TOGGLE_FREE_ALIGN, ALIGN,FREE_ALIGN], (optional)) Type, Spline type
1.2. Operators (bpy.ops) 17
http://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.cyclic_togglehttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.de_select_firsthttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.de_select_lasthttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.deletehttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.duplicatehttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.extrudehttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.handle_type_set
-
Blender Index, Release 2.54 - UNSTABLE API
bpy.ops.curve.hide(unselected=False)Undocumented (contribute)
Parameters
unselected (boolean, (optional)) Unselected, Hide unselected rather than selected.
bpy.ops.curve.make_segment()Undocumented (contribute)
bpy.ops.curve.primitive_bezier_circle_add(view_align=False, enter_editmode=False, loca-tion=(0.0, 0.0, 0.0), rotation=(0.0, 0.0, 0.0), lay-ers=(False, False, False, False, False, False,False, False, False, False, False, False, False,False, False, False, False, False, False, False))
Construct a Bezier Circle
Parameters
view_align (boolean, (optional)) Align to View, Align the new object to the view.
enter_editmode (boolean, (optional)) Enter Editmode, Enter editmode when adding thisobject.
location (float array of 3 items in [-inf, inf], (optional)) Location, Location for the newlyadded object.
rotation (float array of 3 items in [-inf, inf], (optional)) Rotation, Rotation for the newlyadded object
layers (boolean array of 20 items, (optional)) Layer
bpy.ops.curve.primitive_bezier_curve_add(view_align=False, enter_editmode=False, loca-tion=(0.0, 0.0, 0.0), rotation=(0.0, 0.0, 0.0), lay-ers=(False, False, False, False, False, False,False, False, False, False, False, False, False,False, False, False, False, False, False, False))
Construct a Bezier Curve
Parameters
view_align (boolean, (optional)) Align to View, Align the new object to the view.
enter_editmode (boolean, (optional)) Enter Editmode, Enter editmode when adding thisobject.
location (float array of 3 items in [-inf, inf], (optional)) Location, Location for the newlyadded object.
rotation (float array of 3 items in [-inf, inf], (optional)) Rotation, Rotation for the newlyadded object
layers (boolean array of 20 items, (optional)) Layer
bpy.ops.curve.primitive_nurbs_circle_add(view_align=False, enter_editmode=False, loca-tion=(0.0, 0.0, 0.0), rotation=(0.0, 0.0, 0.0), lay-ers=(False, False, False, False, False, False,False, False, False, False, False, False, False,False, False, False, False, False, False, False))
Construct a Nurbs Circle
Parameters
view_align (boolean, (optional)) Align to View, Align the new object to the view.
18 Chapter 1. Application Modules
http://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.hidehttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.make_segment
-
Blender Index, Release 2.54 - UNSTABLE API
enter_editmode (boolean, (optional)) Enter Editmode, Enter editmode when adding thisobject.
location (float array of 3 items in [-inf, inf], (optional)) Location, Location for the newlyadded object.
rotation (float array of 3 items in [-inf, inf], (optional)) Rotation, Rotation for the newlyadded object
layers (boolean array of 20 items, (optional)) Layer
bpy.ops.curve.primitive_nurbs_curve_add(view_align=False, enter_editmode=False, loca-tion=(0.0, 0.0, 0.0), rotation=(0.0, 0.0, 0.0), lay-ers=(False, False, False, False, False, False, False,False, False, False, False, False, False, False,False, False, False, False, False, False))
Construct a Nurbs Curve
Parameters
view_align (boolean, (optional)) Align to View, Align the new object to the view.
enter_editmode (boolean, (optional)) Enter Editmode, Enter editmode when adding thisobject.
location (float array of 3 items in [-inf, inf], (optional)) Location, Location for the newlyadded object.
rotation (float array of 3 items in [-inf, inf], (optional)) Rotation, Rotation for the newlyadded object
layers (boolean array of 20 items, (optional)) Layer
bpy.ops.curve.primitive_nurbs_path_add(view_align=False, enter_editmode=False, lo-cation=(0.0, 0.0, 0.0), rotation=(0.0, 0.0, 0.0),layers=(False, False, False, False, False, False,False, False, False, False, False, False, False, False,False, False, False, False, False, False))
Construct a Path
Parameters
view_align (boolean, (optional)) Align to View, Align the new object to the view.
enter_editmode (boolean, (optional)) Enter Editmode, Enter editmode when adding thisobject.
location (float array of 3 items in [-inf, inf], (optional)) Location, Location for the newlyadded object.
rotation (float array of 3 items in [-inf, inf], (optional)) Rotation, Rotation for the newlyadded object
layers (boolean array of 20 items, (optional)) Layer
bpy.ops.curve.radius_set(radius=1.0)Undocumented (contribute)
Parameters
radius (float in [0, inf], (optional)) Radius
bpy.ops.curve.reveal()Undocumented (contribute)
1.2. Operators (bpy.ops) 19
http://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.radius_sethttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.reveal
-
Blender Index, Release 2.54 - UNSTABLE API
bpy.ops.curve.select_all(action=TOGGLE)Undocumented (contribute)
Parameters
action (enum in [TOGGLE, SELECT, DESELECT, INVERT], (optional, neverNone)) Action, Selection action to execute
bpy.ops.curve.select_inverse()Undocumented (contribute)
bpy.ops.curve.select_less()Undocumented (contribute)
bpy.ops.curve.select_linked(deselect=False, location=(0, 0))Undocumented (contribute)
Parameters
deselect (boolean, (optional)) Deselect, Deselect linked control points rather than select-ing them.
location (int array of 2 items in [0, inf], (optional)) Location
bpy.ops.curve.select_more()Undocumented (contribute)
bpy.ops.curve.select_next()Undocumented (contribute)
bpy.ops.curve.select_nth(nth=2)Undocumented (contribute)
Parameters
nth (int in [2, 100], (optional)) Nth Selection
bpy.ops.curve.select_previous()Undocumented (contribute)
bpy.ops.curve.select_random(percent=50.0, extend=False)Undocumented (contribute)
Parameters
percent (float in [0, 100], (optional)) Percent, Percentage of elements to select randomly.
extend (boolean, (optional)) Extend Selection, Extend selection instead of deselectingeverything first.
bpy.ops.curve.select_row()Undocumented (contribute)
bpy.ops.curve.separate()Undocumented (contribute)
bpy.ops.curve.shade_flat()Undocumented (contribute)
bpy.ops.curve.shade_smooth()Undocumented (contribute)
bpy.ops.curve.smooth()Undocumented (contribute)
20 Chapter 1. Application Modules
http://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.select_allhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.select_inversehttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.select_lesshttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.select_linkedhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.select_morehttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.select_nexthttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.select_nthhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.select_previoushttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.select_randomhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.select_rowhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.separatehttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.shade_flathttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.shade_smoothhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.smooth
-
Blender Index, Release 2.54 - UNSTABLE API
bpy.ops.curve.smooth_radius()Undocumented (contribute)
bpy.ops.curve.spin(center=(0.0, 0.0, 0.0), axis=(0.0, 0.0, 0.0))Undocumented (contribute)
Parameters
center (float array of 3 items in [-inf, inf], (optional)) Center, Center in global view space
axis (float array of 3 items in [-1, 1], (optional)) Axis, Axis in global view space
bpy.ops.curve.spline_type_set(type=POLY)Undocumented (contribute)
Parameters
type (enum in [POLY, BEZIER, NURBS], (optional)) Type, Spline type
bpy.ops.curve.spline_weight_set(weight=1.0)Undocumented (contribute)
Parameters
weight (float in [0, 1], (optional)) Weight
bpy.ops.curve.subdivide(number_cuts=1)Undocumented (contribute)
Parameters
number_cuts (int in [1, 100], (optional)) Number of cuts
bpy.ops.curve.switch_direction()Undocumented (contribute)
bpy.ops.curve.tilt_clear()Undocumented (contribute)
bpy.ops.curve.vertex_add(location=(0.0, 0.0, 0.0))Undocumented (contribute)
Parameters
location (float array of 3 items in [-inf, inf], (optional)) Location, Location to add newvertex at.
1.2.11 Ed Operators
bpy.ops.ed.redo()Redo previous action
bpy.ops.ed.undo()Undo previous action
1.2.12 Export Operators
bpy.ops.export.ply(filepath=, check_existing=True, use_modifiers=True, use_normals=True,use_uv_coords=True, use_colors=True)
Export a single object as a stanford PLY with normals, colours and texture coordinates.
Parameters
1.2. Operators (bpy.ops) 21
http://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.smooth_radiushttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.spinhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.spline_type_sethttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.spline_weight_sethttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.subdividehttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.switch_directionhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.tilt_clearhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.curve.vertex_add
-
Blender Index, Release 2.54 - UNSTABLE API
filepath (string, (optional)) File Path, Filepath used for exporting the file
check_existing (boolean, (optional)) Check Existing, Check and warn on overwritingexisting files
use_modifiers (boolean, (optional)) Apply Modifiers, Apply Modifiers to the exportedmesh
use_normals (boolean, (optional)) Normals, Export Normals for smooth and hard shadedfaces
use_uv_coords (boolean, (optional)) UVs, Exort the active UV layer
use_colors (boolean, (optional)) Vertex Colors, Exort the active vertex color layer
File op/io_mesh_ply/__init__.py:46
1.2.13 Export_scene Operators
bpy.ops.export_scene.autodesk_3ds(filepath=, check_existing=True)Export to 3DS file format (.3ds)
Parameters
filepath (string, (optional)) File Path, Filepath used for exporting the file
check_existing (boolean, (optional)) Check Existing, Check and warn on overwritingexisting files
File op/io_scene_3ds/__init__.py:57
bpy.ops.export_scene.fbx(filepath=, check_existing=True, EXP_OBS_SELECTED=True,TX_SCALE=1.0, TX_XROT90=True, TX_YROT90=False,TX_ZROT90=False, EXP_EMPTY=True, EXP_CAMERA=True,EXP_LAMP=True, EXP_ARMATURE=True, EXP_MESH=True,EXP_MESH_APPLY_MOD=True, EXP_MESH_HQ_NORMALS=True,EXP_IMAGE_COPY=False, ANIM_ENABLE=True,ANIM_OPTIMIZE=True, ANIM_OPTIMIZE_PRECISSION=6.0,ANIM_ACTION_ALL=False, BATCH_ENABLE=False,BATCH_GROUP=False, BATCH_OWN_DIR=True,BATCH_FILE_PREFIX=)
Selection to an ASCII Autodesk FBX
Parameters
filepath (string, (optional)) File Path, Filepath used for exporting the file
check_existing (boolean, (optional)) Check Existing, Check and warn on overwritingexisting files
EXP_OBS_SELECTED (boolean, (optional)) Selected Objects, Export selected objectson visible layers
TX_SCALE (float in [0.01, 1000], (optional)) Scale, Scale all data, (Note! some importsdont support scaled armatures)
TX_XROT90 (boolean, (optional)) Rot X90, Rotate all objects 90 degrees about the Xaxis
TX_YROT90 (boolean, (optional)) Rot Y90, Rotate all objects 90 degrees about the Yaxis
22 Chapter 1. Application Modules
https://svn.blender.org/svnroot/bf-blender/trunk/blender/release/scripts/op/io_mesh_ply/__init__.pyhttps://svn.blender.org/svnroot/bf-blender/trunk/blender/release/scripts/op/io_scene_3ds/__init__.py
-
Blender Index, Release 2.54 - UNSTABLE API
TX_ZROT90 (boolean, (optional)) Rot Z90, Rotate all objects 90 degrees about the Zaxis
EXP_EMPTY (boolean, (optional)) Empties, Export empty objects
EXP_CAMERA (boolean, (optional)) Cameras, Export camera objects
EXP_LAMP (boolean, (optional)) Lamps, Export lamp objects
EXP_ARMATURE (boolean, (optional)) Armatures, Export armature objects
EXP_MESH (boolean, (optional)) Meshes, Export mesh objects
EXP_MESH_APPLY_MOD (boolean, (optional)) Modifiers, Apply modifiers to meshobjects
EXP_MESH_HQ_NORMALS (boolean, (optional)) HQ Normals, Generate high qual-ity normals
EXP_IMAGE_COPY (boolean, (optional)) Copy Image Files, Copy image files to thedestination path
ANIM_ENABLE (boolean, (optional)) Enable Animation, Export keyframe animation
ANIM_OPTIMIZE (boolean, (optional)) Optimize Keyframes, Remove doublekeyframes
ANIM_OPTIMIZE_PRECISSION (float in [1, 16], (optional)) Precision, Tolerence forcomparing double keyframes (higher for greater accuracy)
ANIM_ACTION_ALL (boolean, (optional)) All Actions, Use all actions for armatures,if false, use current action
BATCH_ENABLE (boolean, (optional)) Enable Batch, Automate exporting multiplescenes or groups to files
BATCH_GROUP (boolean, (optional)) Group > File, Export each group as an FBX file,if false, export each scene as an FBX file
BATCH_OWN_DIR (boolean, (optional)) Own Dir, Create a dir for each exported file
BATCH_FILE_PREFIX (string, (optional)) Prefix, Prefix each file with this name
File op/io_scene_fbx/__init__.py:69
bpy.ops.export_scene.obj(filepath=, check_existing=True, use_selection=False,use_all_scenes=False, use_animation=False, use_modifiers=True,use_rotate_x90=True, use_edges=True, use_normals=False,use_hq_normals=True, use_uvs=True, use_materials=True,copy_images=False, use_triangles=False, use_vertex_groups=False,use_nurbs=False, use_blen_objects=True, group_by_object=False,group_by_material=False, keep_vertex_order=False)
Save a Wavefront OBJ File
Parameters
filepath (string, (optional)) File Path, Filepath used for exporting the file
check_existing (boolean, (optional)) Check Existing, Check and warn on overwritingexisting files
use_selection (boolean, (optional)) Selection Only, Export selected objects only
use_all_scenes (boolean, (optional)) All Scenes
use_animation (boolean, (optional)) Animation
1.2. Operators (bpy.ops) 23
https://svn.blender.org/svnroot/bf-blender/trunk/blender/release/scripts/op/io_scene_fbx/__init__.py
-
Blender Index, Release 2.54 - UNSTABLE API
use_modifiers (boolean, (optional)) Apply Modifiers, Apply modifiers (preview resolu-tion)
use_rotate_x90 (boolean, (optional)) Rotate X90
use_edges (boolean, (optional)) Edges
use_normals (boolean, (optional)) Normals
use_hq_normals (boolean, (optional)) High Quality Normals
use_uvs (boolean, (optional)) UVs
use_materials (boolean, (optional)) Materials
copy_images (boolean, (optional)) Copy Images
use_triangles (boolean, (optional)) Triangulate
use_vertex_groups (boolean, (optional)) Polygroups
use_nurbs (boolean, (optional)) Nurbs
use_blen_objects (boolean, (optional)) Objects as OBJ Objects
group_by_object (boolean, (optional)) Objects as OBJ Groups
group_by_material (boolean, (optional)) Material Groups
keep_vertex_order (boolean, (optional)) Keep Vertex Order
File op/io_scene_obj/__init__.py:115
bpy.ops.export_scene.x3d(filepath=, check_existing=True, use_apply_modifiers=True,use_triangulate=False, use_compress=False)
Export selection to Extensible 3D file (.x3d)
Parameters
filepath (string, (optional)) File Path, Filepath used for exporting the file
check_existing (boolean, (optional)) Check Existing, Check and warn on overwritingexisting files
use_apply_modifiers (boolean, (optional)) Apply Modifiers, Use transformed mesh datafrom each object
use_triangulate (boolean, (optional)) Triangulate, Triangulate quads.
use_compress (boolean, (optional)) Compress, GZip the resulting file, requires a fullpython install
File op/io_scene_x3d/__init__.py:42
1.2.14 Export_shape Operators
bpy.ops.export_shape.mdd(filepath=, check_existing=True, fps=25, frame_start=1,frame_end=250)
Animated mesh to MDD vertex keyframe file
Parameters
filepath (string, (optional)) File Path, Filepath used for exporting the file
check_existing (boolean, (optional)) Check Existing, Check and warn on overwritingexisting files
24 Chapter 1. Application Modules
https://svn.blender.org/svnroot/bf-blender/trunk/blender/release/scripts/op/io_scene_obj/__init__.pyhttps://svn.blender.org/svnroot/bf-blender/trunk/blender/release/scripts/op/io_scene_x3d/__init__.py
-
Blender Index, Release 2.54 - UNSTABLE API
fps (int in [1, 120], (optional)) Frames Per Second, Number of frames/second
frame_start (int in [1, 300000], (optional)) Start Frame, Start frame for baking
frame_end (int in [1, 300000], (optional)) End Frame, End frame for baking
File op/io_shape_mdd/__init__.py:85
1.2.15 File Operators
bpy.ops.file.bookmark_add()Add a bookmark for the selected/active directory
bpy.ops.file.bookmark_toggle()Toggle bookmarks display
bpy.ops.file.cancel()Cancel loading of selected file
bpy.ops.file.delete()Delete selected file
bpy.ops.file.delete_bookmark(index=-1)Delete selected bookmark
Parameters
index (int in [-1, 20000], (optional)) Index
bpy.ops.file.directory_new()Create a new directory
bpy.ops.file.execute(need_active=False)Execute selected file
Parameters
need_active (boolean, (optional)) Need Active, Only execute if theres an active selectedfile in the file list.
bpy.ops.file.filenum(increment=1)Increment number in filename
Parameters
increment (int in [0, 100], (optional)) Increment
bpy.ops.file.find_missing_files(filepath=, filter_blender=False, filter_image=False, fil-ter_movie=False, filter_python=False, filter_font=False,filter_sound=False, filter_text=False, filter_btx=False, fil-ter_collada=False, filter_folder=False, filemode=9)
Undocumented (contribute)
Parameters
filepath (string, (optional)) File Path, Path to file
filter_blender (boolean, (optional)) Filter .blend files
filter_image (boolean, (optional)) Filter image files
filter_movie (boolean, (optional)) Filter movie files
filter_python (boolean, (optional)) Filter python files
1.2. Operators (bpy.ops) 25
https://svn.blender.org/svnroot/bf-blender/trunk/blender/release/scripts/op/io_shape_mdd/__init__.pyhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.file.find_missing_files
-
Blender Index, Release 2.54 - UNSTABLE API
filter_font (boolean, (optional)) Filter font files
filter_sound (boolean, (optional)) Filter sound files
filter_text (boolean, (optional)) Filter text files
filter_btx (boolean, (optional)) Filter btx files
filter_collada (boolean, (optional)) Filter COLLADA files
filter_folder (boolean, (optional)) Filter folders
filemode (int in [1, 9], (optional)) File Browser Mode, The setting for the file browsermode to load a .blend file, a library or a special file
bpy.ops.file.hidedot()Toggle hide hidden dot files
bpy.ops.file.highlight()Highlight selected file(s)
bpy.ops.file.make_paths_absolute()Undocumented (contribute)
bpy.ops.file.make_paths_relative()Undocumented (contribute)
bpy.ops.file.next()Move to next folder
bpy.ops.file.pack_all()Undocumented (contribute)
bpy.ops.file.parent()Move to parent directory
bpy.ops.file.previous()Move to previous folder
bpy.ops.file.refresh()Refresh the file list
bpy.ops.file.rename()Rename file or file directory
bpy.ops.file.report_missing_files()Undocumented (contribute)
bpy.ops.file.select(extend=False, fill=False)Activate/select file
Parameters
extend (boolean, (optional)) Extend, Extend selection instead of deselecting everythingfirst.
fill (boolean, (optional)) Fill, Select everything beginning with the last selection.
bpy.ops.file.select_all_toggle()Select/deselect all files
bpy.ops.file.select_bookmark(dir=)Select a bookmarked directory
Parameters
26 Chapter 1. Application Modules
http://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.file.make_paths_absolutehttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.file.make_paths_relativehttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.file.pack_allhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.file.report_missing_files
-
Blender Index, Release 2.54 - UNSTABLE API
dir (string, (optional)) Dir
bpy.ops.file.select_border(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0)Activate/select the file(s) contained in the border
Parameters
gesture_mode (int in [-inf, inf], (optional)) Gesture Mode
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
bpy.ops.file.select_execute(FILE_OT_select=None, FILE_OT_execute=None)Undocumented (contribute)
Parameters
FILE_OT_select (FILE_OT_select, (optional)) Activate/Select File, Activate/selectfile
FILE_OT_execute (FILE_OT_execute, (optional)) Execute File Window, Executeselected file
bpy.ops.file.smoothscroll()Smooth scroll to make editable file visible.
bpy.ops.file.unpack_all(method=USE_LOCAL)Undocumented (contribute)
Parameters
method (enum in [USE_LOCAL, WRITE_LOCAL, USE_ORIGINAL,WRITE_ORIGINAL, KEEP, ASK], (optional)) Method, How to unpack.
1.2.16 Fluid Operators
bpy.ops.fluid.bake()Bake fluid simulation
1.2.17 Font Operators
bpy.ops.font.buffer_paste()Paste text from OS buffer
bpy.ops.font.case_set(case=LOWER)Set font case
Parameters
case (enum in [LOWER, UPPER], (optional)) Case, Lower or upper case.
bpy.ops.font.case_toggle()Toggle font case
bpy.ops.font.change_character(delta=1)Change font character code
Parameters
1.2. Operators (bpy.ops) 27
http://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.file.select_executehttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.file.unpack_all
-
Blender Index, Release 2.54 - UNSTABLE API
delta (int in [-255, 255], (optional)) Delta, Number to increase or decrease character codewith.
bpy.ops.font.change_spacing(delta=1)Change font spacing
Parameters
delta (int in [-20, 20], (optional)) Delta, Amount to decrease or increasing characterspacing with.
bpy.ops.font.delete(type=ALL)Delete text by cursor position
Parameters
type (enum in [ALL, NEXT_CHARACTER, PREVIOUS_CHARACTER, SELEC-TION, NEXT_OR_SELECTION, PREVIOUS_OR_SELECTION], (optional, neverNone)) Type, Which part of the text to delete.
bpy.ops.font.file_paste(filepath=, filter_blender=False, filter_image=False, filter_movie=False,filter_python=False, filter_font=False, filter_sound=False, fil-ter_text=True, filter_btx=False, filter_collada=False, filter_folder=True,filemode=9)
Paste contents from file
Parameters
filepath (string, (optional)) File Path, Path to file
filter_blender (boolean, (optional)) Filter .blend files
filter_image (boolean, (optional)) Filter image files
filter_movie (boolean, (optional)) Filter movie files
filter_python (boolean, (optional)) Filter python files
filter_font (boolean, (optional)) Filter font files
filter_sound (boolean, (optional)) Filter sound files
filter_text (boolean, (optional)) Filter text files
filter_btx (boolean, (optional)) Filter btx files
filter_collada (boolean, (optional)) Filter COLLADA files
filter_folder (boolean, (optional)) Filter folders
filemode (int in [1, 9], (optional)) File Browser Mode, The setting for the file browsermode to load a .blend file, a library or a special file
bpy.ops.font.insert_lorem()Insert placeholder text
bpy.ops.font.line_break(ctrl=False)Insert line break at cursor position
Parameters
ctrl (boolean, (optional)) Ctrl
bpy.ops.font.move(type=LINE_BEGIN)Move cursor to position type
Parameters
28 Chapter 1. Application Modules
-
Blender Index, Release 2.54 - UNSTABLE API
type (enum in [LINE_BEGIN, LINE_END, PREVIOUS_CHARACTER,NEXT_CHARACTER, PREVIOUS_WORD, NEXT_WORD, PREVIOUS_LINE,NEXT_LINE, PREVIOUS_PAGE, NEXT_PAGE], (optional, never None)) Type,Where to move cursor to.
bpy.ops.font.move_select(type=LINE_BEGIN)Make selection from current cursor position to new cursor position type
Parameters
type (enum in [LINE_BEGIN, LINE_END, PREVIOUS_CHARACTER,NEXT_CHARACTER, PREVIOUS_WORD, NEXT_WORD, PREVIOUS_LINE,NEXT_LINE, PREVIOUS_PAGE, NEXT_PAGE], (optional, never None)) Type,Where to move cursor to, to make a selection.
bpy.ops.font.open(filepath=, filter_blender=False, filter_image=False, filter_movie=False, fil-ter_python=False, filter_font=True, filter_sound=False, filter_text=False, fil-ter_btx=False, filter_collada=False, filter_folder=True, filemode=9)
Undocumented (contribute)
Parameters
filepath (string, (optional)) File Path, Path to file
filter_blender (boolean, (optional)) Filter .blend files
filter_image (boolean, (optional)) Filter image files
filter_movie (boolean, (optional)) Filter movie files
filter_python (boolean, (optional)) Filter python files
filter_font (boolean, (optional)) Filter font files
filter_sound (boolean, (optional)) Filter sound files
filter_text (boolean, (optional)) Filter text files
filter_btx (boolean, (optional)) Filter btx files
filter_collada (boolean, (optional)) Filter COLLADA files
filter_folder (boolean, (optional)) Filter folders
filemode (int in [1, 9], (optional)) File Browser Mode, The setting for the file browsermode to load a .blend file, a library or a special file
bpy.ops.font.style_set(style=BOLD, clear=False)Set font style
Parameters
style (enum in [BOLD, ITALIC, UNDERLINE, SMALL_CAPS], (optional)) Style,Style to set selection to.
clear (boolean, (optional)) Clear, Clear style rather than setting it.
bpy.ops.font.style_toggle(style=BOLD)Toggle font style
Parameters
style (enum in [BOLD, ITALIC, UNDERLINE, SMALL_CAPS], (optional, neverNone)) Style, Style to set selection to.
bpy.ops.font.text_copy()Copy selected text to clipboard
1.2. Operators (bpy.ops) 29
http://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.font.open
-
Blender Index, Release 2.54 - UNSTABLE API
bpy.ops.font.text_cut()Cut selected text to clipboard
bpy.ops.font.text_insert(text=)Insert text at cursor position
Parameters
text (string, (optional)) Text, Text to insert at the cursor position.
bpy.ops.font.text_paste()Paste text from clipboard
bpy.ops.font.textbox_add()Add a new text box
bpy.ops.font.textbox_remove(index=0)Remove the textbox
Parameters
index (int in [0, inf], (optional)) Index, The current text box.
bpy.ops.font.unlink()Unlink active font data block
1.2.18 Gpencil Operators
bpy.ops.gpencil.active_frame_delete()Delete the active frame for the active Grease Pencil datablock
bpy.ops.gpencil.convert(type=PATH)Convert the active Grease Pencil layer to a new Object
Parameters
type (enum in [PATH, CURVE], (optional)) Type
bpy.ops.gpencil.data_add()Add new Grease Pencil datablock
bpy.ops.gpencil.data_unlink()Unlink active Grease Pencil datablock
bpy.ops.gpencil.draw(mode=DRAW, stroke=None)Make annotations on the active data
Parameters
mode (enum in [DRAW, DRAW_STRAIGHT, ERASER], (optional, never None)) Mode, Way to intepret mouse movements.
stroke (Collection of OperatorStrokeElement, (optional)) Stroke
bpy.ops.gpencil.layer_add()Add new Grease Pencil layer for the active Grease Pencil datablock
1.2.19 Graph Operators
bpy.ops.graph.bake()Bake selected F-Curves to a set of sampled points defining a similar curve
30 Chapter 1. Application Modules
-
Blender Index, Release 2.54 - UNSTABLE API
bpy.ops.graph.clean(threshold=0.001)Simplify F-Curves by removing closely spaced keyframes
Parameters
threshold (float in [0, inf], (optional)) Threshold
bpy.ops.graph.click_insert(frame=1.0, value=1.0)Insert new keyframe at the cursor position for the active F-Curve
Parameters
frame (float in [-inf, inf], (optional)) Frame Number, Frame to insert keyframe on
value (float in [-inf, inf], (optional)) Value, Value for keyframe on
bpy.ops.graph.clickselect(left_right=OFF, extend=False, column=False, curves=False)Select keyframes by clicking on them
Parameters
left_right (enum in [CHECK, OFF, LEFT, RIGHT], (optional, never None)) LeftRight
extend (boolean, (optional)) Extend Select
column (boolean, (optional)) Column Select, Select all keyframes that occur on the sameframe as the one under the mouse
curves (boolean, (optional)) Only Curves, Select all the keyframes in the curve
bpy.ops.graph.copy()Copy selected keyframes to the copy/paste buffer
bpy.ops.graph.cursor_set(frame=0, value=0.0)Interactively set the current frame number and value cursor
Parameters
frame (int in [-300000, 300000], (optional)) Frame
value (float in [1.17549e-38, inf], (optional)) Value
bpy.ops.graph.delete()Remove all selected keyframes
bpy.ops.graph.duplicate(mode=1)Make a copy of all selected keyframes
Parameters
mode (int in [0, inf], (optional)) Mode
bpy.ops.graph.euler_filter()Fixes the most common causes of gimbal lock in the fcurves of the active bone
File op/fcurve_euler_filter.py:55
bpy.ops.graph.extrapolation_type(type=CONSTANT)Set extrapolation mode for selected F-Curves
Parameters
type (enum in [CONSTANT, LINEAR], (optional, never None)) Type
bpy.ops.graph.fmodifier_add(type=NULL, only_active=True)Add F-Modifiers to the selected F-Curves
1.2. Operators (bpy.ops) 31
https://svn.blender.org/svnroot/bf-blender/trunk/blender/release/scripts/op/fcurve_euler_filter.py
-
Blender Index, Release 2.54 - UNSTABLE API
Parameters
type (enum in [NULL, GENERATOR, FNGENERATOR, ENVELOPE, CYCLES,NOISE, FILTER, LIMITS, STEPPED], (optional, never None)) Type
only_active (boolean, (optional)) Only Active, Only add F-Modifier to active F-Curve.
bpy.ops.graph.fmodifier_copy()Copy the F-Modifier(s) of the active F-Curve.
bpy.ops.graph.fmodifier_paste()Add copied F-Modifiers to the selected F-Curves
bpy.ops.graph.frame_jump()Set the current frame to the average frame of the selected keyframes
bpy.ops.graph.ghost_curves_clear()Clear F-Curve snapshots (Ghosts) for active Graph Editor
bpy.ops.graph.ghost_curves_create()Create snapshot (Ghosts) of selected F-Curves as background aid for active Graph Editor
bpy.ops.graph.handle_type(type=FREE)Set type of handle for selected keyframes
Parameters
type (enum in [FREE, VECTOR, ALIGNED, AUTO, ANIM_CLAMPED], (optional,never None)) Type
bpy.ops.graph.handles_view_toggle()Undocumented (contribute)
bpy.ops.graph.interpolation_type(type=CONSTANT)Set interpolation mode for the F-Curve segments starting from the selected keyframes
Parameters
type (enum in [CONSTANT, LINEAR, BEZIER], (optional, never None)) Type
bpy.ops.graph.keyframe_insert(type=ALL)Insert keyframes for the specified channels
Parameters
type (enum in [ALL, SEL], (optional, never None)) Type
bpy.ops.graph.mirror(type=CFRA)Flip selected keyframes over the selected mirror line
Parameters
type (enum in [CFRA, VALUE, YAXIS, XAXIS, MARKER], (optional, never None)) Type
bpy.ops.graph.paste()Paste keyframes from copy/paste buffer for the selected channels, starting on the current frame
bpy.ops.graph.previewrange_set()Undocumented (contribute)
bpy.ops.graph.properties()Undocumented (contribute)
bpy.ops.graph.sample()Add keyframes on every frame between the selected keyframes
32 Chapter 1. Application Modules
http://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.graph.handles_view_togglehttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.graph.previewrange_sethttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.graph.properties
-
Blender Index, Release 2.54 - UNSTABLE API
bpy.ops.graph.select_all_toggle(invert=False)Toggle selection of all keyframes
Parameters
invert (boolean, (optional)) Invert
bpy.ops.graph.select_border(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0,axis_range=False, include_handles=False)
Select all keyframes within the specified region
Parameters
gesture_mode (int in [-inf, inf], (optional)) Gesture Mode
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
axis_range (boolean, (optional)) Axis Range
include_handles (boolean, (optional)) Include Handles, Are handles tested individuallyagainst the selection criteria
bpy.ops.graph.select_column(mode=KEYS)Select all keyframes on the specified frame(s)
Parameters
mode (enum in [KEYS, CFRA, MARKERS_COLUMN, MARKERS_BETWEEN], (op-tional, never None)) Mode
bpy.ops.graph.select_less()Deselect keyframes on ends of selection islands
bpy.ops.graph.select_linked()Select keyframes occurring the same F-Curves as selected ones
bpy.ops.graph.select_more()Select keyframes beside already selected ones
bpy.ops.graph.smooth()Apply weighted moving means to make selected F-Curves less bumpy
bpy.ops.graph.snap(type=CFRA)Snap selected keyframes to the chosen times/values
Parameters
type (enum in [CFRA, VALUE, NEAREST_FRAME, NEAREST_SECOND, NEAR-EST_MARKER, HORIZONTAL], (optional, never None)) Type
bpy.ops.graph.sound_bake(filepath=, filter_blender=False, filter_image=False, fil-ter_movie=True, filter_python=False, filter_font=False, fil-ter_sound=True, filter_text=False, filter_btx=False, filter_collada=False,filter_folder=True, filemode=9, low=0.0, high=100000.0, attack=0.005,release=0.2, threshold=0.0, accumulate=False, use_additive=False,square=False, sthreshold=0.1)
Bakes a sound wave to selected F-Curves
Parameters
1.2. Operators (bpy.ops) 33
-
Blender Index, Release 2.54 - UNSTABLE API
filepath (string, (optional)) File Path, Path to file
filter_blender (boolean, (optional)) Filter .blend files
filter_image (boolean, (optional)) Filter image files
filter_movie (boolean, (optional)) Filter movie files
filter_python (boolean, (optional)) Filter python files
filter_font (boolean, (optional)) Filter font files
filter_sound (boolean, (optional)) Filter sound files
filter_text (boolean, (optional)) Filter text files
filter_btx (boolean, (optional)) Filter btx files
filter_collada (boolean, (optional)) Filter COLLADA files
filter_folder (boolean, (optional)) Filter folders
filemode (int in [1, 9], (optional)) File Browser Mode, The setting for the file browsermode to load a .blend file, a library or a special file
low (float in [0, 100000], (optional)) Lowest frequency
high (float in [0, 100000], (optional)) Highest frequency
attack (float in [0, 2], (optional)) Attack time
release (float in [0, 5], (optional)) Release time
threshold (float in [0, 1], (optional)) Threshold
accumulate (boolean, (optional)) Accumulate
use_additive (boolean, (optional)) Additive
square (boolean, (optional)) Square
sthreshold (float in [0, 1], (optional)) Square Threshold
bpy.ops.graph.view_all()Reset viewable area to show full keyframe range
1.2.20 Group Operators
bpy.ops.group.create(name=Group)Create an object group from selected objects
Parameters
name (string, (optional)) Name, Name of the new group
bpy.ops.group.objects_add_active()Add the object to an object group that contains the active object
bpy.ops.group.objects_remove()Remove selected objects from all groups
bpy.ops.group.objects_remove_active()Remove the object from an object group that contains the active object
34 Chapter 1. Application Modules
-
Blender Index, Release 2.54 - UNSTABLE API
1.2.21 Help Operators
bpy.ops.help.operator_cheat_sheet()Undocumented (contribute)
File ui/space_info.py:365
1.2.22 Image Operators
bpy.ops.image.curves_point_set(point=BLACK_POINT)Undocumented (contribute)
Parameters
point (enum in [BLACK_POINT, WHITE_POINT], (optional, never None)) Point, Setblack point or white point for curves.
bpy.ops.image.cycle_render_slot()Undocumented (contribute)
bpy.ops.image.external_edit(filepath=)Edit image in an external application
Parameters
filepath (string, (optional)) File Path, Path to an image file
File op/image.py:62
bpy.ops.image.new(name=Untitled, width=1024, height=1024, color=(0.0, 0.0, 0.0, 1.0), al-pha=True, uv_test_grid=False, float=False)
Undocumented (contribute)
Parameters
name (string, (optional)) Name, Image datablock name.
width (int in [1, inf], (optional)) Width, Image width.
height (int in [1, inf], (optional)) Height, Image height.
color (float array of 4 items in [0, inf], (optional)) Color, Default fill color.
alpha (boolean, (optional)) Alpha, Create an image with an alpha channel.
uv_test_grid (boolean, (optional)) UV Test Grid, Fill the image with a grid for UV maptesting.
float (boolean, (optional)) 32 bit Float, Create image with 32 bit floating point bit depth.
bpy.ops.image.open(filepath=, filter_blender=False, filter_image=True, filter_movie=True, fil-ter_python=False, filter_font=False, filter_sound=False, filter_text=False,filter_btx=False, filter_collada=False, filter_folder=True, filemode=9, rela-tive_path=False)
Undocumented (contribute)
Parameters
filepath (string, (optional)) File Path, Path to file
filter_blender (boolean, (optional)) Filter .blend files
filter_image (boolean, (optional)) Filter image files
filter_movie (boolean, (optional)) Filter movie files
1.2. Operators (bpy.ops) 35
http://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.help.operator_cheat_sheethttps://svn.blender.org/svnroot/bf-blender/trunk/blender/release/scripts/ui/space_info.pyhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.image.curves_point_sethttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.image.cycle_render_slothttps://svn.blender.org/svnroot/bf-blender/trunk/blender/release/scripts/op/image.pyhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.image.newhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.image.open
-
Blender Index, Release 2.54 - UNSTABLE API
filter_python (boolean, (optional)) Filter python files
filter_font (boolean, (optional)) Filter font files
filter_sound (boolean, (optional)) Filter sound files
filter_text (boolean, (optional)) Filter text files
filter_btx (boolean, (optional)) Filter btx files
filter_collada (boolean, (optional)) Filter COLLADA files
filter_folder (boolean, (optional)) Filter folders
filemode (int in [1, 9], (optional)) File Browser Mode, The setting for the file browsermode to load a .blend file, a library or a special file
relative_path (boolean, (optional)) Relative Path, Select the file relative to the blend file
bpy.ops.image.pack(as_png=False)Pack an image as embedded data into the .blend file
Parameters
as_png (boolean, (optional)) Pack As PNG, Pack image as lossless PNG.
bpy.ops.image.project_apply()Project edited image back onto the object
File op/image.py:182
bpy.ops.image.project_edit()Edit a snapshot if the viewport in an external image editor
File op/image.py:119
bpy.ops.image.properties()Undocumented (contribute)
bpy.ops.image.record_composite()Undocumented (contribute)
bpy.ops.image.reload()Undocumented (contribute)
bpy.ops.image.replace(filepath=, filter_blender=False, filter_image=True, filter_movie=True, fil-ter_python=False, filter_font=False, filter_sound=False, filter_text=False, fil-ter_btx=False, filter_collada=False, filter_folder=True, filemode=9, rela-tive_path=False)
Undocumented (contribute)
Parameters
filepath (string, (optional)) File Path, Path to file
filter_blender (boolean, (optional)) Filter .blend files
filter_image (boolean, (optional)) Filter image files
filter_movie (boolean, (optional)) Filter movie files
filter_python (boolean, (optional)) Filter python files
filter_font (boolean, (optional)) Filter font files
filter_sound (boolean, (optional)) Filter sound files
filter_text (boolean, (optional)) Filter text files
36 Chapter 1. Application Modules
https://svn.blender.org/svnroot/bf-blender/trunk/blender/release/scripts/op/image.pyhttps://svn.blender.org/svnroot/bf-blender/trunk/blender/release/scripts/op/image.pyhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.image.propertieshttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.image.record_compositehttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.image.reloadhttp://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute?action=edit§ion=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message&preloadtitle=bpy.ops.image.replace
-
Blender Index, Release 2.54 - UNSTABLE API
filter_btx (boolean, (optional)) Filter btx files
filter_collada (boolean, (optional)) Filter COLLADA files
filter_folder (boolean, (optional)) Filter folders
filemode (int in [1, 9], (optional)) File Browser Mode, The setting for the file browsermode to load a .blend file, a library or a special file
relative_path (boolean, (optional)) Relative Path, Select the file relative to the blend file
bpy.ops.image.sample()Undocumented (contribute)
bpy.ops.image.sample_line(xstart=0, xend=0, ystart=0, yend=0, cursor=1002)Undocumented (contribute)
Parameters
xstart (int in [-inf, inf], (optional)) X Start
xend (int in [-inf, inf], (optional)) X End
ystart (int in [-inf, inf], (optional)) Y Start
yend (int in [-inf, inf], (optional)) Y End
cursor (int in [0, inf], (optional)) Cursor, Mouse cursor style to use during the modaloperator
bpy.ops.image.save()Undocumented (contribute)
bpy.ops.image.save_as(file_type=PNG, filepath=, check_existing=True, filter_blender=False, fil-ter_image=True, filter_movie=True, filter_python=False, filter_font=False,filter_sound=False, filter_text=False, filter_btx=False, filter_collada=False,filter_folder=True, filemode=9, relative_path=False, copy=False)
Undocumented (contribute)
Parameters
file_type (enum in [TARGA, TARGA RAW, PNG, BM