Scene(ID)

base classes — bpy_struct, ID

class bpy.types.Scene(ID)

Scene data-block, consisting in objects and defining time and render related settings

active_clip

Active movie clip used for constraints and viewport drawing

Type:MovieClip

animation_data

Animation data for this data-block

Type:AnimData, (readonly)

audio_distance_model

Distance model for distance attenuation calculation

• NONE None, No distance attenuation.
• INVERSE Inverse, Inverse distance model.
• INVERSE_CLAMPED Inverse Clamped, Inverse distance model with clamping.
• LINEAR Linear, Linear distance model.
• LINEAR_CLAMPED Linear Clamped, Linear distance model with clamping.
• EXPONENT Exponent, Exponent distance model.
• EXPONENT_CLAMPED Exponent Clamped, Exponent distance model with clamping.

Type:enum in [‘NONE’, ‘INVERSE’, ‘INVERSE_CLAMPED’, ‘LINEAR’, ‘LINEAR_CLAMPED’, ‘EXPONENT’, ‘EXPONENT_CLAMPED’], default ‘NONE’

audio_doppler_factor

Pitch factor for Doppler effect calculation

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

audio_doppler_speed

Speed of sound for Doppler effect calculation

Type:float in [0.01, inf], default 0.0

audio_volume

Audio volume

Type:float in [0, 100], default 0.0

background_set

Background set scene

Type:Scene

camera

Active camera, used for rendering the scene

Type:Object

collection

Scene master collection that objects and other collections in the scene

Type:Collection, (readonly, never None)

cursor

Type:View3DCursor, (readonly, never None)

cycles

Cycles render settings

Type:CyclesRenderSettings, (readonly)

cycles_curves

Cycles hair rendering settings

Type:CyclesCurveRenderSettings, (readonly)

display

Scene display settings for 3d viewport

Type:SceneDisplay, (readonly)

display_settings

Settings of device saved image would be displayed on

Type:ColorManagedDisplaySettings, (readonly)

eevee

EEVEE settings for the scene

Type:SceneEEVEE, (readonly)

frame_current

Current Frame, to update animation data from python frame_set() instead

Type:int in [-1048574, 1048574], default 0

frame_current_final

Current frame with subframe and time remapping applied

Type:float in [-1.04857e+06, 1.04857e+06], default 0.0, (readonly)

frame_end

Final frame of the playback/rendering range

Type:int in [0, 1048574], default 250

frame_float

Type:float in [-1.04857e+06, 1.04857e+06], default 0.0

frame_preview_end

Alternative end frame for UI playback

Type:int in [-inf, inf], default 0

frame_preview_start

Alternative start frame for UI playback

Type:int in [-inf, inf], default 0

frame_start

First frame of the playback/rendering range

Type:int in [0, 1048574], default 1

frame_step

Number of frames to skip forward while rendering/playing back each frame

Type:int in [0, 1048574], default 0

frame_subframe

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

gravity

Constant acceleration in a given direction

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

grease_pencil

Grease Pencil data-block used for annotations in the 3D view

Type:GreasePencil

is_nla_tweakmode

Whether there is any action referenced by NLA being edited (strictly read-only)

Type:boolean, default False, (readonly)

keying_sets

Absolute Keying Sets for this Scene

Type:KeyingSets bpy_prop_collection of KeyingSet, (readonly)

keying_sets_all

All Keying Sets available for use (Builtins and Absolute Keying Sets for this Scene)

Type:KeyingSetsAll bpy_prop_collection of KeyingSet, (readonly)

lock_frame_selection_to_range

Don’t allow frame to be selected with mouse outside of frame range

Type:boolean, default False

node_tree

Compositing node tree

Type:NodeTree, (readonly)

objects

Type:SceneObjects bpy_prop_collection of Object, (readonly)

render

Type:RenderSettings, (readonly, never None)

rigidbody_world

Type:RigidBodyWorld, (readonly)

safe_areas

Type:DisplaySafeAreas, (readonly, never None)

sequence_editor

Type:SequenceEditor, (readonly)

sequencer_colorspace_settings

Settings of color space sequencer is working in

