esys.pyvisi.renderers.povray.scene.Scene

Package esys :: Package pyvisi :: Package renderers :: Package povray :: 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 colour/color setting of the Scene
	`place(self, obj)` Place an object within a scene
	`render(self, pause, interactive, save)` 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
	`write(self, fname, format)` Save the scene to a file
Inherited from Scene
	`delete(self, obj)` Delete an item from the scene
	`getSize(self)` Gets the current size of the scene
	`rendererCommand(self, command)` Allows the user to run a low-level renderer-specific command directly
	`setSize(self, xSize, ySize)` Sets the size of the scene.
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

init(self)
(Constructor)

The init function

Overrides:: esys.pyvisi.scene.Scene.__init__

add(self, obj)

Add a new item to the scene

Parameters:: obj - The object to add to the scene
(type=object)

Overrides:: esys.pyvisi.scene.Scene.add

getBackgroundColor(self)

Gets the current background colour/color setting of the Scene

Overrides:: esys.pyvisi.scene.Scene.getBackgroundColor

place(self, obj)

Place an object within a scene

Parameters:: obj - The object to place within the scene
(type=object)

Overrides:: esys.pyvisi.scene.Scene.place

render(self, pause=False, interactive=False, save=False)

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)

Overrides:: esys.pyvisi.scene.Scene.render

save(self, fname, format)

Save the scene to a file

Possible formats are:

PNG
TGA (uncompressed targa)
CTGA (compressed targa)
PPM
SYS (e.g. BMP on Windows, PICT on MacOS)

Parameters:: fname - the name of the file to save to
(type=string); format - the image format of the output file
(type=Image object or string)

Overrides:: esys.pyvisi.scene.Scene.save

setBackgroundColor(self, *color)

Sets the background color of the Scene

Parameters:: color - The color to set the background to. Can be RGB or CMYK
(type=tuple)

Overrides:: esys.pyvisi.scene.Scene.setBackgroundColor

write(self, fname, format)