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

synchronizes renderers across processes. More...

#include <vtkSynchronizedRenderers.h>

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

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...
 
vtkSynchronizedRenderersNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetRenderer (vtkRenderer *)
 Set the renderer to be synchronized by this instance. More...
 
virtual vtkRendererGetRenderer ()
 
virtual void SetParallelController (vtkMultiProcessController *)
 Set the parallel message communicator. More...
 
virtual vtkMultiProcessControllerGetParallelController ()
 
virtual void SetParallelRendering (bool)
 Enable/Disable parallel rendering. More...
 
virtual bool GetParallelRendering ()
 
virtual void ParallelRenderingOn ()
 
virtual void ParallelRenderingOff ()
 
virtual void SetImageReductionFactor (int)
 Get/Set the image reduction factor. More...
 
virtual int GetImageReductionFactor ()
 
virtual void SetWriteBackImages (bool)
 If on (default), the rendered images are pasted back on to the screen. More...
 
virtual bool GetWriteBackImages ()
 
virtual void WriteBackImagesOn ()
 
virtual void WriteBackImagesOff ()
 
virtual void SetRootProcessId (int)
 Get/Set the root-process id. More...
 
virtual int GetRootProcessId ()
 
void CollectiveExpandForVisiblePropBounds (double bounds[6])
 Computes visible prob bounds. 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 vtkSynchronizedRenderersGetCaptureDelegate ()
 
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 ()
 
virtual void AutomaticEventHandlingOn ()
 
virtual void AutomaticEventHandlingOff ()
 
virtual void SetFixBackground (bool)
 When doing rendering between multiple processes, it is often easier to have all ranks do the rendering on a black background. More...
 
virtual bool GetFixBackground ()
 
virtual void FixBackgroundOn ()
 
