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

animation_data

Animation data for this datablock

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, 1], default 0.0
background_set

Background set scene

Type :Scene
camera

Active camera, used for rendering the scene

Type :Object
cursor_location

3D cursor location

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

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

Type :int in [-300000, 300000], default 0
frame_end

Final frame of the playback/rendering range

Type :int in [0, 300000], default 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, 300000], default 0
frame_step

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

Type :int in [0, 300000], default 0
frame_subframe
Type :float in [-inf, inf], default 0.0, (readonly)
game_settings
Type :SceneGameData, (readonly, never None)
gravity

Constant acceleration in a given direction

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

Grease Pencil datablock

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)
layers

Layers visible when rendering the scene

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)
node_tree

Compositing node tree

Type :NodeTree, (readonly)
object_bases
Type :SceneBases bpy_prop_collection of ObjectBase, (readonly)
objects
Type :SceneObjects bpy_prop_collection of Object, (readonly)
orientations
Type :bpy_prop_collection of TransformOrientation, (readonly)
render
Type :RenderSettings, (readonly, never None)
sequence_editor
Type :SequenceEditor, (readonly)
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 ‘NONE’
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)
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_audio_sync

Play back and sync with audio clock, dropping frames if frame display is too slow

Type :boolean, default False
use_frame_drop

Play back dropping frames if frame display is too slow

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 for UI playback, rather than the scene start/end frame

Type :boolean, default False
use_stamp_note

User defined note for the render stamping

Type :string, default “”
world

World used for rendering the scene

Type :World
statistics()

statistics

Returns:Statistics
Return type:string
frame_set(frame, subframe=0.0)

Set scene frame updating all objects immediately

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

Update data tagged to be updated from previous access to data or operators

collada_export(filepath="", selected)

Export to collada file

Parameters:
  • filepath (string, (optional)) – File Path, File path to write Collada file
  • selected (boolean) – Export only selected, Export only selected elements

Inherited Properties

Inherited Functions

References

Previous topic

SPHFluidSettings(bpy_struct)

Next topic

SceneActuator(Actuator)