Home       Trees       Indices       Help   
Package bpy :: Module types :: Class Scene
[hide private]
[frames] | no frames]

Class Scene

The Scene Object

Scene consisting objects and defining time and render related settings.

References

Nested Classes [hide private]
  SceneGameData
Game data for a Scene datablock.
  SceneRenderData
Rendering settings for a Scene datablock.
Instance Methods [hide private]
string
statistics()
statistics
 
set_frame(frame)
Set scene frame updating all objects immediately.
KeyingSet
add_keying_set(name, absolute, insertkey_needed, insertkey_visual)
Add a new Keying Set to Scene.
 
animation_data_clear()
Clear animation on this this ID. (Inherited from bpy.types.ID)
AnimData
animation_data_create()
Create animation data to this ID, note that not all ID types support this. (Inherited from bpy.types.ID)
ID
copy()
Create a copy of this datablock (not supported for all datablocks). (Inherited from bpy.types.ID)
Instance Variables [hide private]
KeyingSet active_keying_set
Active Keying Set used to insert/delete keyframes.
int in [-inf, inf] active_keying_set_index
Current Keying Set index.
AnimData (readonly) animation_data
Animation data for this datablock.
SceneBases Collection of ObjectBase (readonly) bases
Bases
Object camera
Active camera used for rendering the scene.
int in [-300000, 300000] current_frame
Current Frame
float array of 3 items in [-inf, inf] cursor_location
3D cursor location.
enum distance_model
Distance model for distance attenuation calculation.
float in [0, inf] doppler_factor
Pitch factor for doppler effect calculation.
int in [1, 300000] end_frame
End Frame
boolean fake_user
Saves this datablock even if it has no users (Inherited from bpy.types.ID)
int in [0, 300000] frame_step
Number of frames to skip forward while rendering/playing back each frame
SceneGameData (readonly) game_data
Game Data
float array of 3 items in [-200, 200] gravity
Constant acceleration in a given direction
GreasePencil grease_pencil
Grease Pencil datablock
Collection of KeyingSet (readonly) keying_sets
Keying Sets for this Scene.
Library (readonly) library
Library file the datablock is linked from. (Inherited from bpy.types.ID)
boolean mute_audio
Play back of audio from Sequence Editor will be muted.
string name
Unique datablock ID name. (Inherited from bpy.types.ID)
NetRenderSettings (readonly) network_render
Network Render Settings
boolean (readonly) nla_tweakmode_on
Indicates whether there is any action referenced by NLA being edited.
NodeTree (readonly) nodetree
Compositing node tree.
SceneObjects Collection of Object (readonly) objects
Objects
Collection of TransformOrientation (readonly) orientations
Transform Orientations
float in [0, 1000] pov_radio_adc_bailout
The adc_bailout for radiosity rays.
boolean pov_radio_always_sample
Only use the data from the pretrace step and not gather any new samples during the final radiosity pass..
float in [0, 1000] pov_radio_brightness
Ammount objects are brightened before being returned upwards to the rest of the system.
int in [1, 1600] pov_radio_count
number of rays that are sent out whenever a new radiosity value has to be calculated.
boolean pov_radio_display_advanced
Show advanced options.
boolean pov_radio_enable
Enable povrays radiosity calculation.
float in [0, 1000] pov_radio_error_bound
one of the two main speed/quality tuning values, lower values are more accurate.
float in [0, 1] pov_radio_gray_threshold
one of the two main speed/quality tuning values, lower values are more accurate.
float in [0, 1] pov_radio_low_error_factor
If you calculate just enough samples, but no more, you will get an image which has slightly blotchy lighting.
boolean pov_radio_media
Radiosity estimation can be affected by media.
float in [0, 1] pov_radio_minimum_reuse
Fraction of the screen width which sets the minimum radius of reuse for each sample point (At values higher than 2% expect errors).
int in [1, 20] pov_radio_nearest_count
Number of old ambient values blended together to create a new interpolated value.
boolean pov_radio_normal
Radiosity estimation can be affected by normals.
int in [1, 20] pov_radio_recursion_limit
how many recursion levels are used to calculate the diffuse inter-reflection.
int in [-inf, inf] preview_range_end_frame
Preview Range End Frame
int in [-inf, inf] preview_range_start_frame
Preview Range Start Frame
SceneRenderData (readonly) render_data
Render Data
boolean scrub_audio
Play audio from Sequence Editor while scrubbing.
SequenceEditor (readonly) sequence_editor
Sequence Editor
Scene set
Background set scene.
float in [0.01, inf] speed_of_sound
Speed of sound for doppler effect calculation.
string stamp_note
User define note for the render stamping.
int in [1, 300000] start_frame
Start Frame
boolean sync_audio
Play back and sync with audio from Sequence Editor for realtime playback.
boolean tag
Tools can use this to tag data, (initial state is undefined). (Inherited from bpy.types.ID)
Collection of TimelineMarker (readonly) timeline_markers
Markers used in all timelines for the current scene.
ToolSettings (readonly) tool_settings
Tool Settings
UnitSettings (readonly) unit_settings
Unit editing settings
boolean use_gravity
Use global gravity for all dynamics.
boolean use_nodes
Enable the compositing node tree.
boolean use_preview_range
Use Preview Range
int (readonly) in [0, 32767] users
Number of times this datablock is referenced. (Inherited from bpy.types.ID)
boolean array of 20 items visible_layers
Layers visible when rendering the scene.
World world
World used for rendering the scene.
Method Details [hide private]

statistics()

 

statistics

Returns: string

set_frame(frame)

 

Set scene frame updating all objects immediately.

Parameters:
  • frame (int)

add_keying_set(name, absolute, insertkey_needed, insertkey_visual)

 

Add a new Keying Set to Scene.

Parameters:
  • insertkey_needed (boolean)
  • insertkey_visual (boolean)
  • name (string)
  • absolute (boolean)
Returns: KeyingSet
Newly created Keying Set.

Instance Variable Details [hide private]

distance_model

Distance model for distance attenuation calculation. in...
  • NONE
  • INVERSE
  • INVERSE_CLAMPED
  • LINEAR
  • LINEAR_CLAMPED
  • EXPONENT
  • EXPONENT_CLAMPED
Type:
enum

nla_tweakmode_on

Indicates whether there is any action referenced by NLA being edited. Strictly read-only.
Type:
boolean (readonly)

pov_radio_adc_bailout

The adc_bailout for radiosity rays. Use adc_bailout = 0.01 / brightest_ambient_object for good results.
Type:
float in [0, 1000]

stamp_note

User define note for the render stamping. (maximum length of 160)
Type:
string

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Wed Dec 9 12:15:55 2009 http://epydoc.sourceforge.net