Object Operators¶

bpy.ops.object.add(type='EMPTY', view_align=False, enter_editmode=False, location=(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))¶

Add an object to the scene

Parameters:

type (enum in [‘MESH’, ‘CURVE’, ‘SURFACE’, ‘META’, ‘TEXT’, ‘ARMATURE’, ‘LATTICE’, ‘EMPTY’, ‘CAMERA’, ‘LAMP’], (optional)) – Type
view_align (boolean, (optional)) – Align to View, Align the new object to the view.
enter_editmode (boolean, (optional)) – Enter Editmode, Enter editmode when adding this object.
location (float array of 3 items in [-inf, inf], (optional)) – Location, Location for the newly added object.
rotation (float array of 3 items in [-inf, inf], (optional)) – Rotation, Rotation for the newly added object
layers (boolean array of 20 items, (optional)) – Layer

bpy.ops.object.add_named(linked=False, name="Cube")¶

Add named object

Parameters:	linked (boolean, (optional)) – Linked, Duplicate object but not object data, linking to the original data. name (string, (optional)) – Name, Object name to add.

bpy.ops.object.add_named_cursor(name="Cube", VIEW3D_OT_cursor3d=None, OBJECT_OT_add_named=None)¶

Undocumented (contribute)

Parameters:	name (string, (optional)) – Name, Object name to add. VIEW3D_OT_cursor3d (`VIEW3D_OT_cursor3d`, (optional)) – Set 3D Cursor, Set the location of the 3D cursor OBJECT_OT_add_named (`OBJECT_OT_add_named`, (optional)) – Add Named Object, Add named object

bpy.ops.object.align(align_mode='OPT_2', relative_to='OPT_4', align_x=False, align_y=False, align_z=False)¶

Align Objects

Parameters:

align_mode (enum in [‘OPT_1’, ‘OPT_2’, ‘OPT_3’], (optional)) – Align Mode:
relative_to (enum in [‘OPT_1’, ‘OPT_2’, ‘OPT_3’, ‘OPT_4’], (optional)) – Relative To:
align_x (boolean, (optional)) – Align X, Align in the X axis
align_y (boolean, (optional)) – Align Y, Align in the Y axis
align_z (boolean, (optional)) – Align Z, Align in the Z axis

File :

op/object_align.py:270

bpy.ops.object.armature_add(view_align=False, enter_editmode=False, location=(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))¶

Add an armature object to the scene

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 this object.
location (float array of 3 items in [-inf, inf], (optional)) – Location, Location for the newly added object.
rotation (float array of 3 items in [-inf, inf], (optional)) – Rotation, Rotation for the newly added object
layers (boolean array of 20 items, (optional)) – Layer

bpy.ops.object.armature_human_advanced_add()¶

Add an advanced human metarig base

File :	op/add_armature_human.py:591

bpy.ops.object.bake_image()¶: Bake image textures of selected objects

bpy.ops.object.camera_add(view_align=False, enter_editmode=False, location=(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))¶

Add a camera object to the scene

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 this object.
location (float array of 3 items in [-inf, inf], (optional)) – Location, Location for the newly added object.
rotation (float array of 3 items in [-inf, inf], (optional)) – Rotation, Rotation for the newly added object
layers (boolean array of 20 items, (optional)) – Layer

bpy.ops.object.constraint_add(type='')¶

Add a constraint to the active object

Parameters:

type (enum in [‘COPY_LOCATION’, ‘COPY_ROTATION’, ‘COPY_SCALE’, ‘COPY_TRANSFORMS’, ‘LIMIT_DISTANCE’, ‘LIMIT_LOCATION’, ‘LIMIT_ROTATION’, ‘LIMIT_SCALE’, ‘MAINTAIN_VOLUME’, ‘TRANSFORM’, ‘CLAMP_TO’, ‘DAMPED_TRACK’, ‘IK’, ‘LOCKED_TRACK’, ‘SPLINE_IK’, ‘STRETCH_TO’, ‘TRACK_TO’, ‘ACTION’, ‘CHILD_OF’, ‘FLOOR’, ‘FOLLOW_PATH’, ‘PIVOT’, ‘RIGID_BODY_JOINT’, ‘SCRIPT’, ‘SHRINKWRAP’], (optional)) – Type

