VTK
9.4.20241121
|
synchronizes renderers across processes. More...
#include <vtkSynchronizedRenderers.h>
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. | |
vtkSynchronizedRenderers * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
void | CollectiveExpandForVisiblePropBounds (double bounds[6]) |
Computes visible prob bounds. | |
virtual void | SetRenderer (vtkRenderer *) |
Set the renderer to be synchronized by this instance. | |
virtual vtkRenderer * | GetRenderer () |
Set the renderer to be synchronized by this instance. | |
virtual void | SetParallelController (vtkMultiProcessController *) |
Set the parallel message communicator. | |
virtual vtkMultiProcessController * | GetParallelController () |
Set the parallel message communicator. | |
virtual void | SetParallelRendering (bool) |
Enable/Disable parallel rendering. | |
virtual bool | GetParallelRendering () |
Enable/Disable parallel rendering. | |
virtual void | ParallelRenderingOn () |
Enable/Disable parallel rendering. | |
virtual void | ParallelRenderingOff () |
Enable/Disable parallel rendering. | |
virtual void | SetImageReductionFactor (int) |
Get/Set the image reduction factor. | |
virtual int | GetImageReductionFactor () |
Get/Set the image reduction factor. | |
virtual void | SetWriteBackImages (bool) |
If on (default), the rendered images are pasted back on to the screen. | |
virtual bool | GetWriteBackImages () |
If on (default), the rendered images are pasted back on to the screen. | |
virtual void | WriteBackImagesOn () |
If on (default), the rendered images are pasted back on to the screen. | |
virtual void | WriteBackImagesOff () |
If on (default), the rendered images are pasted back on to the screen. | |
virtual void | SetRootProcessId (int) |
Get/Set the root-process id. | |
virtual int | GetRootProcessId () |
Get/Set the root-process id. | |
virtual void | SetCaptureDelegate (vtkSynchronizedRenderers *) |
When set, this->CaptureRenderedImage() does not capture image from the screen instead passes the call to the delegate. | |
virtual vtkSynchronizedRenderers * | GetCaptureDelegate () |
When set, this->CaptureRenderedImage() does not capture image from the screen instead passes the call to the delegate. | |
void | EnableSynchronizableActors (bool) |
Allows synchronizing collections of actors from local to remote renderer. | |
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. | |
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. | |
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. | |
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. | |
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. | |
virtual bool | GetFixBackground () |
When doing rendering between multiple processes, it is often easier to have all ranks do the rendering on a black background. | |
virtual void | FixBackgroundOn () |
When doing rendering between multiple processes, it is often easier to have all ranks do the rendering on a black background. | |
virtual void | FixBackgroundOff () |
When doing rendering between multiple processes, it is often easier to have all ranks do the rendering on a black background. | |
Public Member Functions inherited from vtkObject | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. | |
virtual void | DebugOff () |
Turn debugging output off. | |
bool | GetDebug () |
Get the value of the debug flag. | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. | |
virtual void | Modified () |
Update the modification time for this object. | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
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) |
vtkTypeBool | InvokeEvent (unsigned long event) |
vtkTypeBool | InvokeEvent (const char *event) |
std::string | GetObjectDescription () const override |
The object description printed in messages and PrintSelf output. | |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
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. | |
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. | |
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. | |
vtkTypeBool | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
vtkTypeBool | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
virtual void | SetObjectName (const std::string &objectName) |
Set/get the name of this object for reporting purposes. | |
virtual std::string | GetObjectName () const |
Set/get the name of this object for reporting purposes. | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. | |
virtual std::string | GetObjectDescription () const |
The object description printed in messages and PrintSelf output. | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
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). | |
virtual void | Delete () |
Delete a VTK object. | |
virtual void | FastDelete () |
Delete a reference to this object. | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. | |
void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). | |
int | GetReferenceCount () |
Return the current reference count of this object. | |
void | SetReferenceCount (int) |
Sets the reference count. | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual bool | UsesGarbageCollector () const |
Indicate whether the class uses vtkGarbageCollector or not. | |
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. | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. | |
static void | SetGlobalWarningDisplay (vtkTypeBool val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOn () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static vtkTypeBool | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
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. | |
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). | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. | |
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. | |
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. | |
virtual void | PushImageToScreen () |
Can be used in HandleEndRender(), MasterEndRender() or SlaveEndRender() calls to paste back the image from this->Image to the viewport. | |
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. | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. | |
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 *) |
virtual void | ObjectFinalize () |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
vtkMultiProcessController * | ParallelController |
vtkOpenGLRenderer * | Renderer |
vtkSynchronizedRenderers * | CaptureDelegate |
vtkRawImage | Image |
bool | ParallelRendering |
int | ImageReductionFactor |
bool | WriteBackImages |
int | RootProcessId |
bool | AutomaticEventHandling |
Protected Attributes inherited from vtkObject | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
std::string | ObjectName |
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 () |
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 39 of file vtkSynchronizedRenderers.h.
Definition at line 43 of file vtkSynchronizedRenderers.h.
anonymous enum |
Enumerator | |
---|---|
SYNC_RENDERER_TAG | |
RESET_CAMERA_TAG | |
COMPUTE_BOUNDS_TAG |
Definition at line 161 of file vtkSynchronizedRenderers.h.
|
protected |
|
overrideprotected |
|
static |
|
static |
|
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 vtkClientServerSynchronizedRenderers, and vtkCompositedSynchronizedRenderers.
|
static |
|
protectedvirtual |
Reimplemented in vtkClientServerSynchronizedRenderers, and vtkCompositedSynchronizedRenderers.
vtkSynchronizedRenderers * vtkSynchronizedRenderers::NewInstance | ( | ) | const |
|
overridevirtual |
|
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 |
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 |
Set the parallel message communicator.
This is used to communicate among processes.
|
virtual |
Set the parallel message communicator.
This is used to communicate among processes.
|
virtual |
Enable/Disable parallel rendering.
Unless Parallel rendering is on, the cameras won't be synchronized across processes.
|
virtual |
Enable/Disable parallel rendering.
Unless Parallel rendering is on, the cameras won't be synchronized across processes.
|
virtual |
Enable/Disable parallel rendering.
Unless Parallel rendering is on, the cameras won't be synchronized across processes.
|
virtual |
Enable/Disable parallel rendering.
Unless Parallel rendering is on, the cameras won't be synchronized across processes.
|
virtual |
Get/Set the image reduction factor.
|
virtual |
Get/Set the image reduction factor.
|
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 |
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 |
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 |
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 |
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 |
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 |
When set, this->CaptureRenderedImage() does not capture image from the screen instead passes the call to the delegate.
|
virtual |
When set, this->CaptureRenderedImage() does not capture image from the screen instead passes the call to the delegate.
void vtkSynchronizedRenderers::EnableSynchronizableActors | ( | bool | ) |
Allows synchronizing collections of actors from local to remote renderer.
|
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 |
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 |
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 |
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 |
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.
|
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.
|
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.
|
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.
|
protectedvirtual |
|
protectedvirtual |
|
inlineprotectedvirtual |
Definition at line 265 of file vtkSynchronizedRenderers.h.
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
Reimplemented in vtkClientServerSynchronizedRenderers, and vtkCompositedSynchronizedRenderers.
|
protectedvirtual |
Reimplemented in vtkClientServerSynchronizedRenderers, and vtkCompositedSynchronizedRenderers.
|
protectedvirtual |
Can be used in HandleEndRender(), MasterEndRender() or SlaveEndRender() calls to capture the rendered image.
The captured image is stored in this->Image
.
|
protectedvirtual |
Can be used in HandleEndRender(), MasterEndRender() or SlaveEndRender() calls to paste back the image from this->Image to the viewport.
|
friend |
Definition at line 304 of file vtkSynchronizedRenderers.h.
|
protected |
Definition at line 273 of file vtkSynchronizedRenderers.h.
|
protected |
Definition at line 274 of file vtkSynchronizedRenderers.h.
|
protected |
Definition at line 289 of file vtkSynchronizedRenderers.h.
|
protected |
Definition at line 290 of file vtkSynchronizedRenderers.h.
|
protected |
Definition at line 292 of file vtkSynchronizedRenderers.h.
|
protected |
Definition at line 293 of file vtkSynchronizedRenderers.h.
|
protected |
Definition at line 294 of file vtkSynchronizedRenderers.h.
|
protected |
Definition at line 295 of file vtkSynchronizedRenderers.h.
|
protected |
Definition at line 296 of file vtkSynchronizedRenderers.h.