Type:ColorManagedSequencerColorspaceSettings, (readonly)

show_keys_from_selected_only

Consider keyframes for active Object and/or its selected bones only (in timeline and when jumping between keyframes)

Type:boolean, default False

show_subframe

Show current scene subframe and allow set it using interface tools

Type:boolean, default False

sync_mode

How to sync playback

• NONE No Sync, Do not sync, play every frame.
• FRAME_DROP Frame Dropping, Drop frames if playback is too slow.
• AUDIO_SYNC AV-sync, Sync to audio playback, dropping frames.

Type:enum in [‘NONE’, ‘FRAME_DROP’, ‘AUDIO_SYNC’], default ‘AUDIO_SYNC’

timeline_markers

Markers used in all timelines for the current scene

Type:TimelineMarkers bpy_prop_collection of TimelineMarker, (readonly)

tool_settings

Type:ToolSettings, (readonly, never None)

transform_orientation_slots

Type:bpy_prop_collection of TransformOrientationSlot, (readonly)

unit_settings

Unit editing settings

Type:UnitSettings, (readonly, never None)

use_audio

Play back of audio from Sequence Editor will be muted

Type:boolean, default False

use_audio_scrub

Play audio from Sequence Editor while scrubbing

Type:boolean, default False

use_gravity

Use global gravity for all dynamics

Type:boolean, default False

use_nodes

Enable the compositing node tree

Type:boolean, default False

use_preview_range

Use an alternative start/end frame range for animation playback and view renders

Type:boolean, default False

use_stamp_note

User defined note for the render stamping

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

view_layers

Type:ViewLayers bpy_prop_collection of ViewLayer, (readonly)

view_settings

Color management settings applied on image before saving

Type:ColorManagedViewSettings, (readonly)

world

World used for rendering the scene

Type:World

statistics(view_layer)

statistics

Parameters:view_layer (ViewLayer, (never None)) – Active layer Returns:Statistics Return type:string, (never None)

frame_set(frame, subframe=0.0)

Set scene frame updating all objects immediately

Parameters:

• frame (int in [-1048574, 1048574]) – Frame number to set
• subframe (float in [0, 1], (optional)) – Sub-frame time, between 0.0 and 1.0

uvedit_aspect(object)

Get uv aspect for current object

Parameters:object (Object, (never None)) – Object Returns:aspect Return type:float array of 2 items in [0, inf]

ray_cast(view_layer, origin, direction, distance=1.70141e+38)

Cast a ray onto in object space

Parameters:

• view_layer (ViewLayer, (never None)) – Scene Layer
• distance (float in [0, inf], (optional)) – Maximum distance

Return (result, location, normal, index, object, matrix):  

result, boolean

location, The hit location of this ray cast, float array of 3 items in [-inf, inf]

normal, The face normal at the ray cast hit location, float array of 3 items in [-inf, inf]

index, The face index, -1 when original data isn’t available, int in [-inf, inf]

object, Ray cast object, Object

matrix, Matrix, float multi-dimensional array of 4 * 4 items in [-inf, inf]

sequence_editor_create()

Ensure sequence editor is valid in this scene

Returns:New sequence editor data or NULL Return type:SequenceEditor

sequence_editor_clear()

Clear sequence editor in this scene

alembic_export(filepath, frame_start=1, frame_end=1, xform_samples=1, geom_samples=1, shutter_open=0.0, shutter_close=1.0, selected_only=False, uvs=True, normals=True, vcolors=False, apply_subdiv=True, flatten=False, visible_layers_only=False, renderable_only=False, face_sets=False, subdiv_schema=False, export_hair=True, export_particles=True, compression_type='OGAWA', packuv=False, scale=1.0, triangulate=False, quad_method='BEAUTY', ngon_method='BEAUTY')

Export to Alembic file (deprecated, use the Alembic export operator)

Parameters:

