View3D Operators¶
-
bpy.ops.view3d.
background_image_add
(name="Image", filepath="", 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_btx=False, filter_collada=False, filter_alembic=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 (Ctrl for Empty Object)
Parameters: - name (string, (optional, never None)) – Name, Image name to assign
- filepath (string, (optional, never None)) – File Path, Path to file
- 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_btx (boolean, (optional)) – Filter btx files
- filter_collada (boolean, (optional)) – Filter COLLADA files
- filter_alembic (boolean, (optional)) – Filter Alembic 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_SHORT', 'LIST_LONG', 'THUMBNAIL'], (optional)) –
Display Type
DEFAULT
Default, Automatically determine display type for files.LIST_SHORT
Short List, Display files as short list.LIST_LONG
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
Sort alphabetically, Sort the file list alphabetically.FILE_SORT_EXTENSION
Sort by extension, Sort the file list by extension/type.FILE_SORT_TIME
Sort by time, Sort files by modification time.FILE_SORT_SIZE
Sort by 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)¶ Set the view clipping 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
-
bpy.ops.view3d.
copybuffer
()¶ Selected objects are saved in a temp file
-
bpy.ops.view3d.
cursor3d
()¶ Set the location of the 3D cursor
-
bpy.ops.view3d.
dolly
(delta=0, mx=0, my=0)¶ Dolly in/out in the view
Parameters: - delta (int in [-inf, inf], (optional)) – Delta
- mx (int in [0, inf], (optional)) – Zoom Position X
- my (int in [0, inf], (optional)) – Zoom Position Y
-
bpy.ops.view3d.
edit_mesh_extrude_individual_move
()¶ Extrude individual elements and move
File: startup/bl_operators/view3d.py:36
-
bpy.ops.view3d.
edit_mesh_extrude_move_normal
()¶ Extrude and move along normals
File: startup/bl_operators/view3d.py:106
-
bpy.ops.view3d.
edit_mesh_extrude_move_shrink_fatten
()¶ Extrude and move along individual normals
File: startup/bl_operators/view3d.py:123
-
bpy.ops.view3d.
enable_manipulator
(translate=False, rotate=False, scale=False)¶ Enable the transform manipulator for use
Parameters: - translate (boolean, (optional)) – Translate, Enable the translate manipulator
- rotate (boolean, (optional)) – Rotate, Enable the rotate manipulator
- scale (boolean, (optional)) – Scale, Enable the scale manipulator
-
bpy.ops.view3d.
fly
()¶ Interactively fly around the scene
-
bpy.ops.view3d.
game_start
()¶ Start game engine
-
bpy.ops.view3d.
layers
(nr=1, extend=False, toggle=True)¶ Toggle layer(s) visibility
Parameters: - nr (int in [0, 20], (optional)) – Number, The layer number to set, zero for all layers
- extend (boolean, (optional)) – Extend, Add this layer to the current view layers
- toggle (boolean, (optional)) – Toggle, Toggle the layer
-
bpy.ops.view3d.
localview
()¶ Toggle display of selected object(s) separately and centered in view
-
bpy.ops.view3d.
manipulator
(constraint_axis=(False, False, False), constraint_orientation='GLOBAL', release_confirm=False)¶ Manipulate selected item by axis
Parameters: - constraint_axis (boolean array of 3 items, (optional)) – Constraint Axis
- constraint_orientation (enum in [], (optional)) – Orientation, Transformation orientation
- release_confirm (boolean, (optional)) – Confirm on Release, Always confirm operation when releasing button
-
bpy.ops.view3d.
move
()¶ Move the view
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.
pastebuffer
(autoselect=True, active_layer=True)¶ Contents of copy buffer gets pasted
Parameters: - autoselect (boolean, (optional)) – Select, Select pasted objects
- active_layer (boolean, (optional)) – Active Layer, Put pasted objects on the active layer
-
bpy.ops.view3d.
properties
()¶ Toggle the properties region visibility
-
bpy.ops.view3d.
render_border
(xmin=0, xmax=0, ymin=0, ymax=0, camera_only=False)¶ 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
- camera_only (boolean, (optional)) – Camera Only, Set render border for camera view and final render only
-
bpy.ops.view3d.
rotate
()¶ Rotate the view
-
bpy.ops.view3d.
ruler
()¶ Interactive ruler
-
bpy.ops.view3d.
select
(extend=False, deselect=False, toggle=False, center=False, enumerate=False, object=False, location=(0, 0))¶ Activate/select 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
- 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_border
(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0, extend=True)¶ Select items using 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
- extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first
-
bpy.ops.view3d.
select_circle
(x=0, y=0, radius=1, gesture_mode=0)¶ 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
- gesture_mode (int in [-inf, inf], (optional)) – Event Type
-
bpy.ops.view3d.
select_lasso
(path=None, deselect=False, extend=True)¶ Select items using lasso selection
Parameters: - path (
bpy_prop_collection
ofOperatorMousePath
, (optional)) – Path - deselect (boolean, (optional)) – Deselect, Deselect rather than select items
- extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first
- path (
Menu object selection
Parameters: - name (enum in [], (optional)) – Object Name
- toggle (boolean, (optional)) – Toggle, Toggle selection instead of deselecting everything first
-
bpy.ops.view3d.
select_or_deselect_all
(extend=False, toggle=False, deselect=False, center=False, enumerate=False, object=False)¶ Select element under the mouse, deselect everything is there’s nothing under the mouse
Parameters: - extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first
- toggle (boolean, (optional)) – Toggle, Toggle the selection
- deselect (boolean, (optional)) – Deselect, Remove from selection
- 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)
File:
-
bpy.ops.view3d.
smoothview
()¶ Undocumented
-
bpy.ops.view3d.
snap_cursor_to_active
()¶ Snap cursor to active item
-
bpy.ops.view3d.
snap_cursor_to_center
()¶ Snap cursor to the Center
-
bpy.ops.view3d.
snap_cursor_to_grid
()¶ Snap cursor to nearest grid division
-
bpy.ops.view3d.
snap_cursor_to_selected
()¶ Snap cursor to center of 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 cursor
Parameters: use_offset (boolean, (optional)) – Offset
-
bpy.ops.view3d.
snap_selected_to_grid
()¶ Snap selected item(s) to nearest grid division
-
bpy.ops.view3d.
toggle_render
()¶ Toggle rendered shading mode of the viewport
-
bpy.ops.view3d.
toolshelf
()¶ Toggles tool shelf display
-
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_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
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.
viewnumpad
(type='LEFT', align_active=False)¶ Use a preset viewpoint
Parameters: - type (enum in ['LEFT', 'RIGHT', 'BOTTOM', 'TOP', 'FRONT', 'BACK', 'CAMERA'], (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.CAMERA
Camera, View From the Active Camera.
- align_active (boolean, (optional)) – Align Active, Align to the active object’s axis
- type (enum in ['LEFT', 'RIGHT', 'BOTTOM', 'TOP', 'FRONT', 'BACK', 'CAMERA'], (optional)) –
-
bpy.ops.view3d.
walk
()¶ Interactively walk around the scene
-
bpy.ops.view3d.
zoom
(delta=0, mx=0, my=0)¶ Zoom in/out in the view
Parameters: - delta (int in [-inf, inf], (optional)) – Delta
- mx (int in [0, inf], (optional)) – Zoom Position X
- my (int in [0, inf], (optional)) – Zoom Position Y
-
bpy.ops.view3d.
zoom_border
(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0)¶ Zoom in the view to the nearest object 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.view3d.
zoom_camera_1_to_1
()¶ Match the camera to 1:1 to the render output