Changeset 2196

Timestamp:

Jan 10, 2006, 5:10:54 PM (19 years ago)

Author:

jack

Message:

Removed redundant dictionary
Added large and relevant class docstring.

File:

• inundation/pyvolution/vtk_realtime_visualiser.py (modified) (4 diffs)

inundation/pyvolution/vtk_realtime_visualiser.py

@@ -11 +11 @@
 
     """A VTK-powered visualiser, designed to replace the VPython one.
-    Intended to be run in its own thread
+    Intended to be run in its own thread.
+
+    Customisation options for the visualiser are as follows:
+
+    setup: Dictionary mapping quantity name -> boolean.
+    if setup[q] is true, draw the quantity when the visualiser starts.
+    
+    updating: Dictionary mapping quantity name -> boolean.
+    if updating[q] is true, update the rendering of this quantity each
+    timestep.
+    
+    qcolor: Dictionary mapping quantity name -> (float, float, float)
+    if the name of a quantity is found in qcolor, the colour specified (in
+    (r, g, b) from 0.0 to 1.0) is used for display of that quantity instead of
+    (0.5, 0.5, 0.5) (the default)
+        
+    scale_z: Dictionary mapping quantity name -> float
+    Override the z scaling of this quantity with the float specified.
+
+    default_scale_z: float
+    multiply all z coordinates by this amount unless an overriding value
+    exists in scale_z.
     """
 
     def __init__(self, domain, default_scale_z=1.0, rect=None, title='Test'):
         threading.Thread.__init__(self)
-        # Initialise data structures. coloring, setup and updating are maps
+        # Initialise data structures. setup and updating are maps
         # quantity name -> boolean, setup means to render it,
         # update means to update with time.
         # qcolor maps quantity name -> (float, float, float): the colour (r, g, b)
-        # to render a quantity.
         self.setup = {}
         self.updating = {}
-        self.coloring = {}
         self.qcolor = {}
         self.scale_z = {}
@@ -30 +49 @@
         self.vertices = domain.vertex_coordinates
 
+        # Message queue
         self.messages = Queue()
 
@@ -42 +62 @@
             self.setup[x] = False
             self.updating[x] = False
-            self.qcolor[x] = (0.0, 0.0, 0.0)
-            self.coloring[x] = False
 
         # Bounding box.
@@ -158 +176 @@
             actor.SetMapper(mapper)
 
-            if self.coloring[q] is True:
+            if self.qcolor.has_key(q):
                 actor.GetProperty().SetColor(self.qcolor[q])
             else: