Module Scene :: Class Scene

Class Scene

The Scene object

This object gives access to Scene data in Blender.

Method Summary
Scene	`copy(duplicate_objects)` Make a copy of this Scene.
	`currentFrame(frame)`
	`endFrame(frame)`
	`frameSettings(start, end, current)`
string	`getName()` Get the name of this Scene.
	`getWinSize()`
	`link(object)` Link an Object to this Scene.
	`makeCurrent()` Make this Scene the currently active one in Blender.
	`setName(name)` Set the name of this Scene.
	`setWinSize(dimensions)`
	`startFrame(frame)`
	`unlink(object)` Unlink an Object from this Scene.
	`update(full)` Update this Scene in Blender.

Class Variable Summary
	`name`: The Scene name.

Method Details

copy(duplicate_objects=1)

Make a copy of this Scene.

Parameters:

duplicate_objects - Defines how the Scene children are duplicated:

0: Link Objects;
1: Link Object Data;
2: Full copy.

(type=int)

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

currentFrame(frame=None)

: Warning: Depricated: use RenderData.currentFrame

endFrame(frame=None)

: Warning: Depricated: use RenderData.endFrame()

frameSettings(start=None, end=None, current=None)

: Warning: Depricated: use RenderData.startFrame(), RenderData.endFrame, RenderData.currentFrame

getName()

Get the name of this Scene.

Returns:: string

getWinSize()

: Warning: Depricated: use RenderData.imageSizeX() and RenderData.imageSizeY()

link(object)

Link an Object to this Scene.

Parameters:: object - A Blender Object.
(type=Blender Object)

makeCurrent()

Make this Scene the currently active one in Blender.

setName(name)

Set the name of this Scene.

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

setWinSize(dimensions)

: Warning: Depricated: use RenderData.imageSizeX() and RenderData.imageSizeY

startFrame(frame=None)

: Warning: Depricated: use RenderData.startFrame()

unlink(object)

Unlink an Object from this Scene.

Parameters:: object - A Blender Object.
(type=Blender Object)

update(full=0)

Update this Scene in Blender.

Parameters:

full - A bool to control the level of updating:

0: sort the base list of objects.
1: sort and also regroup, do ipos, ikas, keys, script links, etc.

(type=int)

Warning: When in doubt, try with full = 0 first, since it is faster. The "full" update is a recent addition to this method.

Class Variable Details

name

The Scene name.

Generated by Epydoc 2.0 on Wed May 12 22:11:00 2004

http://epydoc.sf.net