bpy.ops.object.constraint_add_with_targets(type='')¶

Add a constraint to the active object, with target (where applicable) set to the selected Objects/Bones

Parameters:

type (enum in [‘COPY_LOCATION’, ‘COPY_ROTATION’, ‘COPY_SCALE’, ‘COPY_TRANSFORMS’, ‘LIMIT_DISTANCE’, ‘LIMIT_LOCATION’, ‘LIMIT_ROTATION’, ‘LIMIT_SCALE’, ‘MAINTAIN_VOLUME’, ‘TRANSFORM’, ‘CLAMP_TO’, ‘DAMPED_TRACK’, ‘IK’, ‘LOCKED_TRACK’, ‘SPLINE_IK’, ‘STRETCH_TO’, ‘TRACK_TO’, ‘ACTION’, ‘CHILD_OF’, ‘FLOOR’, ‘FOLLOW_PATH’, ‘PIVOT’, ‘RIGID_BODY_JOINT’, ‘SCRIPT’, ‘SHRINKWRAP’], (optional, never None)) – Type

bpy.ops.object.constraints_clear()¶: Clear all the constraints for the active Object only

bpy.ops.object.constraints_copy()¶: Copy constraints to other selected objects.

bpy.ops.object.convert(target='MESH', keep_original=False)¶

Convert selected objects to another type

Parameters:	target (enum in [‘CURVE’, ‘MESH’], (optional, never None)) – Target, Type of object to convert to. keep_original (boolean, (optional)) – Keep Original, Keep original objects instead of replacing them.

bpy.ops.object.delete()¶: Delete selected objects

bpy.ops.object.drop_named_material(name="Material")¶

Undocumented (contribute)

Parameters:	name (string, (optional)) – Name, Material name to assign.

bpy.ops.object.duplicate(linked=False, mode=1)¶

Duplicate selected objects

Parameters:	linked (boolean, (optional)) – Linked, Duplicate object but not object data, linking to the original data. mode (int in [0, inf], (optional)) – Mode

bpy.ops.object.duplicate_move(OBJECT_OT_duplicate=None, TRANSFORM_OT_translate=None)¶

Undocumented (contribute)

Parameters:	OBJECT_OT_duplicate (`OBJECT_OT_duplicate`, (optional)) – Duplicate, Duplicate selected objects TRANSFORM_OT_translate (`TRANSFORM_OT_translate`, (optional)) – Translate, Translate selected items

bpy.ops.object.duplicate_move_linked(OBJECT_OT_duplicate=None, TRANSFORM_OT_translate=None)¶

Undocumented (contribute)

Parameters:	OBJECT_OT_duplicate (`OBJECT_OT_duplicate`, (optional)) – Duplicate, Duplicate selected objects TRANSFORM_OT_translate (`TRANSFORM_OT_translate`, (optional)) – Translate, Translate selected items

bpy.ops.object.duplicates_make_real()¶: Make dupli objects attached to this object real

bpy.ops.object.editmode_toggle()¶: Toggle object’s editmode

bpy.ops.object.effector_add(type='FORCE', view_align=False, enter_editmode=False, location=(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))¶

Add an empty object with a physics effector to the scene

Parameters:

type (enum in [‘FORCE’, ‘WIND’, ‘VORTEX’, ‘MAGNET’, ‘HARMONIC’, ‘CHARGE’, ‘LENNARDJ’, ‘TEXTURE’, ‘GUIDE’, ‘BOID’, ‘TURBULENCE’, ‘DRAG’], (optional)) – Type
view_align (boolean, (optional)) – Align to View, Align the new object to the view.
enter_editmode (boolean, (optional)) – Enter Editmode, Enter editmode when adding this object.
location (float array of 3 items in [-inf, inf], (optional)) – Location, Location for the newly added object.
rotation (float array of 3 items in [-inf, inf], (optional)) – Rotation, Rotation for the newly added object
layers (boolean array of 20 items, (optional)) – Layer

bpy.ops.object.explode_refresh(modifier="")¶

Refresh data in the Explode modifier

