VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkClientServerSynchronizedRenderers Class Reference

vtkClientServerSynchronizedRenderers is a vtkSynchronizedRenderers subclass designed to be used in 2 processes, client-server mode. More...

#include <vtkClientServerSynchronizedRenderers.h>

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

Public Types

typedef vtkSynchronizedRenderers Superclass
 
- Public Types inherited from vtkSynchronizedRenderers
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...
 
vtkClientServerSynchronizedRenderersNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
- Public Member Functions inherited from vtkSynchronizedRenderers
vtkSynchronizedRenderersNewInstance () 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 vtkRendererGetRenderer ()
 Set the renderer to be synchronized by this instance. More...
 
virtual void SetParallelController (vtkMultiProcessController *)
 Set the parallel message communicator. More...
 
virtual vtkMultiProcessControllerGetParallelController ()
 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 vtkSynchronizedRenderersGetCaptureDelegate ()
 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...
 
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 ()
 When doing rendering between multiple processes, it is often easier to have all ranks do the rendering on a black background. More...
 
virtual void FixBackgroundOn ()
 When doing rendering between multiple processes, it is often easier to have all ranks do the rendering on a black background. More...
 
virtual void FixBackgroundOff ()
 When doing rendering between multiple processes, it is often easier to have all ranks do the rendering on a black background. 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...
 
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...
 
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 vtkClientServerSynchronizedRenderersNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkClientServerSynchronizedRenderersSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkSynchronizedRenderers
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 ()
 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
 
 vtkClientServerSynchronizedRenderers ()
 
 ~vtkClientServerSynchronizedRenderers () override
 
void MasterEndRender () override
 
void SlaveEndRender () override
 
- Protected Member Functions inherited from vtkSynchronizedRenderers
 vtkSynchronizedRenderers ()
 
 ~vtkSynchronizedRenderers () override
 
virtual void HandleStartRender ()
 
virtual void HandleEndRender ()
 
virtual void HandleAbortRender ()
 
virtual void MasterStartRender ()
 
virtual void SlaveStartRender ()
 
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 ()
 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 &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkSynchronizedRenderers
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
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

vtkClientServerSynchronizedRenderers is a vtkSynchronizedRenderers subclass designed to be used in 2 processes, client-server mode.

Definition at line 28 of file vtkClientServerSynchronizedRenderers.h.

Member Typedef Documentation

Definition at line 33 of file vtkClientServerSynchronizedRenderers.h.

Constructor & Destructor Documentation

vtkClientServerSynchronizedRenderers::vtkClientServerSynchronizedRenderers ( )
protected
vtkClientServerSynchronizedRenderers::~vtkClientServerSynchronizedRenderers ( )
overrideprotected

Member Function Documentation

static vtkClientServerSynchronizedRenderers* vtkClientServerSynchronizedRenderers::New ( )
static
static vtkTypeBool vtkClientServerSynchronizedRenderers::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool vtkClientServerSynchronizedRenderers::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 vtkSynchronizedRenderers.

static vtkClientServerSynchronizedRenderers* vtkClientServerSynchronizedRenderers::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkClientServerSynchronizedRenderers::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkSynchronizedRenderers.

vtkClientServerSynchronizedRenderers* vtkClientServerSynchronizedRenderers::NewInstance ( ) const
void vtkClientServerSynchronizedRenderers::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 vtkClientServerSynchronizedRenderers::MasterEndRender ( )
overrideprotectedvirtual

Reimplemented from vtkSynchronizedRenderers.

void vtkClientServerSynchronizedRenderers::SlaveEndRender ( )
overrideprotectedvirtual

Reimplemented from vtkSynchronizedRenderers.


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