vtkSynchronizedRenderWindows Class Reference

#include <vtkSynchronizedRenderWindows.h>

Inheritance diagram for vtkSynchronizedRenderWindows:

Inheritance graph
[legend]
Collaboration diagram for vtkSynchronizedRenderWindows:

Collaboration graph
[legend]

List of all members.


Detailed Description

synchronizes render windows across processess.

vtkSynchronizedRenderWindows is used to synchronize render windows across processes for parallel rendering.

Tests:
vtkSynchronizedRenderWindows (Tests)

Definition at line 36 of file vtkSynchronizedRenderWindows.h.


Public Types

enum  { SYNC_RENDER_TAG = 15001 }
typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetRenderEventPropagation (bool)
virtual bool GetRenderEventPropagation ()
virtual void RenderEventPropagationOn ()
virtual void RenderEventPropagationOff ()
virtual void AbortRender ()
void SetRenderWindow (vtkRenderWindow *)
virtual vtkRenderWindowGetRenderWindow ()
void SetParallelController (vtkMultiProcessController *)
virtual vtkMultiProcessControllerGetParallelController ()
void SetIdentifier (unsigned int id)
virtual unsigned int GetIdentifier ()
virtual void SetParallelRendering (bool)
virtual bool GetParallelRendering ()
virtual void ParallelRenderingOn ()
virtual void ParallelRenderingOff ()
virtual void SetRootProcessId (int)
virtual int GetRootProcessId ()

Static Public Member Functions

static
vtkSynchronizedRenderWindows
New ()
static int IsTypeOf (const char *type)
static
vtkSynchronizedRenderWindows
SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkSynchronizedRenderWindows ()
 ~vtkSynchronizedRenderWindows ()
virtual void HandleStartRender ()
virtual void HandleEndRender ()
virtual void HandleAbortRender ()
virtual void MasterStartRender ()
virtual void SlaveStartRender ()

Protected Attributes

unsigned int Identifier
bool ParallelRendering
bool RenderEventPropagation
int RootProcessId
vtkRenderWindowRenderWindow
vtkMultiProcessControllerParallelController

Friends

class vtkObserver

Classes

struct  RenderWindowInfo

Member Typedef Documentation

Reimplemented from vtkObject.

Definition at line 40 of file vtkSynchronizedRenderWindows.h.


Member Enumeration Documentation

anonymous enum

Enumerator:
SYNC_RENDER_TAG 

Definition at line 103 of file vtkSynchronizedRenderWindows.h.


Constructor & Destructor Documentation

vtkSynchronizedRenderWindows::vtkSynchronizedRenderWindows (  )  [protected]

vtkSynchronizedRenderWindows::~vtkSynchronizedRenderWindows (  )  [protected]


Member Function Documentation

static vtkSynchronizedRenderWindows* vtkSynchronizedRenderWindows::New (  )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkSynchronizedRenderWindows::GetClassName (  )  [virtual]

Reimplemented from vtkObject.

