esys.pyvisi.renderers.vtk.scene.Scene

Package esys :: Package pyvisi :: Package renderers :: Package vtk :: Module scene :: Class Scene

[show private | hide private]

Type Scene

object --+    
         |    
     Scene --+
             |
            Scene

The main object controlling the scene.

Scene object methods and classes overriding the BaseScene class.

Method Summary
	`__init__(self)` The init function
	`add(self, obj)` Add a new item to the scene
	`getBackgroundColor(self)` Gets the current background color setting of the Scene
	`getSize(self)` Gets the current size of the scene
	`place(self, obj)` Place an object within a scene
	`render(self, pause, interactive)` Render (or re-render) the scene
	`save(self, fname, format)` Save the scene to a file
	`setBackgroundColor(self, *color)` Sets the background color of the Scene
	`setSize(self, xSize, ySize)` Sets the size of the scene.
	`write(self, fname, format)` Save the scene to a file
Inherited from Scene
	`delete(self, obj)` Delete an item from the scene
	`rendererCommand(self, command)` Allows the user to run a low-level renderer-specific command directly
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__repr__(x)` x.__repr__() <==> repr(x)
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__str__(x)` x.__str__() <==> str(x)

Method Details

The init function

Add a new item to the scene

Gets the current background color setting of the Scene

Gets the current size of the scene

This size is effectively the renderer window size. Returns a tuple of the x and y dimensions respectively, in pixel units(??).

Place an object within a scene

Render (or re-render) the scene

Render the scene, either to screen, or to a buffer waiting for a save

Parameters:: pause - Flag to wait at end of script evaluation for user input
(type=boolean); interactive - Whether or not to have interactive use of the output
(type=boolean)