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

Module view3d

Functions [hide private]
 
camera_to_view()
Set camera view to active view.
 
clip_border(xmin=0, xmax=0, ymin=0, ymax=0)
Set the view clipping border.
 
cursor3d()
Set the location of the 3D cursor.
 
fly()
Interactively fly around the scene.
 
game_start()
Start game engine.
 
layers(nr=1, extend=False)
Toggle layer(s) visibility.
 
localview()
Toggle display of selected object(s) separately and centered in view.
 
manipulator(constraint_axis=(False, False, False))
Manipulate selected item by axis.
 
move()
Move the view.
 
object_as_camera()
Set the active object as the active camera for this view or scene.
 
properties()
Toggles the properties panel display.
 
render_border(xmin=0, xmax=0, ymin=0, ymax=0)
Set the boundries of the border render and enables border render .
 
rotate()
Rotate the view.
 
select(extend=False, center=False, enumerate=False)
Activate/select item(s).
 
select_border(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0, extend=True)
Select items using border selection.
 
select_circle(x=0, y=0, radius=0, gesture_mode=0)
Select items using circle selection.
 
select_lasso(path=None, deselect=False)
Select items using lasso selection.
 
smoothview()
The time to animate the change of view (in milliseconds)
 
snap_cursor_to_active()
Snap cursor to active item.
 
snap_cursor_to_grid()
Snap cursor to nearest grid node.
 
snap_cursor_to_selected()
Snap cursor to center of selected item(s).
 
snap_menu()
Display snap menu.
 
snap_selected_to_center()
Snap selected items to selections geometric center.
 
snap_selected_to_cursor()
Snap selected item(s) to cursor.
 
snap_selected_to_grid()
Snap selected item(s) to nearest grid node.
 
toolbar()
Toggles toolbar display.
 
view_all(center=False)
View all objects in scene.
 
view_center()
Move the view to the selection center.
 
view_center_cursor()
Centers the view so that the cursor is in the middle of the view.
 
view_orbit(type='ORBITLEFT')
Orbit the view.
 
view_pan(type='PANLEFT')
Pan the view.
 
view_persportho()
Switch the current view from perspective/orthographic.
 
viewnumpad(type='FRONT', align_active=False)
Set the view.
 
zoom(delta=0, mx=0, my=0)
Zoom in/out in the view.
 
zoom_border(xmin=0, xmax=0, ymin=0, ymax=0)
Zoom in the view to the nearest object contained in the border.
Function Details [hide private]

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

 

Set the view clipping border.

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

layers(nr=1, extend=False)

 

Toggle layer(s) visibility.

Parameters:
  • nr (int) - The layer number to set, zero for all layers in (0, 20)
  • extend (boolean)

manipulator(constraint_axis=(False, False, False))

 

Manipulate selected item by axis.

Parameters:
  • constraint_axis (boolean array of 3 items)

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

 

Set the boundries of the border render and enables border render .

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

select(extend=False, center=False, enumerate=False)

 

Activate/select item(s).

Parameters:
  • center (boolean)
  • extend (boolean)
  • enumerate (boolean)

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)
  • xmin (int) - in (-inf, inf)
  • xmax (int) - in (-inf, inf)
  • ymin (int) - in (-inf, inf)
  • ymax (int) - in (-inf, inf)
  • extend (boolean)

select_circle(x=0, y=0, radius=0, gesture_mode=0)

 

Select items using circle selection.

Parameters:
  • x (int) - in (-inf, inf)
  • y (int) - in (-inf, inf)
  • radius (int) - in (-inf, inf)
  • gesture_mode (int) - in (-inf, inf)

select_lasso(path=None, deselect=False)

 

Select items using lasso selection.

Parameters:
  • path (collection)
  • deselect (boolean)

view_all(center=False)

 

View all objects in scene.

Parameters:
  • center (boolean)

view_orbit(type='ORBITLEFT')

 

Orbit the view.

Parameters:
  • type (enum) - Direction of View Orbit in (ORBITLEFT, ORBITRIGHT, ORBITUP, ORBITDOWN)

view_pan(type='PANLEFT')

 

Pan the view.

Parameters:
  • type (enum) - Direction of View Pan in (PANLEFT, PANRIGHT, PANUP, PANDOWN)

viewnumpad(type='FRONT', align_active=False)

 

Set the view.

Parameters:
  • type (enum) - The Type of view in (FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM, CAMERA)
  • align_active (boolean)

zoom(delta=0, mx=0, my=0)

 

Zoom in/out in the view.

Parameters:
  • delta (int) - in (-inf, inf)
  • mx (int) - in (0, inf)
  • my (int) - in (0, inf)

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

 

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

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