synchronizes renderers across processes. More...

#include <vtkSynchronizedRenderers.h>

Inheritance diagram for vtkSynchronizedRenderers:

Collaboration diagram for vtkSynchronizedRenderers:

Classes
struct	RendererInfo

struct	vtkRawImage
	vtkRawImage can be used to make it easier to deal with images for compositing/communicating over client-server etc. More...

Public Types
enum	{ SYNC_RENDERER_TAG = 15101, RESET_CAMERA_TAG = 15102, COMPUTE_BOUNDS_TAG = 15103 }

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

vtkSynchronizedRenderers *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	CollectiveExpandForVisiblePropBounds (double bounds[6])
	Computes visible prob bounds. More...


virtual void	SetRenderer (vtkRenderer *)
	Set the renderer to be synchronized by this instance. More...

virtual vtkRenderer *	GetRenderer ()
	Set the renderer to be synchronized by this instance. More...


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

virtual vtkMultiProcessController *	GetParallelController ()
	Set the parallel message communicator. 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	SetImageReductionFactor (int)
	Get/Set the image reduction factor. More...

virtual int	GetImageReductionFactor ()
	Get/Set the image reduction factor. More...


virtual void	SetWriteBackImages (bool)
	If on (default), the rendered images are pasted back on to the screen. More...

virtual bool	GetWriteBackImages ()
	If on (default), the rendered images are pasted back on to the screen. More...

virtual void	WriteBackImagesOn ()
	If on (default), the rendered images are pasted back on to the screen. More...

virtual void	WriteBackImagesOff ()
	If on (default), the rendered images are pasted back on to the screen. More...


virtual void	SetRootProcessId (int)
	Get/Set the root-process id. More...

virtual int	GetRootProcessId ()
	Get/Set the root-process id. More...


virtual void	SetCaptureDelegate (vtkSynchronizedRenderers *)
	When set, this->CaptureRenderedImage() does not capture image from the screen instead passes the call to the delegate. More...

virtual vtkSynchronizedRenderers *	GetCaptureDelegate ()
	When set, this->CaptureRenderedImage() does not capture image from the screen instead passes the call to the delegate. More...


virtual void	SetAutomaticEventHandling (bool)
	When multiple groups of processes are synchronized together using different controllers, one needs to specify the order in which the various synchronizers execute. More...

virtual bool	GetAutomaticEventHandling ()
	When multiple groups of processes are synchronized together using different controllers, one needs to specify the order in which the various synchronizers execute. More...

virtual void	AutomaticEventHandlingOn ()
	When multiple groups of processes are synchronized together using different controllers, one needs to specify the order in which the various synchronizers execute. More...

virtual void	AutomaticEventHandlingOff ()
	When multiple groups of processes are synchronized together using different controllers, one needs to specify the order in which the various synchronizers execute. 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 ()

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 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 vtkSynchronizedRenderers *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkSynchronizedRenderers *	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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkSynchronizedRenderers ()

	~vtkSynchronizedRenderers () override

virtual void	HandleStartRender ()

virtual void	HandleEndRender ()

virtual void	HandleAbortRender ()

virtual void	MasterStartRender ()

virtual void	SlaveStartRender ()

virtual void	MasterEndRender ()

virtual void	SlaveEndRender ()

virtual vtkRawImage &	CaptureRenderedImage ()
	Can be used in HandleEndRender(), MasterEndRender() or SlaveEndRender() calls to capture the rendered image. More...

virtual void	PushImageToScreen ()
	Can be used in HandleEndRender(), MasterEndRender() or SlaveEndRender() calls to paste back the image from either this->ReducedImage or this->FullImage info the viewport. More...

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
vtkMultiProcessController *	ParallelController

vtkOpenGLRenderer *	Renderer

vtkSynchronizedRenderers *	CaptureDelegate

vtkRawImage	ReducedImage

vtkRawImage	FullImage

bool	ParallelRendering

int	ImageReductionFactor

bool	WriteBackImages

int	RootProcessId

bool	AutomaticEventHandling

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 renderers across processes.