Parameters:	modifier (string, (optional)) – Modifier, Name of the modifier to edit

bpy.ops.object.game_property_clear()¶: Undocumented (contribute)

bpy.ops.object.game_property_copy(operation='COPY', property='')¶

Undocumented (contribute)

Parameters:	operation (enum in [‘REPLACE’, ‘MERGE’, ‘COPY’], (optional)) – Operation property (enum in [], (optional)) – Property, Properties to copy

bpy.ops.object.game_property_new()¶: Undocumented (contribute)

bpy.ops.object.game_property_remove(index=0)¶

Undocumented (contribute)

Parameters:	index (int in [0, inf], (optional)) – Index, Property index to remove

bpy.ops.object.group_add()¶: Add an object to a new group

bpy.ops.object.group_instance_add(group='', view_align=False, location=(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))¶

Add a dupligroup instance

Parameters:

group (enum in [], (optional)) – Group
view_align (boolean, (optional)) – Align to View, Align the new object to the view.
location (float array of 3 items in [-inf, inf], (optional)) – Location, Location for the newly added object.
rotation (float array of 3 items in [-inf, inf], (optional)) – Rotation, Rotation for the newly added object
layers (boolean array of 20 items, (optional)) – Layer

bpy.ops.object.group_link(group='')¶

Add an object to an existing group

Parameters:	group (enum in [], (optional)) – Group

bpy.ops.object.group_remove()¶: Undocumented (contribute)

bpy.ops.object.hide_render_clear()¶: Reveal the render object by setting the hide render flag

bpy.ops.object.hide_render_clear_all()¶

Reveal all render objects by setting the hide render flag

File :	op/object.py:561

bpy.ops.object.hide_render_set(unselected=False)¶

Hide the render object by setting the hide render flag

Parameters:	unselected (boolean, (optional)) – Unselected, Hide unselected rather than selected objects.

bpy.ops.object.hide_view_clear()¶: Reveal the object by setting the hide flag

bpy.ops.object.hide_view_set(unselected=False)¶

Hide the object by setting the hide flag

Parameters:	unselected (boolean, (optional)) – Unselected, Hide unselected rather than selected objects.

bpy.ops.object.hook_add_newob()¶: Hook selected vertices to the first selected Object

bpy.ops.object.hook_add_selob()¶: Hook selected vertices to the first selected Object

bpy.ops.object.hook_assign(modifier='')¶

Assign the selected vertices to a hook

Parameters:	modifier (enum in [], (optional)) – Modifier, Modifier number to assign to.

bpy.ops.object.hook_recenter(modifier='')¶

Set hook center to cursor position

Parameters:	modifier (enum in [], (optional)) – Modifier, Modifier number to assign to.

bpy.ops.object.hook_remove(modifier='')¶

Remove a hook from the active object

Parameters:	modifier (enum in [], (optional)) – Modifier, Modifier number to remove.

bpy.ops.object.hook_reset(modifier='')¶

Recalculate and clear offset transformation

Parameters:	modifier (enum in [], (optional)) – Modifier, Modifier number to assign to.

bpy.ops.object.hook_select(modifier='')¶

Selects effected vertices on mesh

Parameters:	modifier (enum in [], (optional)) – Modifier, Modifier number to remove.

bpy.ops.object.isolate_type_render()¶

Hide unselected render objects of same type as active by setting the hide render flag

File :	op/object.py:540

bpy.ops.object.join()¶: Join selected objects into active object

bpy.ops.object.join_shapes()¶: Merge selected objects to shapes of active object

bpy.ops.object.join_uvs()¶

Copy UV Layout to objects with matching geometry

File :	op/object.py:461

bpy.ops.object.lamp_add(type='POINT', view_align=False, location=(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))¶

Add a lamp object to the scene

Parameters:

type (enum in [‘POINT’, ‘SUN’, ‘SPOT’, ‘HEMI’, ‘AREA’], (optional)) – Type
view_align (boolean, (optional)) – Align to View, Align the new object to the view.
location (float array of 3 items in [-inf, inf], (optional)) – Location, Location for the newly added object.
rotation (float array of 3 items in [-inf, inf], (optional)) – Rotation, Rotation for the newly added object
layers (boolean array of 20 items, (optional)) – Layer