static int vtkSynchronizedRenderWindows::IsTypeOf ( const char *  name  )  [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

virtual int vtkSynchronizedRenderWindows::IsA ( const char *  name  )  [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

static vtkSynchronizedRenderWindows* vtkSynchronizedRenderWindows::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkObject.

void vtkSynchronizedRenderWindows::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

void vtkSynchronizedRenderWindows::SetRenderWindow ( vtkRenderWindow  ) 

Set the render window to be synchronized by this vtkSynchronizedRenderWindows instance. A vtkSynchronizedRenderWindows can be used to synchronize exactly 1 vtkRenderWindow on each process.

virtual vtkRenderWindow* vtkSynchronizedRenderWindows::GetRenderWindow (  )  [virtual]

Set the render window to be synchronized by this vtkSynchronizedRenderWindows instance. A vtkSynchronizedRenderWindows can be used to synchronize exactly 1 vtkRenderWindow on each process.

void vtkSynchronizedRenderWindows::SetParallelController ( vtkMultiProcessController  ) 

Set the parallel message communicator. This is used to communicate among processes.

virtual vtkMultiProcessController* vtkSynchronizedRenderWindows::GetParallelController (  )  [virtual]

Set the parallel message communicator. This is used to communicate among processes.

void vtkSynchronizedRenderWindows::SetIdentifier ( unsigned int  id  ) 

It's acceptable to have multiple instances on vtkSynchronizedRenderWindows on each processes to synchronize different render windows. In that case there's no way to each of the vtkSynchronizedRenderWindows instance to know how they correspond across processes. To enable that identification, a vtkSynchronizedRenderWindows can be assigned a unique id. All vtkSynchronizedRenderWindows across different processes that have the same id are "linked" together for synchronization. It's critical that the id is set before any rendering happens.

virtual unsigned int vtkSynchronizedRenderWindows::GetIdentifier (  )  [virtual]

It's acceptable to have multiple instances on vtkSynchronizedRenderWindows on each processes to synchronize different render windows. In that case there's no way to each of the vtkSynchronizedRenderWindows instance to know how they correspond across processes. To enable that identification, a vtkSynchronizedRenderWindows can be assigned a unique id. All vtkSynchronizedRenderWindows across different processes that have the same id are "linked" together for synchronization. It's critical that the id is set before any rendering happens.

virtual void vtkSynchronizedRenderWindows::SetParallelRendering ( bool   )  [virtual]

Enable/Disable parallel rendering. Unless ParallelRendering is ON, no synchronization of vtkRenderWindow::Render() calls between processes happens. ON by default.

virtual bool vtkSynchronizedRenderWindows::GetParallelRendering (  )  [virtual]

Enable/Disable parallel rendering. Unless ParallelRendering is ON, no synchronization of vtkRenderWindow::Render() calls between processes happens. ON by default.

virtual void vtkSynchronizedRenderWindows::ParallelRenderingOn (  )  [virtual]

Enable/Disable parallel rendering. Unless ParallelRendering is ON, no synchronization of vtkRenderWindow::Render() calls between processes happens. ON by default.

virtual void vtkSynchronizedRenderWindows::ParallelRenderingOff (  )  [virtual]

Enable/Disable parallel rendering. Unless ParallelRendering is ON, no synchronization of vtkRenderWindow::Render() calls between processes happens. ON by default.

virtual void vtkSynchronizedRenderWindows::SetRenderEventPropagation ( bool   )  [virtual]

virtual bool vtkSynchronizedRenderWindows::GetRenderEventPropagation (  )  [virtual]

virtual void vtkSynchronizedRenderWindows::RenderEventPropagationOn (  )  [virtual]

virtual void vtkSynchronizedRenderWindows::RenderEventPropagationOff (  )  [virtual]

virtual void vtkSynchronizedRenderWindows::AbortRender (  )  [virtual]

This method call be called while a render is in progress to abort the rendering. It should be called on the root node (or client).

virtual void vtkSynchronizedRenderWindows::SetRootProcessId ( int   )  [virtual]

Get/Set the root-process id. This is required when the ParallelController is a vtkSocketController. Set to 0 by default (which will not work when using a vtkSocketController but will work for vtkMPIController).

virtual int vtkSynchronizedRenderWindows::GetRootProcessId (  )  [virtual]

Get/Set the root-process id. This is required when the ParallelController is a vtkSocketController. Set to 0 by default (which will not work when using a vtkSocketController but will work for vtkMPIController).

virtual void vtkSynchronizedRenderWindows::HandleStartRender (  )  [protected, virtual]

virtual void vtkSynchronizedRenderWindows::HandleEndRender (  )  [inline, protected, virtual]

Definition at line 128 of file vtkSynchronizedRenderWindows.h.

virtual void vtkSynchronizedRenderWindows::HandleAbortRender (  )  [inline, protected, virtual]

Definition at line 129 of file vtkSynchronizedRenderWindows.h.

virtual void vtkSynchronizedRenderWindows::MasterStartRender (  )  [protected, virtual]

virtual void vtkSynchronizedRenderWindows::SlaveStartRender (  )  [protected, virtual]


Friends And Related Function Documentation

friend class vtkObserver [friend]

Definition at line 148 of file vtkSynchronizedRenderWindows.h.


Member Data Documentation

unsigned int vtkSynchronizedRenderWindows::Identifier [protected]

Definition at line 134 of file vtkSynchronizedRenderWindows.h.

Definition at line 135 of file vtkSynchronizedRenderWindows.h.

Definition at line 136 of file vtkSynchronizedRenderWindows.h.

Definition at line 137 of file vtkSynchronizedRenderWindows.h.

Definition at line 139 of file vtkSynchronizedRenderWindows.h.

Definition at line 140 of file vtkSynchronizedRenderWindows.h.


The documentation for this class was generated from the following file:

Generated on Wed Aug 24 12:10:25 2011 for VTK by  doxygen 1.5.6