Module Scene

Module Scene

The Blender.Scene submodule.

New:

Scene.clearScriptLinks accepts a parameter now.
acess methods Scene.getLayers, Scene.setLayers via lists to complement the layers and Layers Scene attributes which use bitmasks.

Scene

This module provides access to Scenes in Blender.

Example:

       import Blender
       from Blender import Scene, Object, Camera
       #
       camdata = Camera.New('persp')           # create new camera data
       camdata.name = 'newCam'
       camdata.lens = 16.0
       scene = Scene.New('NewScene')           # create a new scene
       scene.objects.new(camdata,'Camera')     # add a new object to the scene with newly-created data
       scene.makeCurrent()                     # make this the current scene

Warning:

scene.objects.new is the preferred way to add new objects to a scene. The older way is to create an object with Object.New(), link the data to the new object, then link the object to the scene. This way is not recommended since a forgotten step or run-time error in the script can cause bad things to be done to Blender's database.

If you use this older method, it's recommended to always perform the operations in this order. This is because if there is no object data linked to an object ob, scene.link(ob) will automatically create the missing data. This is OK on its own, but if after that object ob is linked to obdata, the automatically created one will be discarded -- as expected -- but will stay in Blender's memory space until the program is exited, since Blender doesn't really get rid of most kinds of data. So first linking ObData to object, then object to scene is a tiny tiny bit faster than the other way around and also saves some realtime memory (if many objects are created from scripts, the savings become important).

Classes
`Scene`	This object gives access to Scene data in Blender.
`SceneObjects`	This object gives access to the Objects in a Scene in Blender.

Function Summary
Blender Scene or a list of Blender Scenes	`Get(name)` Get the Scene(s) from Blender.
Blender Scene	`GetCurrent()` Get the currently active Scene in Blender.
Blender Scene	`New(name)` Create a new Scene in Blender.
	`Unlink(scene)` Unlink (delete) a Scene from Blender.

Function Details

Get(name=None)

Get the Scene(s) from Blender.

Parameters:: name - The name of a Scene.
(type=string)

Returns:

It depends on the name parameter:

(name): The Scene with the given name;
(): A list with all Scenes currently in Blender.

(type=Blender Scene or a list of Blender Scenes)

GetCurrent()

Get the currently active Scene in Blender.

Returns:: The currently active Scene.
(type=Blender Scene)

New(name='Scene')

Create a new Scene in Blender.

Parameters:: name - The Scene name.
(type=string)

Returns:: The created Scene.
(type=Blender Scene)

Unlink(scene)

Unlink (delete) a Scene from Blender.

Parameters:: scene - The Scene to be unlinked.
(type=Blender Scene)

Generated by Epydoc 2.1 on Thu May 10 20:31:59 2007

http://epydoc.sf.net