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 Member Functions

virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkSynchronizedRenderWindowsNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetRenderEventPropagation (bool)
 
virtual bool GetRenderEventPropagation ()
 
virtual void RenderEventPropagationOn ()
 
virtual void RenderEventPropagationOff ()
 
virtual void AbortRender ()
 This method call be called while a render is in progress to abort the rendering. More...
 
void SetRenderWindow (vtkRenderWindow *)
 Set the render window to be synchronized by this vtkSynchronizedRenderWindows instance. More...
 
virtual vtkRenderWindowGetRenderWindow ()
 Set the render window to be synchronized by this vtkSynchronizedRenderWindows instance. More...
 
void SetParallelController (vtkMultiProcessController *)
 Set the parallel message communicator. More...
 
virtual vtkMultiProcessControllerGetParallelController ()
 Set the parallel message communicator. More...
 
void SetIdentifier (unsigned int id)
 It's acceptable to have multiple instances on vtkSynchronizedRenderWindows on each processes to synchronize different render windows. More...
 
virtual unsigned int GetIdentifier ()
 It's acceptable to have multiple instances on vtkSynchronizedRenderWindows on each processes to synchronize different render windows. More...
 
virtual void SetParallelRendering (bool)
 Enable/Disable parallel rendering. More...
 
virtual bool GetParallelRendering ()
 Enable/Disable parallel rendering. More...
 
virtual void ParallelRenderingOn ()
 Enable/Disable parallel rendering. More...
 
virtual void ParallelRenderingOff ()
 Enable/Disable parallel rendering. More...
 
virtual void SetRootProcessId (int)
 Get/Set the root-process id. More...
 
virtual int GetRootProcessId ()
 Get/Set the root-process id. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkSynchronizedRenderWindowsNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSynchronizedRenderWindowsSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkSynchronizedRenderWindows ()
 
 ~vtkSynchronizedRenderWindows () override
 
virtual void HandleStartRender ()
 
virtual void HandleEndRender ()
 
virtual void HandleAbortRender ()
 
virtual void MasterStartRender ()
 
virtual void SlaveStartRender ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- 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 38 of file vtkSynchronizedRenderWindows.h.

Member Typedef Documentation

Definition at line 42 of file vtkSynchronizedRenderWindows.h.

Member Enumeration Documentation

anonymous enum
Enumerator
SYNC_RENDER_TAG 

Definition at line 114 of file vtkSynchronizedRenderWindows.h.

Constructor & Destructor Documentation

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

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 vtkObjectBase.

static vtkSynchronizedRenderWindows* vtkSynchronizedRenderWindows::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkSynchronizedRenderWindows::NewInstanceInternal ( ) const
protectedvirtual
vtkSynchronizedRenderWindows* vtkSynchronizedRenderWindows::NewInstance ( ) const
void vtkSynchronizedRenderWindows::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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

virtual void vtkSynchronizedRenderWindows::HandleAbortRender ( )
inlineprotectedvirtual

Definition at line 140 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 159 of file vtkSynchronizedRenderWindows.h.

Member Data Documentation

unsigned int vtkSynchronizedRenderWindows::Identifier
protected

Definition at line 145 of file vtkSynchronizedRenderWindows.h.

bool vtkSynchronizedRenderWindows::ParallelRendering
protected

Definition at line 146 of file vtkSynchronizedRenderWindows.h.

bool vtkSynchronizedRenderWindows::RenderEventPropagation
protected

Definition at line 147 of file vtkSynchronizedRenderWindows.h.

int vtkSynchronizedRenderWindows::RootProcessId
protected

Definition at line 148 of file vtkSynchronizedRenderWindows.h.

vtkRenderWindow* vtkSynchronizedRenderWindows::RenderWindow
protected

Definition at line 150 of file vtkSynchronizedRenderWindows.h.

vtkMultiProcessController* vtkSynchronizedRenderWindows::ParallelController
protected

Definition at line 151 of file vtkSynchronizedRenderWindows.h.


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