bpy.ops.object.location_apply()¶: Apply the object’s location to its data

bpy.ops.object.location_clear()¶: Clear the object’s location

bpy.ops.object.logic_bricks_copy()¶: Copy logic bricks to other selected objects.

bpy.ops.object.make_dupli_face()¶

Make linked objects into dupli-faces

File :	op/object.py:529

bpy.ops.object.make_links_data(type='OBDATA')¶

Make links from the active object to other selected objects

Parameters:	type (enum in [‘OBDATA’, ‘MATERIAL’, ‘ANIMATION’, ‘DUPLIGROUP’, ‘MODIFIERS’], (optional)) – Type

bpy.ops.object.make_links_scene(scene='')¶

Make linked data local to each object

Parameters:	scene (enum in [], (optional)) – Scene

bpy.ops.object.make_local(type='SELECTED_OBJECTS')¶

Make library linked datablocks local to this file

Parameters:	type (enum in [‘SELECTED_OBJECTS’, ‘SELECTED_OBJECTS_DATA’, ‘ALL’], (optional, never None)) – Type

bpy.ops.object.make_single_user(type='SELECTED_OBJECTS', object=False, obdata=False, material=False, texture=False, animation=False)¶

Make linked data local to each object

Parameters:

type (enum in [‘SELECTED_OBJECTS’, ‘ALL’], (optional)) – Type
object (boolean, (optional)) – Object, Make single user objects
obdata (boolean, (optional)) – Object Data, Make single user object data
material (boolean, (optional)) – Materials, Make materials local to each datablock
texture (boolean, (optional)) – Textures, Make textures local to each material
animation (boolean, (optional)) – Animation Data, Make animation data local to each object

bpy.ops.object.material_slot_add()¶: Add a new material slot or duplicate the selected one

bpy.ops.object.material_slot_assign()¶: Assign the material in the selected material slot to the selected vertices

bpy.ops.object.material_slot_copy()¶: Copies materials to other selected objects

bpy.ops.object.material_slot_deselect()¶: Deselect vertices assigned to the selected material slot

bpy.ops.object.material_slot_remove()¶: Remove the selected material slot

bpy.ops.object.material_slot_select()¶: Select vertices assigned to the selected material slot

bpy.ops.object.meshdeform_bind(modifier="")¶

Bind mesh to cage in mesh deform modifier

Parameters:	modifier (string, (optional)) – Modifier, Name of the modifier to edit

bpy.ops.object.metaball_add(type='MBALL_BALL', view_align=False, enter_editmode=False, location=(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))¶

Add an metaball object to the scene

Parameters:

type (enum in [‘MBALL_BALL’, ‘MBALL_CAPSULE’, ‘MBALL_PLANE’, ‘MBALL_CUBE’, ‘MBALL_ELLIPSOID’], (optional, never None)) – Primitive
view_align (boolean, (optional)) – Align to View, Align the new object to the view.
enter_editmode (boolean, (optional)) – Enter Editmode, Enter editmode when adding this object.
location (float array of 3 items in [-inf, inf], (optional)) – Location, Location for the newly added object.
rotation (float array of 3 items in [-inf, inf], (optional)) – Rotation, Rotation for the newly added object
layers (boolean array of 20 items, (optional)) – Layer

bpy.ops.object.mode_set(mode='OBJECT', toggle=False)¶

Sets the object interaction mode

Parameters:	mode (enum in [‘OBJECT’, ‘EDIT’, ‘SCULPT’, ‘VERTEX_PAINT’, ‘WEIGHT_PAINT’, ‘TEXTURE_PAINT’, ‘PARTICLE_EDIT’, ‘POSE’], (optional, never None)) – Mode toggle (boolean, (optional)) – Toggle

bpy.ops.object.modifier_add(type='SUBSURF')¶

Add a modifier to the active object

Parameters:

