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

RenderfarmCommitUntracked

Add untracked files into svn and commit all of them

Type :boolean, default False

RenderfarmQuality

Quality of render

Type :enum in [‘FILE_SETTINGS’, ‘FINAL_4K’, ‘FINAL_2K’, ‘FINAL_1K’, ‘FINAL_0.5K’, ‘FINAL_HD’, ‘PREVIEW_1K’, ‘NOSHADING_1K’, ‘SIMPLIFIED_1K’], default ‘FILE_SETTINGS’

RenderfarmRevision

Svn revision number to be used for rendering

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

RenderfarmUseCurrentRevision

Always detect current revision number when sending file to renderfarm

Type :boolean, default True

active_clip

Active movie clip used for constraints and viewport drawing

Type :MovieClip

active_layer

Active scene layer index

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

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)

cycles

Cycles render settings

Type :CyclesRenderSettings, (readonly)

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

Visible layers - Shift-Click to select multiple layers

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)

mango_response_curve

Measured camera film response

Type :enum in [‘Agfacolor Futura 100’, ‘Agfacolor Futura 200’, ‘Agfacolor Futura 400’, ‘Agfacolor Futura II 100’, ‘Agfacolor Futura II 200’, ‘Agfacolor Futura II 400’, ‘Agfacolor HDC 100 plus’, ‘Agfacolor HDC 400 plus’, ‘Agfacolor HDC 200 plus’, ‘Agfacolor Optima II 100’, ‘Agfacolor Optima II 200’, ‘Agfacolor Ultra 050’, ‘Agfacolor Vista 100’, ‘Agfacolor Vista 200’, ‘Agfacolor Vista 400’, ‘Agfacolor Vista 800’, ‘Agfachrome CT Precisa 100’, ‘Agfachrome CT Precisa 200’, ‘Agfachrome RSX2 050’, ‘Agfachrome RSX2 100’, ‘Agfachrome RSX2 200’, ‘Advantix 100’, ‘Advantix 200’, ‘Advantix 400’, ‘Gold 100’, ‘Gold 200’, ‘Max Zoom 800’, ‘Portra 100T’, ‘Portra 160NC’, ‘Portra 160VC’, ‘Portra 800’, ‘Portra 400VC’, ‘Portra 400NC’, ‘Ektachrome 100 plus’, ‘Ektachrome 320T’, ‘Ektachrome 400X’, ‘Ektachrome 64’, ‘Ektachrome 64T’, ‘Ektachrome E100S’, ‘Ektachrome 100’, ‘Kodachrome 200’, ‘Kodachrome 25’, ‘Kodachrome 64’, ‘F-125’, ‘F-250’, ‘F-400’, ‘FCI’, ‘FP2900Z’, ‘Double X Neg 12min’, ‘Double X Neg 6min’, ‘Double X Neg 5min’, ‘Double X Neg 4min’, ‘Optura 981111’, ‘Optura 981113’, ‘Optura 981114’, ‘Optura 981111.SLRR’], default ‘Advantix 400’

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 “”, (never None)

world

World used for rendering the scene

Type :World

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

statistics()

statistics

Returns:Statistics Return type:string, (never None)

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

Inherited Properties

bpy_struct.id_data ID.name ID.use_fake_user ID.is_library_indirect ID.is_updated

ID.is_updated_data ID.library ID.tag ID.users

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden 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.type_recast bpy_struct.values ID.copy ID.user_clear ID.animation_data_create ID.animation_data_clear ID.update_tag

References

BlendData.scenes BlendDataScenes.new BlendDataScenes.remove Camera.view_frame CompositorNodeRLayers.scene Context.scene EnvironmentMap.save Image.save_render Object.dupli_list_create Object.is_deform_modified

Object.is_modified Object.is_visible Object.to_mesh RenderEngine.render RenderEngine.update Scene.background_set SceneActuator.scene SceneSequence.scene Screen.scene Sequences.new_scene