• filepath (string, (never None)) – File Path, File path to write Alembic file
• frame_start (int in [-inf, inf], (optional)) – Start, Start Frame
• frame_end (int in [-inf, inf], (optional)) – End, End Frame
• xform_samples (int in [1, 128], (optional)) – Xform samples, Transform samples per frame
• geom_samples (int in [1, 128], (optional)) – Geom samples, Geometry samples per frame
• shutter_open (float in [-1, 1], (optional)) – Shutter open
• shutter_close (float in [-1, 1], (optional)) – Shutter close
• selected_only (boolean, (optional)) – Selected only, Export only selected objects
• uvs (boolean, (optional)) – UVs, Export UVs
• normals (boolean, (optional)) – Normals, Export normals
• vcolors (boolean, (optional)) – Vertex colors, Export vertex colors
• apply_subdiv (boolean, (optional)) – Subsurfs as meshes, Export subdivision surfaces as meshes
• flatten (boolean, (optional)) – Flatten hierarchy, Flatten hierarchy
• visible_layers_only (boolean, (optional)) – Visible layers only, Export only objects in visible layers
• renderable_only (boolean, (optional)) – Renderable objects only, Export only objects marked renderable in the outliner
• face_sets (boolean, (optional)) – Facesets, Export face sets
• subdiv_schema (boolean, (optional)) – Use Alembic subdivision Schema, Use Alembic subdivision Schema
• export_hair (boolean, (optional)) – Export Hair, Exports hair particle systems as animated curves
• export_particles (boolean, (optional)) – Export Particles, Exports non-hair particle systems
• compression_type (enum in ['OGAWA', 'HDF5'], (optional)) – Compression
• packuv (boolean, (optional)) – Export with packed UV islands, Export with packed UV islands
• scale (float in [0.0001, 1000], (optional)) – Scale, Value by which to enlarge or shrink the objects with respect to the world’s origin
• triangulate (boolean, (optional)) – Triangulate, Export Polygons (Quads & NGons) as Triangles
• quad_method (enum in ['BEAUTY', 'FIXED', 'FIXED_ALTERNATE', 'SHORTEST_DIAGONAL'], (optional)) –

  Quad Method, Method for splitting the quads into triangles

  • BEAUTY Beauty , Split the quads in nice triangles, slower method.
  • FIXED Fixed, Split the quads on the first and third vertices.
  • FIXED_ALTERNATE Fixed Alternate, Split the quads on the 2nd and 4th vertices.
  • SHORTEST_DIAGONAL Shortest Diagonal, Split the quads based on the distance between the vertices.
• ngon_method (enum in ['BEAUTY', 'FIXED', 'FIXED_ALTERNATE', 'SHORTEST_DIAGONAL'], (optional)) –

  Polygon Method, Method for splitting the polygons into triangles

  • BEAUTY Beauty , Split the quads in nice triangles, slower method.
  • FIXED Fixed, Split the quads on the first and third vertices.
  • FIXED_ALTERNATE Fixed Alternate, Split the quads on the 2nd and 4th vertices.
  • SHORTEST_DIAGONAL Shortest Diagonal, Split the quads based on the distance between the vertices.

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

bpy_struct.id_data ID.name ID.name_full ID.is_evaluated ID.original ID.users

ID.use_fake_user ID.tag ID.is_library_indirect ID.library ID.override_library ID.preview

Inherited Functions

bpy_struct.as_pointer bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_overridable_library bpy_struct.is_property_readonly bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.pop

bpy_struct.property_overridable_library_set bpy_struct.property_unset bpy_struct.type_recast bpy_struct.values ID.evaluated_get ID.copy ID.override_create ID.user_clear ID.user_remap ID.make_local ID.user_of_id ID.animation_data_create ID.animation_data_clear ID.update_tag

References

bpy.context.scene BlendData.scenes BlendDataScenes.new BlendDataScenes.remove Camera.view_frame CompositorNodeDefocus.scene CompositorNodeRLayers.scene Context.scene Depsgraph.scene Depsgraph.scene_eval Image.save_render

Object.is_deform_modified Object.is_modified RenderEngine.bind_display_space_shader RenderEngine.get_preview_pixel_size RenderEngine.register_pass RenderEngine.support_display_space_shader RenderEngine.update_render_passes Scene.background_set SceneSequence.scene Sequences.new_scene Window.scene