type (enum in [‘ARRAY’, ‘BEVEL’, ‘BOOLEAN’, ‘BUILD’, ‘DECIMATE’, ‘EDGE_SPLIT’, ‘MASK’, ‘MIRROR’, ‘MULTIRES’, ‘SCREW’, ‘SOLIDIFY’, ‘SUBSURF’, ‘UV_PROJECT’, ‘ARMATURE’, ‘CAST’, ‘CURVE’, ‘DISPLACE’, ‘HOOK’, ‘LATTICE’, ‘MESH_DEFORM’, ‘SHRINKWRAP’, ‘SIMPLE_DEFORM’, ‘SMOOTH’, ‘WAVE’, ‘CLOTH’, ‘COLLISION’, ‘EXPLODE’, ‘FLUID_SIMULATION’, ‘PARTICLE_INSTANCE’, ‘PARTICLE_SYSTEM’, ‘SMOKE’, ‘SOFT_BODY’, ‘SURFACE’], (optional)) – Type

bpy.ops.object.modifier_apply(apply_as='DATA', modifier="")¶

Apply modifier and remove from the stack

Parameters:	apply_as (enum in [‘DATA’, ‘SHAPE’], (optional)) – Apply as, How to apply the modifier to the geometry modifier (string, (optional)) – Modifier, Name of the modifier to edit

bpy.ops.object.modifier_convert(modifier="")¶

Convert particles to a mesh object

Parameters:	modifier (string, (optional)) – Modifier, Name of the modifier to edit

bpy.ops.object.modifier_copy(modifier="")¶

Duplicate modifier at the same position in the stack

Parameters:	modifier (string, (optional)) – Modifier, Name of the modifier to edit

bpy.ops.object.modifier_move_down(modifier="")¶

Move modifier down in the stack

Parameters:	modifier (string, (optional)) – Modifier, Name of the modifier to edit

bpy.ops.object.modifier_move_up(modifier="")¶

Move modifier up in the stack

Parameters:	modifier (string, (optional)) – Modifier, Name of the modifier to edit

bpy.ops.object.modifier_remove(modifier="")¶

Remove a modifier from the active object

Parameters:	modifier (string, (optional)) – Modifier, Name of the modifier to edit

bpy.ops.object.move_to_layer(layers=(False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False))¶

Move the object to different layers

Parameters:	layers (boolean array of 20 items, (optional)) – Layer

bpy.ops.object.multires_external_pack()¶: Pack displacements from an external file

bpy.ops.object.multires_external_save(filepath="", check_existing=True, filter_blender=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_btx=True, filter_collada=False, filter_folder=True, filemode=9, relative_path=False, modifier="")¶

Save displacements to an external file

Parameters:

filepath (string, (optional)) – File Path, Path to file
check_existing (boolean, (optional)) – Check Existing, Check and warn on overwriting existing files
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 browser mode 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
modifier (string, (optional)) – Modifier, Name of the modifier to edit

bpy.ops.object.multires_higher_levels_delete(modifier="")¶

Undocumented (contribute)

Parameters:	modifier (string, (optional)) – Modifier, Name of the modifier to edit

bpy.ops.object.multires_reshape(modifier="")¶

Copy vertex coordinates from other object

Parameters:	modifier (string, (optional)) – Modifier, Name of the modifier to edit

bpy.ops.object.multires_subdivide(modifier="")¶

Add a new level of subdivision

Parameters:	modifier (string, (optional)) – Modifier, Name of the modifier to edit

bpy.ops.object.origin_clear()¶: Clear the object’s origin

bpy.ops.object.origin_set(type='GEOMETRY_ORIGIN', center='MEDIAN')¶

Set the object’s origin, by either moving the data, or set to center of data, or use 3d cursor

Parameters:	type (enum in [‘GEOMETRY_ORIGIN’, ‘ORIGIN_GEOMETRY’, ‘ORIGIN_CURSOR’], (optional, never None)) – Type center (enum in [‘MEDIAN’, ‘BOUNDS’], (optional, never None)) – Center

bpy.ops.object.parent_clear(type='CLEAR')¶

Clear the object’s parenting

Parameters:	type (enum in [‘CLEAR’, ‘CLEAR_KEEP_TRANSFORM’, ‘CLEAR_INVERSE’], (optional, never None)) – Type

bpy.ops.object.parent_no_inverse_set()¶: Set the object’s parenting without setting the inverse parent correction

bpy.ops.object.parent_set(type='OBJECT')¶

