# View3D Operators

`bpy.ops.view3d.``background_image_add`(name="Image", filepath="", hide_props_region=True, filter_blender=False, filter_backup=False, filter_image=True, filter_movie=True, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_archive=False, filter_btx=False, filter_collada=False, filter_alembic=False, filter_usd=False, filter_folder=True, filter_blenlib=False, filemode=9, relative_path=True, show_multiview=False, use_multiview=False, display_type='DEFAULT', sort_method='FILE_SORT_ALPHA')

  Add a new background image

  Parameters: | name (string, (optional, never None)) – Name, Image name to assign filepath (string, (optional, never None)) – File Path, Path to file hide_props_region (boolean, (optional)) – Hide Operator Properties, Collapse the region displaying the operator settings filter_blender (boolean, (optional)) – Filter .blend files filter_backup (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_archive (boolean, (optional)) – Filter archive files filter_btx (boolean, (optional)) – Filter btx files filter_collada (boolean, (optional)) – Filter COLLADA files filter_alembic (boolean, (optional)) – Filter Alembic files filter_usd (boolean, (optional)) – Filter USD files filter_folder (boolean, (optional)) – Filter folders filter_blenlib (boolean, (optional)) – Filter Blender IDs 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 show_multiview (boolean, (optional)) – Enable Multi-View use_multiview (boolean, (optional)) – Use Multi-View display_type (enum in ['DEFAULT', 'LIST_VERTICAL', 'LIST_HORIZONTAL', 'THUMBNAIL'], (optional)) – Display Type `DEFAULT` Default, Automatically determine display type for files. `LIST_VERTICAL` Short List, Display files as short list. `LIST_HORIZONTAL` Long List, Display files as a detailed list. `THUMBNAIL` Thumbnails, Display files as thumbnails. sort_method (enum in ['FILE_SORT_ALPHA', 'FILE_SORT_EXTENSION', 'FILE_SORT_TIME', 'FILE_SORT_SIZE'], (optional)) – File sorting mode `FILE_SORT_ALPHA` Name, Sort the file list alphabetically. `FILE_SORT_EXTENSION` Extension, Sort the file list by extension/type. `FILE_SORT_TIME` Modified Date, Sort files by modification time. `FILE_SORT_SIZE` Size, Sort files by size.

`bpy.ops.view3d.``background_image_remove`(index=0)

  Remove a background image from the 3D view

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

`bpy.ops.view3d.``camera_to_view`()

  Set camera view to active view

`bpy.ops.view3d.``camera_to_view_selected`()

  Move the camera so selected objects are framed

`bpy.ops.view3d.``clear_render_border`()

  Clear the boundaries of the border render and disable border render

`bpy.ops.view3d.``clip_border`(xmin=0, xmax=0, ymin=0, ymax=0, wait_for_input=True)

  Set the view clipping region

  Parameters: | xmin (int in [-inf, inf], (optional)) – X Min xmax (int in [-inf, inf], (optional)) – X Max ymin (int in [-inf, inf], (optional)) – Y Min ymax (int in [-inf, inf], (optional)) – Y Max wait_for_input (boolean, (optional)) – Wait for Input

`bpy.ops.view3d.``copybuffer`()

  Selected objects are copied to the clipboard

`bpy.ops.view3d.``cursor3d`(use_depth=True, orientation='VIEW')

  Set the location of the 3D cursor

  Parameters: | use_depth (boolean, (optional)) – Surface Project, Project onto the surface orientation (enum in ['NONE', 'VIEW', 'XFORM', 'GEOM'], (optional)) – Orientation, Preset viewpoint to use `NONE` None, Leave orientation unchanged. `VIEW` View, Orient to the viewport. `XFORM` Transform, Orient to the current transform setting. `GEOM` Geometry, Match the surface normal.

`bpy.ops.view3d.``dolly`(mx=0, my=0, delta=0, use_cursor_init=True)

  Dolly in/out in the view

  Parameters: | mx (int in [0, inf], (optional)) – Region Position X my (int in [0, inf], (optional)) – Region Position Y delta (int in [-inf, inf], (optional)) – Delta use_cursor_init (boolean, (optional)) – Use Mouse Position, Allow the initial mouse position to be used

`bpy.ops.view3d.``edit_mesh_extrude_individual_move`()

  Extrude each individual face separately along local normals

  File: | startup/bl_operators/view3d.py:39

`bpy.ops.view3d.``edit_mesh_extrude_move_normal`()

  Extrude region together along the average normal

  File: | startup/bl_operators/view3d.py:121

`bpy.ops.view3d.``edit_mesh_extrude_move_shrink_fatten`()

  Extrude region together along local normals

  File: | startup/bl_operators/view3d.py:138

`bpy.ops.view3d.``fly`()

  Interactively fly around the scene

`bpy.ops.view3d.``localview`(frame_selected=True)

  Toggle display of selected object(s) separately and centered in view

  Parameters: | frame_selected (boolean, (optional)) – Frame Selected, Move the view to frame the selected objects

`bpy.ops.view3d.``localview_remove_from`()

  Move selected objects out of local view

`bpy.ops.view3d.``move`(use_cursor_init=True)

  Move the view

  Parameters: | use_cursor_init (boolean, (optional)) – Use Mouse Position, Allow the initial mouse position to be used

`bpy.ops.view3d.``navigate`()

  Interactively navigate around the scene (uses the mode (walk/fly) preference)

`bpy.ops.view3d.``ndof_all`()

  Pan and rotate the view with the 3D mouse

`bpy.ops.view3d.``ndof_orbit`()

  Orbit the view using the 3D mouse

`bpy.ops.view3d.``ndof_orbit_zoom`()

  Orbit and zoom the view using the 3D mouse

`bpy.ops.view3d.``ndof_pan`()

  Pan the view with the 3D mouse

`bpy.ops.view3d.``object_as_camera`()

  Set the active object as the active camera for this view or scene

`bpy.ops.view3d.``object_mode_pie_or_toggle`()

  Undocumented contribute <https://developer.blender.org/T51061>

`bpy.ops.view3d.``pastebuffer`(autoselect=True, active_collection=True)

  Objects from the clipboard are pasted

  Parameters: | autoselect (boolean, (optional)) – Select, Select pasted objects active_collection (boolean, (optional)) – Active Collection, Put pasted objects in the active collection

`bpy.ops.view3d.``render_border`(xmin=0, xmax=0, ymin=0, ymax=0, wait_for_input=True)

  Set the boundaries of the border render and enable border render

  Parameters: | xmin (int in [-inf, inf], (optional)) – X Min xmax (int in [-inf, inf], (optional)) – X Max ymin (int in [-inf, inf], (optional)) – Y Min ymax (int in [-inf, inf], (optional)) – Y Max wait_for_input (boolean, (optional)) – Wait for Input

`bpy.ops.view3d.``rotate`(use_cursor_init=True)

  Rotate the view

  Parameters: | use_cursor_init (boolean, (optional)) – Use Mouse Position, Allow the initial mouse position to be used

`bpy.ops.view3d.``ruler_add`()

  Undocumented contribute <https://developer.blender.org/T51061>

`bpy.ops.view3d.``ruler_remove`()

  Undocumented contribute <https://developer.blender.org/T51061>

`bpy.ops.view3d.``select`(extend=False, deselect=False, toggle=False, deselect_all=False, center=False, enumerate=False, object=False, location=(0, 0))

  Select and activate item(s)

  Parameters: | extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first deselect (boolean, (optional)) – Deselect, Remove from selection toggle (boolean, (optional)) – Toggle Selection, Toggle the selection deselect_all (boolean, (optional)) – Deselect On Nothing, Deselect all when nothing under the cursor center (boolean, (optional)) – Center, Use the object center when selecting, in editmode used to extend object selection enumerate (boolean, (optional)) – Enumerate, List objects under the mouse (object mode only) object (boolean, (optional)) – Object, Use object selection (editmode only) location (int array of 2 items in [-inf, inf], (optional)) – Location, Mouse location

`bpy.ops.view3d.``select_box`(xmin=0, xmax=0, ymin=0, ymax=0, wait_for_input=True, mode='SET')

  Select items using box selection

  Parameters: | xmin (int in [-inf, inf], (optional)) – X Min xmax (int in [-inf, inf], (optional)) – X Max ymin (int in [-inf, inf], (optional)) – Y Min ymax (int in [-inf, inf], (optional)) – Y Max wait_for_input (boolean, (optional)) – Wait for Input mode (enum in ['SET', 'ADD', 'SUB', 'XOR', 'AND'], (optional)) – Mode `SET` Set, Set a new selection. `ADD` Extend, Extend existing selection. `SUB` Subtract, Subtract existing selection. `XOR` Difference, Inverts existing selection. `AND` Intersect, Intersect existing selection.

`bpy.ops.view3d.``select_circle`(x=0, y=0, radius=25, wait_for_input=True, mode='SET')

  Select items using circle selection

  Parameters: | x (int in [-inf, inf], (optional)) – X y (int in [-inf, inf], (optional)) – Y radius (int in [1, inf], (optional)) – Radius wait_for_input (boolean, (optional)) – Wait for Input mode (enum in ['SET', 'ADD', 'SUB'], (optional)) – Mode `SET` Set, Set a new selection. `ADD` Extend, Extend existing selection. `SUB` Subtract, Subtract existing selection.

`bpy.ops.view3d.``select_lasso`(path=None, mode='SET')

  Select items using lasso selection

  Parameters: | path (`bpy_prop_collection` of `OperatorMousePath`, (optional)) – Path mode (enum in ['SET', 'ADD', 'SUB', 'XOR', 'AND'], (optional)) – Mode `SET` Set, Set a new selection. `ADD` Extend, Extend existing selection. `SUB` Subtract, Subtract existing selection. `XOR` Difference, Inverts existing selection. `AND` Intersect, Intersect existing selection.

`bpy.ops.view3d.``select_menu`(name='', extend=False, deselect=False, toggle=False)

  Menu object selection

  Parameters: | name (enum in [], (optional)) – Object Name extend (boolean, (optional)) – Extend deselect (boolean, (optional)) – Deselect toggle (boolean, (optional)) – Toggle

`bpy.ops.view3d.``smoothview`()

  Undocumented contribute <https://developer.blender.org/T51061>

`bpy.ops.view3d.``snap_cursor_to_active`()

  Snap 3D cursor to the active item

`bpy.ops.view3d.``snap_cursor_to_center`()

  Snap 3D cursor to the world origin

`bpy.ops.view3d.``snap_cursor_to_grid`()

  Snap 3D cursor to the nearest grid division

`bpy.ops.view3d.``snap_cursor_to_selected`()

  Snap 3D cursor to the middle of the selected item(s)

`bpy.ops.view3d.``snap_selected_to_active`()

  Snap selected item(s) to the active item

`bpy.ops.view3d.``snap_selected_to_cursor`(use_offset=True)

  Snap selected item(s) to the 3D cursor

  Parameters: | use_offset (boolean, (optional)) – Offset, If the selection should be snapped as a whole or by each object center

`bpy.ops.view3d.``snap_selected_to_grid`()

  Snap selected item(s) to their nearest grid division

`bpy.ops.view3d.``toggle_matcap_flip`()

  Flip MatCap

`bpy.ops.view3d.``toggle_shading`(type='WIREFRAME')

  Toggle shading type in 3D viewport

  Parameters: | type (enum in ['WIREFRAME', 'SOLID', 'MATERIAL', 'RENDERED'], (optional)) – Type, Shading type to toggle `WIREFRAME` Wireframe, Toggle wireframe shading. `SOLID` Solid, Toggle solid shading. `MATERIAL` LookDev, Toggle lookdev shading. `RENDERED` Rendered, Toggle rendered shading.

`bpy.ops.view3d.``toggle_xray`()

  Undocumented contribute <https://developer.blender.org/T51061>

`bpy.ops.view3d.``transform_gizmo_set`(extend=False, type={})

  Set the current transform gizmo

  Parameters: | extend (boolean, (optional)) – extend type (enum set in {'TRANSLATE', 'ROTATE', 'SCALE'}, (optional)) – type
  File: | startup/bl_operators/view3d.py:167

`bpy.ops.view3d.``view_all`(use_all_regions=False, center=False)

  View all objects in scene

  Parameters: | use_all_regions (boolean, (optional)) – All Regions, View selected for all regions center (boolean, (optional)) – Center

`bpy.ops.view3d.``view_axis`(type='LEFT', align_active=False, relative=False)

  Use a preset viewpoint

  Parameters: | type (enum in ['LEFT', 'RIGHT', 'BOTTOM', 'TOP', 'FRONT', 'BACK'], (optional)) – View, Preset viewpoint to use `LEFT` Left, View From the Left. `RIGHT` Right, View From the Right. `BOTTOM` Bottom, View From the Bottom. `TOP` Top, View From the Top. `FRONT` Front, View From the Front. `BACK` Back, View From the Back. align_active (boolean, (optional)) – Align Active, Align to the active object’s axis relative (boolean, (optional)) – Relative, Rotate relative to the current orientation

`bpy.ops.view3d.``view_camera`()

  Toggle the camera view

`bpy.ops.view3d.``view_center_camera`()

  Center the camera view

`bpy.ops.view3d.``view_center_cursor`()

  Center the view so that the cursor is in the middle of the view

`bpy.ops.view3d.``view_center_lock`()

  Center the view lock offset

`bpy.ops.view3d.``view_center_pick`()

  Center the view to the Z-depth position under the mouse cursor

`bpy.ops.view3d.``view_lock_clear`()

  Clear all view locking

`bpy.ops.view3d.``view_lock_to_active`()

  Lock the view to the active object/bone

`bpy.ops.view3d.``view_orbit`(angle=0.0, type='ORBITLEFT')

  Orbit the view

  Parameters: | angle (float in [-inf, inf], (optional)) – Roll type (enum in ['ORBITLEFT', 'ORBITRIGHT', 'ORBITUP', 'ORBITDOWN'], (optional)) – Orbit, Direction of View Orbit `ORBITLEFT` Orbit Left, Orbit the view around to the Left. `ORBITRIGHT` Orbit Right, Orbit the view around to the Right. `ORBITUP` Orbit Up, Orbit the view Up. `ORBITDOWN` Orbit Down, Orbit the view Down.

`bpy.ops.view3d.``view_pan`(type='PANLEFT')

  Pan the view in a given direction

  Parameters: | type (enum in ['PANLEFT', 'PANRIGHT', 'PANUP', 'PANDOWN'], (optional)) – Pan, Direction of View Pan `PANLEFT` Pan Left, Pan the view to the Left. `PANRIGHT` Pan Right, Pan the view to the Right. `PANUP` Pan Up, Pan the view Up. `PANDOWN` Pan Down, Pan the view Down.

`bpy.ops.view3d.``view_persportho`()

  Switch the current view from perspective/orthographic projection

`bpy.ops.view3d.``view_roll`(angle=0.0, type='ANGLE')

  Roll the view

  Parameters: | angle (float in [-inf, inf], (optional)) – Roll type (enum in ['ANGLE', 'LEFT', 'RIGHT'], (optional)) – Roll Angle Source, How roll angle is calculated `ANGLE` Roll Angle, Roll the view using an angle value. `LEFT` Roll Left, Roll the view around to the Left. `RIGHT` Roll Right, Roll the view around to the Right.

`bpy.ops.view3d.``view_selected`(use_all_regions=False)

  Move the view to the selection center

  Parameters: | use_all_regions (boolean, (optional)) – All Regions, View selected for all regions

`bpy.ops.view3d.``walk`()

  Interactively walk around the scene

`bpy.ops.view3d.``zoom`(mx=0, my=0, delta=0, use_cursor_init=True)

  Zoom in/out in the view

  Parameters: | mx (int in [0, inf], (optional)) – Region Position X my (int in [0, inf], (optional)) – Region Position Y delta (int in [-inf, inf], (optional)) – Delta use_cursor_init (boolean, (optional)) – Use Mouse Position, Allow the initial mouse position to be used

`bpy.ops.view3d.``zoom_border`(xmin=0, xmax=0, ymin=0, ymax=0, wait_for_input=True, zoom_out=False)

  Zoom in the view to the nearest object contained in the border

  Parameters: | xmin (int in [-inf, inf], (optional)) – X Min xmax (int in [-inf, inf], (optional)) – X Max ymin (int in [-inf, inf], (optional)) – Y Min ymax (int in [-inf, inf], (optional)) – Y Max wait_for_input (boolean, (optional)) – Wait for Input zoom_out (boolean, (optional)) – Zoom Out

`bpy.ops.view3d.``zoom_camera_1_to_1`()

  Match the camera to 1:1 to the render output