SpaceView3D(Space)

base classes — bpy_struct, Space

class bpy.types.SpaceView3D(Space)

3D View space data

active_layer

Active 3D view layer index

Type:int in [-inf, inf], default 0, (readonly)
background_images

List of background images

Type:BackgroundImages bpy_prop_collection of BackgroundImage, (readonly)
camera

Active camera used in this view (when unlocked from the scene’s active camera)

Type:Object
clip_end

3D View far clipping distance

Type:float in [1e-06, inf], default 1000.0
clip_start

3D View near clipping distance (perspective view only)

Type:float in [1e-06, inf], default 0.1
current_orientation

Current transformation orientation

Type:TransformOrientation, (readonly)
cursor_location

3D cursor location for this view (dependent on local view setting)

Type:float array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)
fx_settings

Options used for real time compositing

Type:GPUFXSettings, (readonly)
grid_lines

Number of grid lines to display in perspective view

Type:int in [0, 1024], default 16
grid_scale

Distance between 3D View grid lines

Type:float in [0, inf], default 1.0
grid_scale_unit

Grid cell size scaled by scene unit system settings

Type:float in [-inf, inf], default 0.0, (readonly)
grid_subdivisions

Number of subdivisions between grid lines

Type:int in [1, 1024], default 10
layers

Layers visible in this 3D View

Type:boolean array of 20 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False)
layers_local_view

Local view layers visible in this 3D View

Type:boolean array of 8 items, default (False, False, False, False, False, False, False, False), (readonly)
layers_used

Layers that contain something

Type:boolean array of 20 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False), (readonly)
lens

Viewport lens angle

Type:float in [1, 250], default 0.0
local_view

Display an isolated sub-set of objects, apart from the scene visibility

Type:SpaceView3D, (readonly)
lock_bone

3D View center is locked to this bone’s position

Type:string, default “”, (never None)
lock_camera

Enable view navigation within the camera view

Type:boolean, default False
lock_camera_and_layers

Use the scene’s active camera and layers in this view, rather than local layers

Type:boolean, default False
lock_cursor

3D View center is locked to the cursor’s position

Type:boolean, default False
lock_object

3D View center is locked to this object’s position

Type:Object
matcap_icon

Image to use for Material Capture, active objects only

Type:enum in [‘01’, ‘02’, ‘03’, ‘04’, ‘05’, ‘06’, ‘07’, ‘08’, ‘09’, ‘10’, ‘11’, ‘12’, ‘13’, ‘14’, ‘15’, ‘16’, ‘17’, ‘18’, ‘19’, ‘20’, ‘21’, ‘22’, ‘23’, ‘24’], default ‘01’
pivot_point

Pivot center for rotation/scaling

  • BOUNDING_BOX_CENTER Bounding Box Center, Pivot around bounding box center of selected object(s).
  • CURSOR 3D Cursor, Pivot around the 3D cursor.
  • INDIVIDUAL_ORIGINS Individual Origins, Pivot around each object’s own origin.
  • MEDIAN_POINT Median Point, Pivot around the median point of selected objects.
  • ACTIVE_ELEMENT Active Element, Pivot around active object.
Type:enum in [‘BOUNDING_BOX_CENTER’, ‘CURSOR’, ‘INDIVIDUAL_ORIGINS’, ‘MEDIAN_POINT’, ‘ACTIVE_ELEMENT’], default ‘BOUNDING_BOX_CENTER’
region_3d

3D region in this space, in case of quad view the camera region

Type:RegionView3D, (readonly)
region_quadviews

3D regions (the third one defines quad view settings, the fourth one is same as ‘region_3d’)

Type:bpy_prop_collection of RegionView3D, (readonly)
render_border_max_x

Maximum X value for the render border

Type:float in [0, 1], default 0.0
render_border_max_y

Maximum Y value for the render border

Type:float in [0, 1], default 0.0
render_border_min_x

Minimum X value for the render border

Type:float in [0, 1], default 0.0
render_border_min_y

Minimum Y value for the render border

Type:float in [0, 1], default 0.0
show_all_objects_origin

Show the object origin center dot for all (selected and unselected) objects

Type:boolean, default False
show_axis_x

Show the X axis line in perspective view

Type:boolean, default False
show_axis_y

Show the Y axis line in perspective view

Type:boolean, default False
show_axis_z

Show the Z axis line in perspective view

Type:boolean, default False
show_backface_culling

Use back face culling to hide the back side of faces

Type:boolean, default False
show_background_images

Display reference images behind objects in the 3D View

