synchronizes render windows across processes. More...

#include <vtkSynchronizedRenderWindows.h>

Inheritance diagram for vtkSynchronizedRenderWindows:

Collaboration diagram for vtkSynchronizedRenderWindows:

Classes
struct	RenderWindowInfo

Public Types
enum	{ SYNC_RENDER_TAG = 15001 }

typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkSynchronizedRenderWindows *	NewInstance () 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 vtkRenderWindow *	GetRenderWindow ()
	Set the render window to be synchronized by this vtkSynchronizedRenderWindows instance. More...


void	SetParallelController (vtkMultiProcessController *)
	Set the parallel message communicator. More...

virtual vtkMultiProcessController *	GetParallelController ()
	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	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

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

vtkCommand *	GetCommand (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...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	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 vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. 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 vtkSynchronizedRenderWindows *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkSynchronizedRenderWindows *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () 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	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
unsigned int	Identifier

bool	ParallelRendering

bool	RenderEventPropagation

int	RootProcessId

vtkRenderWindow *	RenderWindow

vtkMultiProcessController *	ParallelController

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkObserver

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

synchronizes render windows across processes.

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

Definition at line 35 of file vtkSynchronizedRenderWindows.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkSynchronizedRenderWindows::Superclass

Definition at line 39 of file vtkSynchronizedRenderWindows.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
SYNC_RENDER_TAG

Definition at line 111 of file vtkSynchronizedRenderWindows.h.

Constructor & Destructor Documentation

◆ vtkSynchronizedRenderWindows()

vtkSynchronizedRenderWindows::vtkSynchronizedRenderWindows ( )

protected

◆ ~vtkSynchronizedRenderWindows()

vtkSynchronizedRenderWindows::~vtkSynchronizedRenderWindows ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSynchronizedRenderWindows * vtkSynchronizedRenderWindows::New ( )

static

◆ IsTypeOf()

static vtkTypeBool vtkSynchronizedRenderWindows::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

static vtkSynchronizedRenderWindows * vtkSynchronizedRenderWindows::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkSynchronizedRenderWindows::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkSynchronizedRenderWindows * vtkSynchronizedRenderWindows::NewInstance ( ) const

◆ PrintSelf()

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.

◆ SetRenderWindow()

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.

◆ GetRenderWindow()

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.

◆ SetParallelController()

void vtkSynchronizedRenderWindows::SetParallelController ( vtkMultiProcessController * )

Set the parallel message communicator.

This is used to communicate among processes.

◆ GetParallelController()

virtual vtkMultiProcessController * vtkSynchronizedRenderWindows::GetParallelController ( )

virtual

Set the parallel message communicator.

This is used to communicate among processes.

◆ SetIdentifier()

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.

◆ GetIdentifier()

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.

◆ SetParallelRendering()

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.

◆ GetParallelRendering()

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.

◆ ParallelRenderingOn()

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.

◆ ParallelRenderingOff()

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.

◆ SetRenderEventPropagation()

virtual void vtkSynchronizedRenderWindows::SetRenderEventPropagation ( bool )

virtual

◆ GetRenderEventPropagation()

virtual bool vtkSynchronizedRenderWindows::GetRenderEventPropagation ( )

virtual

◆ RenderEventPropagationOn()

virtual void vtkSynchronizedRenderWindows::RenderEventPropagationOn ( )

virtual

◆ RenderEventPropagationOff()

virtual void vtkSynchronizedRenderWindows::RenderEventPropagationOff ( )

virtual

◆ AbortRender()

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

◆ SetRootProcessId()

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

◆ GetRootProcessId()

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

◆ HandleStartRender()

virtual void vtkSynchronizedRenderWindows::HandleStartRender ( )

protectedvirtual

◆ HandleEndRender()

virtual void vtkSynchronizedRenderWindows::HandleEndRender ( )

inlineprotectedvirtual

Definition at line 137 of file vtkSynchronizedRenderWindows.h.

◆ HandleAbortRender()

virtual void vtkSynchronizedRenderWindows::HandleAbortRender ( )

inlineprotectedvirtual

Definition at line 138 of file vtkSynchronizedRenderWindows.h.

◆ MasterStartRender()

virtual void vtkSynchronizedRenderWindows::MasterStartRender ( )

protectedvirtual

◆ SlaveStartRender()

virtual void vtkSynchronizedRenderWindows::SlaveStartRender ( )

protectedvirtual

Friends And Related Function Documentation

◆ vtkObserver

friend class vtkObserver

friend

Definition at line 157 of file vtkSynchronizedRenderWindows.h.

Member Data Documentation

◆ Identifier

unsigned int vtkSynchronizedRenderWindows::Identifier

protected

Definition at line 143 of file vtkSynchronizedRenderWindows.h.

◆ ParallelRendering

bool vtkSynchronizedRenderWindows::ParallelRendering

protected

Definition at line 144 of file vtkSynchronizedRenderWindows.h.

◆ RenderEventPropagation

bool vtkSynchronizedRenderWindows::RenderEventPropagation

protected

Definition at line 145 of file vtkSynchronizedRenderWindows.h.

◆ RootProcessId

int vtkSynchronizedRenderWindows::RootProcessId

protected

Definition at line 146 of file vtkSynchronizedRenderWindows.h.

◆ RenderWindow

vtkRenderWindow* vtkSynchronizedRenderWindows::RenderWindow

protected

Definition at line 148 of file vtkSynchronizedRenderWindows.h.

◆ ParallelController

vtkMultiProcessController* vtkSynchronizedRenderWindows::ParallelController

protected

Definition at line 149 of file vtkSynchronizedRenderWindows.h.

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

Rendering/Parallel/vtkSynchronizedRenderWindows.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkSynchronizedRenderWindows()

◆ ~vtkSynchronizedRenderWindows()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetRenderWindow()

◆ GetRenderWindow()

◆ SetParallelController()

◆ GetParallelController()

◆ SetIdentifier()

◆ GetIdentifier()

◆ SetParallelRendering()

◆ GetParallelRendering()

◆ ParallelRenderingOn()

◆ ParallelRenderingOff()

◆ SetRenderEventPropagation()

◆ GetRenderEventPropagation()

◆ RenderEventPropagationOn()

◆ RenderEventPropagationOff()

◆ AbortRender()

◆ SetRootProcessId()

◆ GetRootProcessId()

◆ HandleStartRender()

◆ HandleEndRender()

◆ HandleAbortRender()

◆ MasterStartRender()

◆ SlaveStartRender()

Friends And Related Function Documentation

◆ vtkObserver

Member Data Documentation

◆ Identifier

◆ ParallelRendering

◆ RenderEventPropagation

◆ RootProcessId

◆ RenderWindow

◆ ParallelController