vtkSynchronizedRenderers is used to synchronize renderers (vtkRenderer and subclasses) across processes for parallel rendering. It's designed to be used in conjunction with vtkSynchronizedRenderWindows to synchronize the render windows among those processes. This class handles synchronization of certain render parameters among the renderers such as viewport, camera parameters. It doesn't support compositing of rendered images across processes on its own. You typically either subclass to implement a compositing algorithm or use a renderer capable of compositing eg. IceT based renderer.

Tests:: vtkSynchronizedRenderers (Tests)

Definition at line 48 of file vtkSynchronizedRenderers.h.

Member Typedef Documentation

typedef vtkObject vtkSynchronizedRenderers::Superclass

Definition at line 52 of file vtkSynchronizedRenderers.h.

Member Enumeration Documentation

anonymous enum

Enumerator
SYNC_RENDERER_TAG
RESET_CAMERA_TAG
COMPUTE_BOUNDS_TAG

Definition at line 145 of file vtkSynchronizedRenderers.h.

Constructor & Destructor Documentation

vtkSynchronizedRenderers::vtkSynchronizedRenderers ( )

protected

vtkSynchronizedRenderers::~vtkSynchronizedRenderers ( )

overrideprotected

Member Function Documentation

static vtkSynchronizedRenderers* vtkSynchronizedRenderers::New ( )

static

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

static

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

Reimplemented in vtkCompositedSynchronizedRenderers, and vtkClientServerSynchronizedRenderers.

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

static

virtual vtkObjectBase* vtkSynchronizedRenderers::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkCompositedSynchronizedRenderers, and vtkClientServerSynchronizedRenderers.

vtkSynchronizedRenderers* vtkSynchronizedRenderers::NewInstance ( ) const

void vtkSynchronizedRenderers::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.

virtual void vtkSynchronizedRenderers::SetRenderer ( vtkRenderer * )

virtual

Set the renderer to be synchronized by this instance.

A vtkSynchronizedRenderers instance can be used to synchronize exactly 1 renderer on each processes. You can create multiple instances on vtkSynchronizedRenderers to synchronize multiple renderers.

virtual vtkRenderer* vtkSynchronizedRenderers::GetRenderer ( )

virtual

Set the renderer to be synchronized by this instance.

A vtkSynchronizedRenderers instance can be used to synchronize exactly 1 renderer on each processes. You can create multiple instances on vtkSynchronizedRenderers to synchronize multiple renderers.

virtual void vtkSynchronizedRenderers::SetParallelController ( vtkMultiProcessController * )

virtual

Set the parallel message communicator.

This is used to communicate among processes.

virtual vtkMultiProcessController* vtkSynchronizedRenderers::GetParallelController ( )

virtual

Set the parallel message communicator.

This is used to communicate among processes.

virtual void vtkSynchronizedRenderers::SetParallelRendering ( bool )

virtual

Enable/Disable parallel rendering.

Unless Parallel rendering is on, the cameras won't be synchronized across processes.

virtual bool vtkSynchronizedRenderers::GetParallelRendering ( )

virtual

Enable/Disable parallel rendering.

Unless Parallel rendering is on, the cameras won't be synchronized across processes.

virtual void vtkSynchronizedRenderers::ParallelRenderingOn ( )

virtual

Enable/Disable parallel rendering.

Unless Parallel rendering is on, the cameras won't be synchronized across processes.

virtual void vtkSynchronizedRenderers::ParallelRenderingOff ( )

virtual

Enable/Disable parallel rendering.

Unless Parallel rendering is on, the cameras won't be synchronized across processes.

virtual void vtkSynchronizedRenderers::SetImageReductionFactor ( int )

virtual

Get/Set the image reduction factor.

virtual int vtkSynchronizedRenderers::GetImageReductionFactor ( )

virtual

Get/Set the image reduction factor.

virtual void vtkSynchronizedRenderers::SetWriteBackImages ( bool )

virtual

If on (default), the rendered images are pasted back on to the screen.

You should turn this flag off on processes that are not meant to be visible to the user.

virtual bool vtkSynchronizedRenderers::GetWriteBackImages ( )

virtual

If on (default), the rendered images are pasted back on to the screen.

You should turn this flag off on processes that are not meant to be visible to the user.

virtual void vtkSynchronizedRenderers::WriteBackImagesOn ( )

virtual

If on (default), the rendered images are pasted back on to the screen.

