VTK
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkSynchronizedRenderWindows Class Reference

synchronizes render windows across processess. More...

#include <vtkSynchronizedRenderWindows.h>

Inheritance diagram for vtkSynchronizedRenderWindows:
[legend]
Collaboration diagram for vtkSynchronizedRenderWindows:
[legend]

Classes

struct  RenderWindowInfo
 

Public Types

enum  { SYNC_RENDER_TAG = 15001 }
 
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkSynchronizedRenderWindowsNewInstance () const
 
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 ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static vtkSynchronizedRenderWindowsNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSynchronizedRenderWindowsSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkSynchronizedRenderWindows ()
 
 ~vtkSynchronizedRenderWindows ()
 
virtual void HandleStartRender ()
 
virtual void HandleEndRender ()
 
virtual void HandleAbortRender ()
 
virtual void MasterStartRender ()
 
virtual void SlaveStartRender ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

unsigned int Identifier
 
bool ParallelRendering
 
bool RenderEventPropagation
 
int RootProcessId
 
vtkRenderWindowRenderWindow
 
vtkMultiProcessControllerParallelController
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkObserver
 

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 37 of file vtkSynchronizedRenderWindows.h.

Member Typedef Documentation

Definition at line 41 of file vtkSynchronizedRenderWindows.h.

Member Enumeration Documentation

anonymous enum
Enumerator
SYNC_RENDER_TAG 

Definition at line 104 of file vtkSynchronizedRenderWindows.h.

Constructor & Destructor Documentation

vtkSynchronizedRenderWindows::vtkSynchronizedRenderWindows ( )
protected
vtkSynchronizedRenderWindows::~vtkSynchronizedRenderWindows ( )
protected

Member Function Documentation

static vtkSynchronizedRenderWindows* vtkSynchronizedRenderWindows::New ( )
static
static int vtkSynchronizedRenderWindows::IsTypeOf ( const char *  type)
static
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 ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkSynchronizedRenderWindows::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkObject.

vtkSynchronizedRenderWindows* vtkSynchronizedRenderWindows::NewInstance ( ) const
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 ( )
protectedvirtual
virtual void vtkSynchronizedRenderWindows::HandleEndRender ( )
inlineprotectedvirtual

Definition at line 129 of file vtkSynchronizedRenderWindows.h.

virtual void vtkSynchronizedRenderWindows::HandleAbortRender ( )
inlineprotectedvirtual

Definition at line 130 of file vtkSynchronizedRenderWindows.h.

virtual void vtkSynchronizedRenderWindows::MasterStartRender ( )
protectedvirtual
virtual void vtkSynchronizedRenderWindows::SlaveStartRender ( )
protectedvirtual

Friends And Related Function Documentation

friend class vtkObserver
friend

Definition at line 149 of file vtkSynchronizedRenderWindows.h.

Member Data Documentation

unsigned int vtkSynchronizedRenderWindows::Identifier
protected

Definition at line 135 of file vtkSynchronizedRenderWindows.h.

bool vtkSynchronizedRenderWindows::ParallelRendering
protected

Definition at line 136 of file vtkSynchronizedRenderWindows.h.

bool vtkSynchronizedRenderWindows::RenderEventPropagation
protected

Definition at line 137 of file vtkSynchronizedRenderWindows.h.

int vtkSynchronizedRenderWindows::RootProcessId
protected

Definition at line 138 of file vtkSynchronizedRenderWindows.h.

vtkRenderWindow* vtkSynchronizedRenderWindows::RenderWindow
protected

Definition at line 140 of file vtkSynchronizedRenderWindows.h.

vtkMultiProcessController* vtkSynchronizedRenderWindows::ParallelController
protected

Definition at line 141 of file vtkSynchronizedRenderWindows.h.


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