View3DOverlay(bpy_struct)¶
base class — bpy_struct
-
class
bpy.types.
View3DOverlay
(bpy_struct)¶ Settings for display of overlays in the 3D viewport
-
backwire_opacity
¶ Opacity when rendering transparent wires
- Type
float in [0, 1], default 0.0
-
display_handle
¶ Limit the display of curve handles in edit mode
- Type
enum in [‘NONE’, ‘SELECTED’, ‘ALL’], default ‘SELECTED’
-
fade_inactive_alpha
¶ Strength of the fade effect
- Type
float in [0, 1], default 0.4
-
gpencil_fade_layer
¶ Fade layer opacity for Grease Pencil layers except the active one
- Type
float in [0, 1], default 0.5
-
gpencil_fade_objects
¶ Fade factor
- Type
float in [0, 1], default 0.5
-
gpencil_grid_opacity
¶ Canvas grid opacity
- Type
float in [0.1, 1], default 0.9
-
gpencil_vertex_paint_opacity
¶ Vertex Paint mix factor
- Type
float in [0, 1], default 1.0
-
grid_lines
¶ Number of grid lines to display in perspective view
- Type
int in [0, 1024], default 16
-
grid_scale
¶ Multiplier for the 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
-
normals_length
¶ Display size for normals in the 3D view
- Type
float in [1e-05, 100000], default 0.02
-
sculpt_mode_face_sets_opacity
¶ - Type
float in [0, 1], default 1.0
-
sculpt_mode_mask_opacity
¶ - Type
float in [0, 1], default 0.75
-
show_annotation
¶ Show annotations for this view
- Type
boolean, default True
-
show_axis_x
¶ Show the X axis line
- Type
boolean, default True
-
show_axis_y
¶ Show the Y axis line
- Type
boolean, default True
-
show_axis_z
¶ Show the Z axis line
- Type
boolean, default False
-
show_bones
¶ Display bones (disable to show motion paths only)
- Type
boolean, default False
-
show_cursor
¶ Display 3D Cursor Overlay
- Type
boolean, default False
-
show_curve_normals
¶ Display 3D curve normals in editmode
- Type
boolean, default False
-
show_edge_bevel_weight
¶ Display weights created for the Bevel modifier
- Type
boolean, default True
-
show_edge_crease
¶ Display creases created for Subdivision Surface modifier
- Type
boolean, default True
-
show_edge_seams
¶ Display UV unwrapping seams
- Type
boolean, default True
-
show_edge_sharp
¶ Display sharp edges, used with the Edge Split modifier
- Type
boolean, default True
-
show_edges
¶ Highlight selected edges
- Type
boolean, default True
-
show_extra_edge_angle
¶ Display selected edge angle, using global values when set in the transform panel
- Type
boolean, default False
-
show_extra_edge_length
¶ Display selected edge lengths, using global values when set in the transform panel
- Type
boolean, default False
-
show_extra_face_angle
¶ Display the angles in the selected edges, using global values when set in the transform panel
- Type
boolean, default False
-
show_extra_face_area
¶ Display the area of selected faces, using global values when set in the transform panel
- Type
boolean, default False
-
show_extra_indices
¶ Display the index numbers of selected vertices, edges, and faces
- Type
boolean, default False
-
show_extras
¶ Object details, including empty wire, cameras and other visual guides
- Type
boolean, default False
-
show_face_center
¶ Display face center
- Type
boolean, default False
-
show_face_normals
¶ Display face normals as lines
- Type
boolean, default False
-
show_face_orientation
¶ Show the Face Orientation Overlay
- Type
boolean, default False
-
show_faces
¶ Highlight selected faces
- Type
boolean, default True
-
show_fade_inactive
¶ Fade inactive geometry using the viewport background color
- Type
boolean, default False
-
show_floor
¶ Show the ground plane grid
- Type
boolean, default True
-
show_freestyle_edge_marks
¶ Display Freestyle edge marks, used with the Freestyle renderer
- Type
boolean, default True
-
show_freestyle_face_marks
¶ Display Freestyle face marks, used with the Freestyle renderer
- Type
boolean, default True
-
show_look_dev
¶ Show HDRI preview spheres
- Type
boolean, default False
-
show_motion_paths
¶ Show the Motion Paths Overlay
- Type
boolean, default False
-
show_object_origins
¶ Show object center dots
- Type
boolean, default False
-
show_object_origins_all
¶ Show the object origin center dot for all (selected and unselected) objects
- Type
boolean, default False
-
show_occlude_wire
¶ Use hidden wireframe display
- Type
boolean, default False
-
show_onion_skins
¶ Show the Onion Skinning Overlay
- Type
boolean, default False
-
show_ortho_grid
¶ Show grid in orthographic side view
- Type
boolean, default True
-
show_outline_selected
¶ Show an outline highlight around selected objects
- Type
boolean, default True
-
show_overlays
¶ Display overlays like gizmos and outlines
- Type
boolean, default False
-
show_paint_wire
¶ Use wireframe display in painting modes
- Type
boolean, default False
-
show_relationship_lines
¶ Show dashed lines indicating parent or constraint relationships
- Type
boolean, default False
-
show_split_normals
¶ Display vertex-per-face normals as lines
- Type
boolean, default False
-
show_stats
¶ Display scene statistics overlay text
- Type
boolean, default False
-
show_statvis
¶ Display statistical information about the mesh
- Type
boolean, default False
-
show_text
¶ Display overlay text
- Type
boolean, default False
-
show_vertex_normals
¶ Display vertex normals as lines
- Type
boolean, default False
-
show_weight
¶ Display weights in editmode
- Type
boolean, default False
-
show_wireframes
¶ Show face edges wires
- Type
boolean, default False
-
show_wpaint_contours
¶ Show contour lines formed by points with the same interpolated weight
- Type
boolean, default False
-
show_xray_bone
¶ Show the bone selection overlay
- Type
boolean, default False
-
texture_paint_mode_opacity
¶ Opacity of the texture paint mode stencil mask overlay
- Type
float in [0, 1], default 1.0
-
use_gpencil_canvas_xray
¶ Show Canvas grid in front
- Type
boolean, default False
-
use_gpencil_edit_lines
¶ Show Edit Lines when editing strokes
- Type
boolean, default True
-
use_gpencil_fade_gp_objects
¶ Fade Grease Pencil Objects, except the active one
- Type
boolean, default False
-
use_gpencil_fade_layers
¶ Toggle fading of Grease Pencil layers except the active one
- Type
boolean, default False
-
use_gpencil_fade_objects
¶ Fade all viewport objects with a full color layer to improve visibility
- Type
boolean, default False
-
use_gpencil_grid
¶ Display a grid over grease pencil paper
- Type
boolean, default False
-
use_gpencil_multiedit_line_only
¶ Show Edit Lines only in multiframe
- Type
boolean, default False
-
use_gpencil_onion_skin
¶ Show ghosts of the keyframes before and after the current frame
- Type
boolean, default False
-
use_gpencil_show_directions
¶ Show stroke drawing direction with a bigger green dot (start) and smaller red dot (end) points
- Type
boolean, default False
-
use_gpencil_show_material_name
¶ Show material name assigned to each stroke
- Type
boolean, default False
-
vertex_opacity
¶ Opacity for edit vertices
- Type
float in [0, 1], default 1.0
-
vertex_paint_mode_opacity
¶ Opacity of the texture paint mode stencil mask overlay
- Type
float in [0, 1], default 1.0
-
weight_paint_mode_opacity
¶ Opacity of the weight paint mode overlay
- Type
float in [0, 1], default 1.0
-
wireframe_threshold
¶ Adjust the angle threshold for displaying edges (1.0 for all)
- Type
float in [0, 1], default 1.0
-
xray_alpha_bone
¶ Opacity to use for bone selection
- Type
float in [0, 1], default 0.5
-
classmethod
bl_rna_get_subclass
(id, default=None)¶ - Parameters
id (string) – The RNA type identifier.
- Returns
The RNA type or default when not found.
- Return type
bpy.types.Struct
subclass
-
classmethod
bl_rna_get_subclass_py
(id, default=None)¶ - Parameters
id (string) – The RNA type identifier.
- Returns
The class or default when not found.
- Return type
type
-
Inherited Properties
Inherited Functions
References