virtual void FixBackgroundOff ()
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkSynchronizedRenderersNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkSynchronizedRenderersSafeDownCast (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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () 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 vtkRawImageCaptureRenderedImage ()
 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 this->Image to 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkMultiProcessControllerParallelController
 
vtkOpenGLRendererRenderer
 
vtkSynchronizedRenderersCaptureDelegate
 
vtkRawImage Image
 
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
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 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.

Definition at line 45 of file vtkSynchronizedRenderers.h.

Member Typedef Documentation

◆ Superclass

Definition at line 49 of file vtkSynchronizedRenderers.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SYNC_RENDERER_TAG 
RESET_CAMERA_TAG 
COMPUTE_BOUNDS_TAG 

Definition at line 159 of file vtkSynchronizedRenderers.h.

Constructor & Destructor Documentation

◆ vtkSynchronizedRenderers()

vtkSynchronizedRenderers::vtkSynchronizedRenderers ( )
protected

◆ ~vtkSynchronizedRenderers()

vtkSynchronizedRenderers::~vtkSynchronizedRenderers ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSynchronizedRenderers* vtkSynchronizedRenderers::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkSynchronizedRenderers::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkSynchronizedRenderers* vtkSynchronizedRenderers::NewInstance ( ) const

◆ PrintSelf()

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.

◆ SetRenderer()

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.

◆ GetRenderer()

virtual vtkRenderer* vtkSynchronizedRenderers::GetRenderer ( )
virtual

◆ SetParallelController()

virtual void vtkSynchronizedRenderers::SetParallelController ( vtkMultiProcessController )
virtual

Set the parallel message communicator.

This is used to communicate among processes.

◆ GetParallelController()

virtual vtkMultiProcessController* vtkSynchronizedRenderers::GetParallelController ( )
virtual

◆ SetParallelRendering()

virtual void vtkSynchronizedRenderers::SetParallelRendering ( bool  )
virtual

Enable/Disable parallel rendering.

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

◆ GetParallelRendering()

virtual bool vtkSynchronizedRenderers::GetParallelRendering ( )
virtual

◆ ParallelRenderingOn()

virtual void vtkSynchronizedRenderers::ParallelRenderingOn ( )
virtual

◆ ParallelRenderingOff()

virtual void vtkSynchronizedRenderers::ParallelRenderingOff ( )
virtual

◆ SetImageReductionFactor()

virtual void vtkSynchronizedRenderers::SetImageReductionFactor ( int  )
virtual

Get/Set the image reduction factor.

◆ GetImageReductionFactor()

virtual int vtkSynchronizedRenderers::GetImageReductionFactor ( )
virtual

◆ SetWriteBackImages()

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.

◆ GetWriteBackImages()

virtual bool vtkSynchronizedRenderers::GetWriteBackImages ( )
virtual

◆ WriteBackImagesOn()

virtual void vtkSynchronizedRenderers::WriteBackImagesOn ( )
virtual

◆ WriteBackImagesOff()

virtual void vtkSynchronizedRenderers::WriteBackImagesOff ( )
virtual

◆ SetRootProcessId()

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

◆ GetRootProcessId()

virtual int vtkSynchronizedRenderers::GetRootProcessId ( )
virtual

◆ CollectiveExpandForVisiblePropBounds()

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.

◆ SetCaptureDelegate()

virtual void vtkSynchronizedRenderers::SetCaptureDelegate ( vtkSynchronizedRenderers )
virtual

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

◆ GetCaptureDelegate()

virtual vtkSynchronizedRenderers* vtkSynchronizedRenderers::GetCaptureDelegate ( )
virtual

◆ SetAutomaticEventHandling()

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.

◆ GetAutomaticEventHandling()

virtual bool vtkSynchronizedRenderers::GetAutomaticEventHandling ( )
virtual

◆ AutomaticEventHandlingOn()

virtual void vtkSynchronizedRenderers::AutomaticEventHandlingOn ( )
virtual

◆ AutomaticEventHandlingOff()

virtual void vtkSynchronizedRenderers::AutomaticEventHandlingOff ( )
virtual

◆ SetFixBackground()

virtual void vtkSynchronizedRenderers::SetFixBackground ( bool  )
virtual

When doing rendering between multiple processes, it is often easier to have all ranks do the rendering on a black background.

This helps avoid issues where the background gets over blended as the images are composted together. If set to true (default is false), before the rendering begins, vtkSynchronizedRenderers will change the renderer's background color and other flags to make it render on a black background and then restore then on end render. If WriteBackImages is true, then the background will indeed be restored before the write-back happens, thus ensuring the result displayed to the user is on correct background.

◆ GetFixBackground()

virtual bool vtkSynchronizedRenderers::GetFixBackground ( )
virtual

◆ FixBackgroundOn()

virtual void vtkSynchronizedRenderers::FixBackgroundOn ( )
virtual

◆ FixBackgroundOff()

virtual void vtkSynchronizedRenderers::FixBackgroundOff ( )
virtual

◆ HandleStartRender()

virtual void vtkSynchronizedRenderers::HandleStartRender ( )
protectedvirtual

◆ HandleEndRender()

virtual void vtkSynchronizedRenderers::HandleEndRender ( )
protectedvirtual

◆ HandleAbortRender()

virtual void vtkSynchronizedRenderers::HandleAbortRender ( )
inlineprotectedvirtual

Definition at line 257 of file vtkSynchronizedRenderers.h.

◆ MasterStartRender()

virtual void vtkSynchronizedRenderers::MasterStartRender ( )
protectedvirtual

◆ SlaveStartRender()

virtual void vtkSynchronizedRenderers::SlaveStartRender ( )
protectedvirtual

◆ MasterEndRender()

virtual void vtkSynchronizedRenderers::MasterEndRender ( )
protectedvirtual

◆ SlaveEndRender()

virtual void vtkSynchronizedRenderers::SlaveEndRender ( )
protectedvirtual

◆ CaptureRenderedImage()

virtual vtkRawImage& vtkSynchronizedRenderers::CaptureRenderedImage ( )
protectedvirtual

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

The captured image is stored in this->Image.

◆ PushImageToScreen()

virtual void vtkSynchronizedRenderers::PushImageToScreen ( )
protectedvirtual

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

Friends And Related Function Documentation

◆ vtkObserver

friend class vtkObserver
friend

Definition at line 296 of file vtkSynchronizedRenderers.h.

Member Data Documentation

◆ ParallelController

vtkMultiProcessController* vtkSynchronizedRenderers::ParallelController
protected

Definition at line 265 of file vtkSynchronizedRenderers.h.

◆ Renderer

vtkOpenGLRenderer* vtkSynchronizedRenderers::Renderer
protected

Definition at line 266 of file vtkSynchronizedRenderers.h.

◆ CaptureDelegate

vtkSynchronizedRenderers* vtkSynchronizedRenderers::CaptureDelegate
protected

Definition at line 281 of file vtkSynchronizedRenderers.h.

◆ Image

vtkRawImage vtkSynchronizedRenderers::Image
protected

Definition at line 282 of file vtkSynchronizedRenderers.h.

◆ ParallelRendering

bool vtkSynchronizedRenderers::ParallelRendering
protected

Definition at line 284 of file vtkSynchronizedRenderers.h.

◆ ImageReductionFactor

int vtkSynchronizedRenderers::ImageReductionFactor
protected

Definition at line 285 of file vtkSynchronizedRenderers.h.

◆ WriteBackImages

bool vtkSynchronizedRenderers::WriteBackImages
protected

Definition at line 286 of file vtkSynchronizedRenderers.h.

◆ RootProcessId

int vtkSynchronizedRenderers::RootProcessId
protected

Definition at line 287 of file vtkSynchronizedRenderers.h.

◆ AutomaticEventHandling

bool vtkSynchronizedRenderers::AutomaticEventHandling
protected

Definition at line 288 of file vtkSynchronizedRenderers.h.


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