VTK
vtkSynchronizedRenderWindows.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkSynchronizedRenderWindows.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
24 #ifndef vtkSynchronizedRenderWindows_h
25 #define vtkSynchronizedRenderWindows_h
26 
27 #include "vtkRenderingParallelModule.h" // For export macro
28 #include "vtkObject.h"
29 
30 class vtkRenderWindow;
32 class vtkCommand;
34 
35 class VTKRENDERINGPARALLEL_EXPORT vtkSynchronizedRenderWindows : public vtkObject
36 {
37 public:
40  void PrintSelf(ostream& os, vtkIndent indent) override;
41 
43 
48  void SetRenderWindow(vtkRenderWindow*);
49  vtkGetObjectMacro(RenderWindow, vtkRenderWindow);
51 
53 
57  void SetParallelController(vtkMultiProcessController*);
58  vtkGetObjectMacro(ParallelController, vtkMultiProcessController);
60 
62 
72  void SetIdentifier(unsigned int id);
73  vtkGetMacro(Identifier, unsigned int);
75 
77 
82  vtkSetMacro(ParallelRendering, bool);
83  vtkGetMacro(ParallelRendering, bool);
84  vtkBooleanMacro(ParallelRendering, bool);
86 
87  // Turns on/off render event propagation. When on (the default) and
88  // ParallelRendering is on, process 0 will send an RMI call to all remote
89  // processes to perform a synchronized render. When off, render must be
90  // manually called on each process.
91  vtkSetMacro(RenderEventPropagation, bool);
92  vtkGetMacro(RenderEventPropagation, bool);
93  vtkBooleanMacro(RenderEventPropagation, bool);
94 
99  virtual void AbortRender();
100 
102 
107  vtkSetMacro(RootProcessId, int);
108  vtkGetMacro(RootProcessId, int);
110 
111  enum
112  {
113  SYNC_RENDER_TAG = 15001,
114  };
115 protected:
117  ~vtkSynchronizedRenderWindows() override;
118 
120  {
121  int WindowSize[2];
122  int TileScale[2];
123  double TileViewport[4];
125 
126  // Save/restore the struct to/from a stream.
127  void Save(vtkMultiProcessStream& stream);
128  bool Restore(vtkMultiProcessStream& stream);
129  void CopyFrom(vtkRenderWindow*);
130  void CopyTo(vtkRenderWindow*);
131  };
132 
133  // These methods are called on all processes as a consequence of corresponding
134  // events being called on the render window.
135  virtual void HandleStartRender();
136  virtual void HandleEndRender() {}
137  virtual void HandleAbortRender() {}
138 
139  virtual void MasterStartRender();
140  virtual void SlaveStartRender();
141 
142  unsigned int Identifier;
146 
149 
150 private:
152  void operator=(const vtkSynchronizedRenderWindows&) = delete;
153 
154  class vtkObserver;
155  vtkObserver* Observer;
156  friend class vtkObserver;
157 
158 };
159 
160 #endif
161 
162 
abstract base class for most VTK objects
Definition: vtkObject.h:53
synchronizes render windows across processes.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
stream used to pass data across processes using vtkMultiProcessController.
superclass for callback/observer methods
Definition: vtkCommand.h:370
a simple class to control print indentation
Definition: vtkIndent.h:33
create a window for renderers to draw into
vtkMultiProcessController * ParallelController
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Multiprocessing communication superclass.