You should turn this flag off on processes that are not meant to be visible to the user.

virtual void vtkSynchronizedRenderers::WriteBackImagesOff ( )

virtual

If on (default), the rendered images are pasted back on to the screen.

You should turn this flag off on processes that are not meant to be visible to the user.

virtual void vtkSynchronizedRenderers::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 vtkSynchronizedRenderers::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).

void vtkSynchronizedRenderers::CollectiveExpandForVisiblePropBounds ( double bounds[6] )

Computes visible prob bounds.

This must be called on all processes at the same time. The collective result is made available on all processes once this method returns. Note that this method requires that bounds is initialized to some value. This expands the bounds to include the prop bounds.

virtual void vtkSynchronizedRenderers::SetCaptureDelegate ( vtkSynchronizedRenderers * )

virtual

When set, this->CaptureRenderedImage() does not capture image from the screen instead passes the call to the delegate.

virtual vtkSynchronizedRenderers* vtkSynchronizedRenderers::GetCaptureDelegate ( )

virtual

When set, this->CaptureRenderedImage() does not capture image from the screen instead passes the call to the delegate.

virtual void vtkSynchronizedRenderers::SetAutomaticEventHandling ( bool )

virtual

When multiple groups of processes are synchronized together using different controllers, one needs to specify the order in which the various synchronizers execute.

In such cases one starts with the outer most vtkSynchronizedRenderers, sets the dependent one as a CaptureDelegate on it and the turn off AutomaticEventHandling on the delegate.

virtual bool vtkSynchronizedRenderers::GetAutomaticEventHandling ( )

virtual

When multiple groups of processes are synchronized together using different controllers, one needs to specify the order in which the various synchronizers execute.

In such cases one starts with the outer most vtkSynchronizedRenderers, sets the dependent one as a CaptureDelegate on it and the turn off AutomaticEventHandling on the delegate.

virtual void vtkSynchronizedRenderers::AutomaticEventHandlingOn ( )

virtual

When multiple groups of processes are synchronized together using different controllers, one needs to specify the order in which the various synchronizers execute.

In such cases one starts with the outer most vtkSynchronizedRenderers, sets the dependent one as a CaptureDelegate on it and the turn off AutomaticEventHandling on the delegate.

virtual void vtkSynchronizedRenderers::AutomaticEventHandlingOff ( )

virtual

When multiple groups of processes are synchronized together using different controllers, one needs to specify the order in which the various synchronizers execute.

In such cases one starts with the outer most vtkSynchronizedRenderers, sets the dependent one as a CaptureDelegate on it and the turn off AutomaticEventHandling on the delegate.

virtual void vtkSynchronizedRenderers::HandleStartRender ( )

protectedvirtual

virtual void vtkSynchronizedRenderers::HandleEndRender ( )

protectedvirtual

virtual void vtkSynchronizedRenderers::HandleAbortRender ( )

inlineprotectedvirtual

Definition at line 240 of file vtkSynchronizedRenderers.h.

virtual void vtkSynchronizedRenderers::MasterStartRender ( )

protectedvirtual

virtual void vtkSynchronizedRenderers::SlaveStartRender ( )

protectedvirtual

virtual void vtkSynchronizedRenderers::MasterEndRender ( )

protectedvirtual

Reimplemented in vtkCompositedSynchronizedRenderers, and vtkClientServerSynchronizedRenderers.

virtual void vtkSynchronizedRenderers::SlaveEndRender ( )

protectedvirtual

Reimplemented in vtkCompositedSynchronizedRenderers, and vtkClientServerSynchronizedRenderers.

virtual vtkRawImage& vtkSynchronizedRenderers::CaptureRenderedImage ( )

protectedvirtual

Can be used in HandleEndRender(), MasterEndRender() or SlaveEndRender() calls to capture the rendered image.

If this->ImageReductionFactor, then the image will be capture in this->ReducedImage, otherwise it will be captured in this->FullImage (this->ReducedImage will be pointing to the same image).

virtual void vtkSynchronizedRenderers::PushImageToScreen ( )

protectedvirtual

Can be used in HandleEndRender(), MasterEndRender() or SlaveEndRender() calls to paste back the image from either this->ReducedImage or this->FullImage info the viewport.