Set the object’s parenting

Parameters:	type (enum in [‘OBJECT’, ‘ARMATURE’, ‘ARMATURE_NAME’, ‘ARMATURE_AUTO’, ‘ARMATURE_ENVELOPE’, ‘BONE’, ‘CURVE’, ‘FOLLOW’, ‘PATH_CONST’, ‘LATTICE’, ‘VERTEX’, ‘TRIA’], (optional, never None)) – Type

bpy.ops.object.particle_system_add()¶: Add a particle system

bpy.ops.object.particle_system_remove()¶: Remove the selected particle system

bpy.ops.object.paths_calculate()¶: Calculate paths for the selected bones

bpy.ops.object.paths_clear()¶: Clear path caches for selected bones

bpy.ops.object.posemode_toggle()¶: Enables or disables posing/selecting bones

bpy.ops.object.proxy_make(object="", type='DEFAULT')¶

Add empty object to become local replacement data of a library-linked object

Parameters:	object (string, (optional)) – Proxy Object, Name of lib-linked/grouped object to make a proxy for. type (enum in [‘DEFAULT’], (optional, never None)) – Type, Group object

bpy.ops.object.randomize_transform(random_seed=0, use_loc=True, loc=(0.0, 0.0, 0.0), use_rot=True, rot=(0.0, 0.0, 0.0), use_scale=True, scale_even=False, scale_min=0.15, scale=(0.0, 0.0, 0.0))¶

Randomize objects loc/rot/scale

Parameters:

random_seed (int in [0, 1000], (optional)) – Random Seed, Seed value for the random generator
use_loc (boolean, (optional)) – Randomize Location, Randomize the scale values
loc (float array of 3 items in [-100, 100], (optional)) – Location, Maximun distance the objects can spread over each axis
use_rot (boolean, (optional)) – Randomize Rotation, Randomize the rotation values
rot (float array of 3 items in [-180, 180], (optional)) – Rotation, Maximun rotation over each axis
use_scale (boolean, (optional)) – Randomize Scale, Randomize the scale values
scale_even (boolean, (optional)) – Scale Even, Use the same scale value for all axis
scale_min (float in [-1, 1], (optional)) – Minimun Scale Factor, Lowest scale percentage possible
scale (float array of 3 items in [-100, 100], (optional)) – Scale, Maximum scale randomization over each axis

File :

op/object_randomize_transform.py:120

bpy.ops.object.rotation_apply()¶: Apply the object’s rotation to its data

bpy.ops.object.rotation_clear()¶: Clear the object’s rotation

bpy.ops.object.scale_apply()¶: Apply the object’s scale to its data

bpy.ops.object.scale_clear()¶: Clear the object’s scale

bpy.ops.object.select_all(action='TOGGLE')¶

Change selection of all visible objects in scene

Parameters:	action (enum in [‘TOGGLE’, ‘SELECT’, ‘DESELECT’, ‘INVERT’], (optional, never None)) – Action, Selection action to execute

bpy.ops.object.select_by_layer(extend=False, layers=1)¶

Select all visible objects on a layer

Parameters:	extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first. layers (int in [1, 20], (optional)) – Layer

bpy.ops.object.select_by_type(extend=False, type='MESH')¶

Select all visible objects that are of a type

Parameters:	extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first. type (enum in [‘MESH’, ‘CURVE’, ‘SURFACE’, ‘META’, ‘TEXT’, ‘ARMATURE’, ‘LATTICE’, ‘EMPTY’, ‘CAMERA’, ‘LAMP’], (optional)) – Type

bpy.ops.object.select_camera()¶

Select object matching a naming pattern

File :	op/object.py:86

bpy.ops.object.select_grouped(extend=False, type='CHILDREN_RECURSIVE')¶

Select all visible objects grouped by various properties

Parameters:	extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first. type (enum in [‘CHILDREN_RECURSIVE’, ‘CHILDREN’, ‘PARENT’, ‘SIBLINGS’, ‘TYPE’, ‘LAYER’, ‘GROUP’, ‘HOOK’, ‘PASS’, ‘COLOR’, ‘PROPERTIES’], (optional, never None)) – Type

