Scene Operators¶
-
bpy.ops.scene.
delete
()¶ Delete active scene
-
bpy.ops.scene.
freestyle_add_edge_marks_to_keying_set
()¶ Add the data paths to the Freestyle Edge Mark property of selected edges to the active keying set
-
bpy.ops.scene.
freestyle_add_face_marks_to_keying_set
()¶ Add the data paths to the Freestyle Face Mark property of selected polygons to the active keying set
-
bpy.ops.scene.
freestyle_alpha_modifier_add
(type='ALONG_STROKE')¶ Add an alpha transparency modifier to the line style associated with the active lineset
- Parameters
type (enum in ['ALONG_STROKE', 'CREASE_ANGLE', 'CURVATURE_3D', 'DISTANCE_FROM_CAMERA', 'DISTANCE_FROM_OBJECT', 'MATERIAL', 'NOISE', 'TANGENT'], (optional)) – Type
-
bpy.ops.scene.
freestyle_color_modifier_add
(type='ALONG_STROKE')¶ Add a line color modifier to the line style associated with the active lineset
- Parameters
type (enum in ['ALONG_STROKE', 'CREASE_ANGLE', 'CURVATURE_3D', 'DISTANCE_FROM_CAMERA', 'DISTANCE_FROM_OBJECT', 'MATERIAL', 'NOISE', 'TANGENT'], (optional)) – Type
-
bpy.ops.scene.
freestyle_fill_range_by_selection
(type='COLOR', name='')¶ Fill the Range Min/Max entries by the min/max distance between selected mesh objects and the source object
- Parameters
type (enum in ['COLOR', 'ALPHA', 'THICKNESS'], (optional)) –
Type, Type of the modifier to work on
COLOR
Color – Color modifier type.ALPHA
Alpha – Alpha modifier type.THICKNESS
Thickness – Thickness modifier type.
name (string, (optional, never None)) – Name, Name of the modifier to work on
- File
-
bpy.ops.scene.
freestyle_geometry_modifier_add
(type='2D_OFFSET')¶ Add a stroke geometry modifier to the line style associated with the active lineset
- Parameters
type (enum in ['2D_OFFSET', '2D_TRANSFORM', 'BACKBONE_STRETCHER', 'BEZIER_CURVE', 'BLUEPRINT', 'GUIDING_LINES', 'PERLIN_NOISE_1D', 'PERLIN_NOISE_2D', 'POLYGONIZATION', 'SAMPLING', 'SIMPLIFICATION', 'SINUS_DISPLACEMENT', 'SPATIAL_NOISE', 'TIP_REMOVER'], (optional)) – Type
-
bpy.ops.scene.
freestyle_lineset_add
()¶ Add a line set into the list of line sets
-
bpy.ops.scene.
freestyle_lineset_copy
()¶ Copy the active line set to a buffer
-
bpy.ops.scene.
freestyle_lineset_move
(direction='UP')¶ Change the position of the active line set within the list of line sets
- Parameters
direction (enum in ['UP', 'DOWN'], (optional)) – Direction, Direction to move the active line set towards
-
bpy.ops.scene.
freestyle_lineset_paste
()¶ Paste the buffer content to the active line set
-
bpy.ops.scene.
freestyle_lineset_remove
()¶ Remove the active line set from the list of line sets
-
bpy.ops.scene.
freestyle_linestyle_new
()¶ Create a new line style, reusable by multiple line sets
-
bpy.ops.scene.
freestyle_modifier_copy
()¶ Duplicate the modifier within the list of modifiers
-
bpy.ops.scene.
freestyle_modifier_move
(direction='UP')¶ Move the modifier within the list of modifiers
- Parameters
direction (enum in ['UP', 'DOWN'], (optional)) – Direction, Direction to move the chosen modifier towards
-
bpy.ops.scene.
freestyle_modifier_remove
()¶ Remove the modifier from the list of modifiers
-
bpy.ops.scene.
freestyle_module_add
()¶ Add a style module into the list of modules
-
bpy.ops.scene.
freestyle_module_move
(direction='UP')¶ Change the position of the style module within in the list of style modules
- Parameters
direction (enum in ['UP', 'DOWN'], (optional)) – Direction, Direction to move the chosen style module towards
-
bpy.ops.scene.
freestyle_module_open
(filepath='', make_internal=True)¶ Open a style module file
- Parameters
filepath (string, (optional, never None)) – filepath
make_internal (boolean, (optional)) – Make internal, Make module file internal after loading
- File
-
bpy.ops.scene.
freestyle_module_remove
()¶ Remove the style module from the stack
-
bpy.ops.scene.
freestyle_stroke_material_create
()¶ Create Freestyle stroke material for testing
-
bpy.ops.scene.
freestyle_thickness_modifier_add
(type='ALONG_STROKE')¶ Add a line thickness modifier to the line style associated with the active lineset
- Parameters
type (enum in ['ALONG_STROKE', 'CALLIGRAPHY', 'CREASE_ANGLE', 'CURVATURE_3D', 'DISTANCE_FROM_CAMERA', 'DISTANCE_FROM_OBJECT', 'MATERIAL', 'NOISE', 'TANGENT'], (optional)) – Type
-
bpy.ops.scene.
gpencil_brush_preset_add
(name='', remove_name=False, remove_active=False)¶ Add or remove grease pencil brush preset
- Parameters
name (string, (optional, never None)) – Name, Name of the preset, used to make the path name
remove_name (boolean, (optional)) – remove_name
remove_active (boolean, (optional)) – remove_active
- File
-
bpy.ops.scene.
gpencil_material_preset_add
(name='', remove_name=False, remove_active=False)¶ Add or remove grease pencil material preset
- Parameters
name (string, (optional, never None)) – Name, Name of the preset, used to make the path name
remove_name (boolean, (optional)) – remove_name
remove_active (boolean, (optional)) – remove_active
- File
-
bpy.ops.scene.
light_cache_bake
(delay=0, subset='ALL')¶ Bake the active view layer lighting
- Parameters
delay (int in [0, 2000], (optional)) – Delay, Delay in millisecond before baking starts
subset (enum in ['ALL', 'DIRTY', 'CUBEMAPS'], (optional)) –
Subset, Subset of probes to update
ALL
All Light Probes – Bake both irradiance grids and reflection cubemaps.DIRTY
Dirty Only – Only bake light probes that are marked as dirty.CUBEMAPS
Cubemaps Only – Try to only bake reflection cubemaps if irradiance grids are up to date.
-
bpy.ops.scene.
light_cache_free
()¶ Delete cached indirect lighting
-
bpy.ops.scene.
new
(type='NEW')¶ Add new scene by type
- Parameters
type (enum in ['NEW', 'EMPTY', 'LINK_COPY', 'FULL_COPY'], (optional)) –
Type
NEW
New – Add a new, empty scene with default settings.EMPTY
Copy Settings – Add a new, empty scene, and copy settings from the current scene.LINK_COPY
Linked Copy – Link in the collections from the current scene (shallow copy).FULL_COPY
Full Copy – Make a full copy of the current scene.
-
bpy.ops.scene.
render_view_add
()¶ Add a render view
-
bpy.ops.scene.
render_view_remove
()¶ Remove the selected render view
-
bpy.ops.scene.
view_layer_add
(type='NEW')¶ Add a view layer
- Parameters
type (enum in ['NEW', 'COPY', 'EMPTY'], (optional)) –
Type
NEW
New – Add a new view layer.COPY
Copy Settings – Copy settings of current view layer.EMPTY
Blank – Add a new view layer with all collections disabled.
-
bpy.ops.scene.
view_layer_add_aov
()¶ Add a Shader AOV
-
bpy.ops.scene.
view_layer_remove
()¶ Remove the selected view layer
-
bpy.ops.scene.
view_layer_remove_aov
()¶ Remove Active AOV