Home       Trees       Indices       Help   
ESyS-Particle 2.3.2
Package esys :: Package lsm :: Package vis :: Package vtk :: Module scene :: Class Scene
[hide private]
[frames] | no frames]

Class Scene

      object --+    
               |    
core.scene.Scene --+
                   |
                  Scene
Instance Methods [hide private]
 
__init__(self, renderDefaults=None)
Constructs a scene object.
 
getRenderer(self)
 
setBackground(self, color)
Sets the background color of the scene.
 
clear(self)
Removes all objects from the scene, does not alter camera.
Camera
getCamera(self)
Returns a Camera object for this scene.
 
render(self, offScreen=None, interactive=None, fileName=None, imageFormat=None, size=None)
Renders an image of the scene.

Inherited from core.scene.Scene: add, getRenderDefaults, initialise

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, renderDefaults=None)
(Constructor)

 

Constructs a scene object.

Overrides: object.__init__
(inherited documentation)

setBackground(self, color)

 

Sets the background color of the scene.

Parameters:
  • color - Backgroung RGB color.
Overrides: core.scene.Scene.setBackground
(inherited documentation)

clear(self)

 

Removes all objects from the scene, does not alter camera.

Overrides: core.scene.Scene.clear
(inherited documentation)

getCamera(self)

 

Returns a Camera object for this scene.

Returns: Camera
The Camera associated with this scene.
Overrides: core.scene.Scene.getCamera
(inherited documentation)

render(self, offScreen=None, interactive=None, fileName=None, imageFormat=None, size=None)

 

Renders an image of the scene.

Parameters:
  • offScreen - If False the image is displayed on-screen in a visible window else the rendered image is not displayed.
  • interactive - If True and offScreen==True this method will remain paused until a **quit** is received in the image window. If offScreen==False this option has no effect.
  • fileName - The name of the file to which the image is written. The fileName extension (eg ".png", ) is used as the image type if imageFomat is not specified.
  • imageFormat - The type of image produced: PNG, PNM.
  • size - The image width size[0] and height size[1].
Overrides: core.scene.Scene.render
(inherited documentation)

   Home       Trees       Indices       Help   
ESyS-Particle 2.3.2
Generated by Epydoc 3.0.1 http://epydoc.sourceforge.net