bpy.ops.object.select_hierarchy(direction='PARENT', extend=False)¶

Select object relative to the active objects position in the hierarchy

Parameters:	direction (enum in [‘PARENT’, ‘CHILD’], (optional, never None)) – Direction, Direction to select in the hierarchy extend (boolean, (optional)) – Extend, Extend the existing selection
File :	op/object.py:116

bpy.ops.object.select_inverse()¶: Invert selection of all visible objects

bpy.ops.object.select_linked(extend=False, type='OBDATA')¶

Select all visible objects that are linked

Parameters:	extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first. type (enum in [‘OBDATA’, ‘MATERIAL’, ‘TEXTURE’, ‘DUPGROUP’, ‘PARTICLE’, ‘LIBRARY’, ‘LIBRARY_OBDATA’], (optional, never None)) – Type

bpy.ops.object.select_mirror(extend=False)¶

Select the Mirror objects of the selected object eg. L.sword -> R.sword

Parameters:	extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first.

bpy.ops.object.select_name(name="", extend=False)¶

Select an object with this name

Parameters:	name (string, (optional)) – Name, Object name to select. extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first.

bpy.ops.object.select_pattern(pattern="*", case_sensitive=False, extend=True)¶

Select object matching a naming pattern

Parameters:	pattern (string, (optional)) – Pattern, Name filter using ‘’ and ‘?’ wildcard chars case_sensitive* (boolean, (optional)) – Case Sensitive, Do a case sensitive compare extend (boolean, (optional)) – Extend, Extend the existing selection
File :	op/object.py:35

bpy.ops.object.select_random(percent=50.0, extend=False)¶

Set select on random visible objects

Parameters:	percent (float in [0, 100], (optional)) – Percent, Percentage of objects to select randomly extend (boolean, (optional)) – Extend Selection, Extend selection instead of deselecting everything first.

bpy.ops.object.select_same_group(group="")¶

Select object in the same group

Parameters:	group (string, (optional)) – Group, Name of the group to select.

bpy.ops.object.shade_flat()¶: Undocumented (contribute)

bpy.ops.object.shade_smooth()¶: Undocumented (contribute)

bpy.ops.object.shape_key_add(from_mix=True)¶

Undocumented (contribute)

Parameters:	from_mix (boolean, (optional)) – From Mix, Create the new shape key from the existing mix of keys.

bpy.ops.object.shape_key_clear()¶: Clear weights for all shape keys

bpy.ops.object.shape_key_mirror()¶: Undocumented (contribute)

bpy.ops.object.shape_key_move(type='UP')¶

Undocumented (contribute)

Parameters:	type (enum in [‘UP’, ‘DOWN’], (optional)) – Type

bpy.ops.object.shape_key_remove()¶: Undocumented (contribute)

bpy.ops.object.shape_key_transfer(mode='OFFSET', use_clamp=False)¶

Copy another selected objects active shape to this one by applying the relative offsets

Parameters:	mode (enum in [‘OFFSET’, ‘RELATIVE_FACE’, ‘RELATIVE_EDGE’], (optional)) – Transformation Mode, Method to apply relative shape positions to the new shape use_clamp (boolean, (optional)) – Clamp Offset, Clamp the transformation to the distance each vertex moves in the original shape.
File :	op/object.py:387

bpy.ops.object.slow_parent_clear()¶: Clear the object’s slow parent

bpy.ops.object.slow_parent_set()¶: Set the object’s slow parent

bpy.ops.object.subdivision_set(level=1, relative=False)¶

Sets a Subdivision Surface Level (1-5)

Parameters:	level (int in [-100, 100], (optional)) – Level relative (boolean, (optional)) – Relative, Apply the subsurf level as an offset relative to the current level
File :	op/object.py:175

bpy.ops.object.text_add(view_align=False, enter_editmode=False, location=(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))¶

Add a text object to the scene

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 this object.
location (float array of 3 items in [-inf, inf], (optional)) – Location, Location for the newly added object.
rotation (float array of 3 items in [-inf, inf], (optional)) – Rotation, Rotation for the newly added object
layers (boolean array of 20 items, (optional)) – Layer