Type:boolean, default False
show_bundle_names

Show names for reconstructed tracks objects

Type:boolean, default False
show_camera_path

Show reconstructed camera path

Type:boolean, default False
show_floor

Show the ground plane grid in perspective view

Type:boolean, default False
show_grease_pencil

Show grease pencil for this view

Type:boolean, default False
show_manipulator

Use a 3D manipulator widget for controlling transforms

Type:boolean, default False
show_occlude_wire

Use hidden wireframe display

Type:boolean, default False
show_only_render

Display only objects which will be rendered

Type:boolean, default False
show_outline_selected

Show an outline highlight around selected objects in non-wireframe views

Type:boolean, default False
show_reconstruction

Display reconstruction data from active movie clip

Type:boolean, default False
show_relationship_lines

Show dashed lines indicating parent or constraint relationships

Type:boolean, default False
show_stereo_3d_cameras

Show the left and right cameras

Type:boolean, default False
show_stereo_3d_convergence_plane

Show the stereo 3d convergence plane

Type:boolean, default False
show_stereo_3d_volume

Show the stereo 3d frustum volume

Type:boolean, default False
show_textured_shadeless

Show shadeless texture without lighting in textured draw mode

Type:boolean, default False
show_textured_solid

Display face-assigned textures in solid view

Type:boolean, default False
show_world

Display world colors in the background

Type:boolean, default False
stereo_3d_camera
Type:enum in [‘LEFT’, ‘RIGHT’, ‘S3D’], default ‘LEFT’
stereo_3d_convergence_plane_alpha

Opacity (alpha) of the convergence plane

Type:float in [0, 1], default 0.0
stereo_3d_eye

Current stereo eye being drawn

Type:enum in [‘LEFT_EYE’, ‘RIGHT_EYE’], default ‘LEFT_EYE’, (readonly)
stereo_3d_volume_alpha

Opacity (alpha) of the cameras’ frustum volume

Type:float in [0, 1], default 0.0
tracks_draw_size

Display size of tracks from reconstructed data

Type:float in [0, inf], default 0.0
tracks_draw_type

Viewport display style for tracks

Type:enum in [‘PLAIN_AXES’, ‘ARROWS’, ‘SINGLE_ARROW’, ‘CIRCLE’, ‘CUBE’, ‘SPHERE’, ‘CONE’], default ‘PLAIN_AXES’
transform_manipulators

Transformation manipulators

  • TRANSLATE Translate, Use the manipulator for movement transformations.
  • ROTATE Rotate, Use the manipulator for rotation transformations.
  • SCALE Scale, Use the manipulator for scale transformations.
Type:enum set in {‘TRANSLATE’, ‘ROTATE’, ‘SCALE’}, default {‘TRANSLATE’}
transform_orientation

Transformation orientation

  • GLOBAL Global, Align the transformation axes to world space.
  • LOCAL Local, Align the transformation axes to the selected objects’ local space.
  • NORMAL Normal, Align the transformation axes to average normal of selected elements (bone Y axis for pose mode).
  • GIMBAL Gimbal, Align each axis to the Euler rotation axis as used for input.
  • VIEW View, Align the transformation axes to the window.
Type:enum in [‘GLOBAL’, ‘LOCAL’, ‘NORMAL’, ‘GIMBAL’, ‘VIEW’], default ‘GLOBAL’
use_matcap

Active Objects draw images mapped on normals, enhancing Solid Draw Mode

Type:boolean, default False
use_occlude_geometry

Limit selection to visible (clipped with depth buffer)

Type:boolean, default False
use_pivot_point_align

Manipulate center points (object, pose and weight paint mode only)

Type:boolean, default False
use_render_border

Use a region within the frame size for rendered viewport (when not viewing through the camera)

Type:boolean, default False
viewport_shade

Method to display/shade objects in the 3D View

  • BOUNDBOX Bounding Box, Display the object’s local bounding boxes only.
  • WIREFRAME Wireframe, Display the object as wire edges.
  • SOLID Solid, Display the object solid, lit with default OpenGL lights.
  • TEXTURED Texture, Display the object solid, with a texture.
  • MATERIAL Material, Display objects solid, with GLSL material.
  • RENDERED Rendered, Display render preview.
Type:enum in [‘BOUNDBOX’, ‘WIREFRAME’, ‘SOLID’, ‘TEXTURED’, ‘MATERIAL’, ‘RENDERED’], default ‘BOUNDBOX’
draw_handler_add()

Undocumented

draw_handler_remove()

Undocumented

Inherited Properties

Inherited Functions

References