bpy.ops.object.track_clear(type='CLEAR')¶

Clear tracking constraint or flag from object

Parameters:	type (enum in [‘CLEAR’, ‘CLEAR_KEEP_TRANSFORM’], (optional, never None)) – Type

bpy.ops.object.track_set(type='DAMPTRACK')¶

Make the object track another object, either by constraint or old way or locked track

Parameters:	type (enum in [‘DAMPTRACK’, ‘TRACKTO’, ‘LOCKTRACK’], (optional, never None)) – Type

bpy.ops.object.vertex_group_add()¶: Undocumented (contribute)

bpy.ops.object.vertex_group_assign(new=False)¶

Undocumented (contribute)

Parameters:	new (boolean, (optional)) – New, Assign vertex to new vertex group.

bpy.ops.object.vertex_group_blend()¶: Undocumented (contribute)

bpy.ops.object.vertex_group_clean(limit=0.01, all_groups=False, keep_single=False)¶

Remove Vertex Group assignments which aren’t required

Parameters:	limit (float in [0, 1], (optional)) – Limit, Remove weights under this limit. all_groups (boolean, (optional)) – All Groups, Clean all vertex groups. keep_single (boolean, (optional)) – Keep Single, Keep verts assigned to at least one group when cleaning.

bpy.ops.object.vertex_group_copy()¶: Undocumented (contribute)

bpy.ops.object.vertex_group_copy_to_linked()¶: Copy Vertex Groups to all users of the same Geometry data

bpy.ops.object.vertex_group_copy_to_selected()¶: Copy Vertex Groups to other selected objects with matching indicies

bpy.ops.object.vertex_group_deselect()¶: Undocumented (contribute)

bpy.ops.object.vertex_group_invert(auto_assign=True, auto_remove=True)¶

Undocumented (contribute)

Parameters:	auto_assign (boolean, (optional)) – Add Weights, Add verts from groups that have zero weight before inverting. auto_remove (boolean, (optional)) – Remove Weights, Remove verts from groups that have zero weight after inverting.

bpy.ops.object.vertex_group_levels(offset=0.0, gain=1.0)¶

Undocumented (contribute)

Parameters:	offset (float in [-1, 1], (optional)) – Offset, Value to add to weights. gain (float in [0, inf], (optional)) – Gain, Value to multiply weights by.

bpy.ops.object.vertex_group_mirror(mirror_weights=True, flip_group_names=True)¶

Mirror weights, and flip vertex group names, copying when only one side is selected

Parameters:	mirror_weights (boolean, (optional)) – Mirror Weights, Mirror weights. flip_group_names (boolean, (optional)) – Flip Groups, Flip vertex group names while mirroring.

bpy.ops.object.vertex_group_move(direction='UP')¶

Undocumented (contribute)

Parameters:	direction (enum in [‘UP’, ‘DOWN’], (optional)) – Direction, Direction to move, UP or DOWN

bpy.ops.object.vertex_group_normalize()¶: Undocumented (contribute)

bpy.ops.object.vertex_group_normalize_all(lock_active=True)¶

Undocumented (contribute)

Parameters:	lock_active (boolean, (optional)) – Lock Active, Keep the values of the active group while normalizing others.

bpy.ops.object.vertex_group_remove(all=False)¶

Undocumented (contribute)

Parameters:	all (boolean, (optional)) – All, Remove from all vertex groups.

bpy.ops.object.vertex_group_remove_from(all=False)¶

Undocumented (contribute)

Parameters:	all (boolean, (optional)) – All, Remove from all vertex groups.

bpy.ops.object.vertex_group_select()¶: Undocumented (contribute)

bpy.ops.object.vertex_group_set_active(group='')¶

Set the active vertex group

Parameters:	group (enum in [], (optional)) – Group, Vertex group to set as active.

bpy.ops.object.vertex_group_sort()¶: Sorts vertex groups alphabetically

bpy.ops.object.vertex_parent_set()¶: Parent selected objects to the selected vertices

bpy.ops.object.visual_transform_apply()¶: Apply the object’s visual transformation to its data

Object Operators¶

Previous topic

Next topic

Navigation

Object Operators¶

Previous topic

Next topic

Quick search