Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPVSynchronizedRenderer Class Reference

coordinates rendering between corresponding renderers across multiple processes More...

#include <vtkPVSynchronizedRenderer.h>

Inheritance diagram for vtkPVSynchronizedRenderer:
Inheritance graph
[legend]
Collaboration diagram for vtkPVSynchronizedRenderer:
Collaboration graph
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void Initialize (vtkPVSession *session)
 Must be called once to initialize the instance. More...
 
void SetOrderedCompositingHelper (vtkOrderedCompositingHelper *helper)
 Used to determine sorting order and use ordered compositing. More...
 
void SetRenderer (vtkRenderer *)
 Set the renderer that is being synchronized. More...
 
void SetUseDepthBuffer (bool)
 Activates or de-activated the use of Depth Buffer in an ImageProcessingPass. More...
 
void SetRenderEmptyImages (bool)
 Enable/Disable empty images optimization. More...
 
void SetNVPipeSupport (bool)
 Enable/Disable NVPipe. More...
 
virtual vtkFXAAOptions * GetFXAAOptions ()
 Set/Get FXAA options. More...
 
virtual void SetFXAAOptions (vtkFXAAOptions *)
 
virtual void SetDisableIceT (bool)
 Set this flag to true before calling Initialize() to disable using vtkIceTSynchronizedRenderers for parallel rendering. More...
 
virtual bool GetDisableIceT ()
 Set this flag to true before calling Initialize() to disable using vtkIceTSynchronizedRenderers for parallel rendering. More...
 
virtual void SetEnabled (bool enabled)
 Enable/Disable parallel rendering. More...
 
virtual bool GetEnabled ()
 Enable/Disable parallel rendering. More...
 
virtual void EnabledOn ()
 Enable/Disable parallel rendering. More...
 
virtual void EnabledOff ()
 Enable/Disable parallel rendering. More...
 
void SetImageReductionFactor (int)
 Get/Set the image reduction factor. More...
 
virtual int GetImageReductionFactor ()
 Get/Set the image reduction factor. More...
 
void SetDataReplicatedOnAllProcesses (bool)
 Set to true if data is replicated on all processes. More...
 
virtual bool GetDataReplicatedOnAllProcesses ()
 Set to true if data is replicated on all processes. More...
 
virtual void DataReplicatedOnAllProcessesOn ()
 Set to true if data is replicated on all processes. More...
 
virtual void DataReplicatedOnAllProcessesOff ()
 Set to true if data is replicated on all processes. More...
 
void SetImageProcessingPass (vtkImageProcessingPass *)
 Get/Set an image processing pass to process the rendered images. More...
 
virtual vtkImageProcessingPassGetImageProcessingPass ()
 Get/Set an image processing pass to process the rendered images. More...
 
void SetRenderPass (vtkRenderPass *)
 Get/Set geometry rendering pass. More...
 
virtual vtkRenderPassGetRenderPass ()
 Get/Set geometry rendering pass. More...
 
void ConfigureCompressor (const char *configuration)
 Passes the compressor configuration to the client-server synchronizer, if any. More...
 
void SetLossLessCompression (bool)
 Passes the compressor configuration to the client-server synchronizer, if any. More...
 
void SetEnableRayTracing (bool val)
 State flags to turn on specialized treatment for ray tracing. More...
 
virtual bool GetEnableRayTracing ()
 State flags to turn on specialized treatment for ray tracing. More...
 
void SetEnablePathTracing (bool val)
 State flags to turn on specialized treatment for ray tracing. More...
 
virtual bool GetEnablePathTracing ()
 State flags to turn on specialized treatment for ray tracing. More...
 
virtual vtkSynchronizedRenderersGetParallelSynchronizer ()
 Not for the faint hearted. More...
 
virtual vtkSynchronizedRenderersGetCSSynchronizer ()
 Not for the faint hearted. More...
 
virtual void SetUseFXAA (bool use)
 Enable/disable FXAA antialiasing. More...
 
virtual bool GetUseFXAA ()
 Enable/disable FXAA antialiasing. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int 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)
 
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 *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
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 *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkPVSynchronizedRendererNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVSynchronizedRendererSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkPVSynchronizedRenderer ()
 
 ~vtkPVSynchronizedRenderer () override
 
virtual void SetupPasses ()
 Sets up the render passes on the renderer. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- 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

vtkSynchronizedRenderersCSSynchronizer
 
vtkSynchronizedRenderersParallelSynchronizer
 
vtkImageProcessingPassImageProcessingPass
 
vtkRenderPassRenderPass
 
bool Enabled
 
bool DisableIceT
 
int ImageReductionFactor
 
vtkOpenGLRendererRenderer
 
bool UseDepthBuffer
 
bool RenderEmptyImages
 
bool DataReplicatedOnAllProcesses
 
bool EnableRayTracing
 
bool EnablePathTracing
 
bool UseFXAA = false
 
vtkFXAAOptions * FXAAOptions = nullptr
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

coordinates rendering between corresponding renderers across multiple processes

vtkPVSynchronizedRenderer coordinates rendering between renderers that are split across multiple ranks. It internally uses other vtkSynchronizedRenderers subclasses based on the operation mode to do the actual coordination such as vtkCaveSynchronizedRenderers, vtkIceTSynchronizedRenderers, vtkPVClientServerSynchronizedRenderers and vtkCompositedSynchronizedRenderers.

Definition at line 45 of file vtkPVSynchronizedRenderer.h.

Member Typedef Documentation

◆ Superclass

Definition at line 49 of file vtkPVSynchronizedRenderer.h.

Constructor & Destructor Documentation

◆ vtkPVSynchronizedRenderer()

vtkPVSynchronizedRenderer::vtkPVSynchronizedRenderer ( )
protected

◆ ~vtkPVSynchronizedRenderer()

vtkPVSynchronizedRenderer::~vtkPVSynchronizedRenderer ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkPVSynchronizedRenderer* vtkPVSynchronizedRenderer::New ( )
static

◆ GetClassName()

virtual const char* vtkPVSynchronizedRenderer::GetClassName ( )
virtual

◆ IsTypeOf()

static int vtkPVSynchronizedRenderer::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkPVSynchronizedRenderer::IsA ( const char *  type)
virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkPVSynchronizedRenderer* vtkPVSynchronizedRenderer::SafeDownCast ( vtkObject o)
static

◆ PrintSelf()

void vtkPVSynchronizedRenderer::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkObject.

◆ SetDisableIceT()

virtual void vtkPVSynchronizedRenderer::SetDisableIceT ( bool  )
virtual

Set this flag to true before calling Initialize() to disable using vtkIceTSynchronizedRenderers for parallel rendering.

Default value is setup using vtkPVRenderViewSettings::GetDisableIceT.

◆ GetDisableIceT()

virtual bool vtkPVSynchronizedRenderer::GetDisableIceT ( )
virtual

Set this flag to true before calling Initialize() to disable using vtkIceTSynchronizedRenderers for parallel rendering.

Default value is setup using vtkPVRenderViewSettings::GetDisableIceT.

◆ Initialize()

void vtkPVSynchronizedRenderer::Initialize ( vtkPVSession session)

Must be called once to initialize the instance.

This will create appropriate internal vtkSynchronizedRenderers subclasses based on the process type and session provided.

◆ SetOrderedCompositingHelper()

void vtkPVSynchronizedRenderer::SetOrderedCompositingHelper ( vtkOrderedCompositingHelper helper)

Used to determine sorting order and use ordered compositing.

Set to nullptr to not use ordered compositing and instead use depth-buffer based compositing, if applicable.

◆ SetRenderer()

void vtkPVSynchronizedRenderer::SetRenderer ( vtkRenderer )

Set the renderer that is being synchronized.

◆ SetEnabled()

virtual void vtkPVSynchronizedRenderer::SetEnabled ( bool  enabled)
virtual

Enable/Disable parallel rendering.

◆ GetEnabled()

virtual bool vtkPVSynchronizedRenderer::GetEnabled ( )
virtual

Enable/Disable parallel rendering.

◆ EnabledOn()

virtual void vtkPVSynchronizedRenderer::EnabledOn ( )
virtual

Enable/Disable parallel rendering.

◆ EnabledOff()

virtual void vtkPVSynchronizedRenderer::EnabledOff ( )
virtual

Enable/Disable parallel rendering.

◆ SetImageReductionFactor()

void vtkPVSynchronizedRenderer::SetImageReductionFactor ( int  )

Get/Set the image reduction factor.

This needs to be set on all processes and must match up.

◆ GetImageReductionFactor()

virtual int vtkPVSynchronizedRenderer::GetImageReductionFactor ( )
virtual

Get/Set the image reduction factor.

This needs to be set on all processes and must match up.

◆ SetDataReplicatedOnAllProcesses()

void vtkPVSynchronizedRenderer::SetDataReplicatedOnAllProcesses ( bool  )

Set to true if data is replicated on all processes.

This will enable IceT to minimize communications since data is available on all process. Off by default.

◆ GetDataReplicatedOnAllProcesses()

virtual bool vtkPVSynchronizedRenderer::GetDataReplicatedOnAllProcesses ( )
virtual

Set to true if data is replicated on all processes.

This will enable IceT to minimize communications since data is available on all process. Off by default.

◆ DataReplicatedOnAllProcessesOn()

virtual void vtkPVSynchronizedRenderer::DataReplicatedOnAllProcessesOn ( )
virtual

Set to true if data is replicated on all processes.

This will enable IceT to minimize communications since data is available on all process. Off by default.

◆ DataReplicatedOnAllProcessesOff()

virtual void vtkPVSynchronizedRenderer::DataReplicatedOnAllProcessesOff ( )
virtual

Set to true if data is replicated on all processes.

This will enable IceT to minimize communications since data is available on all process. Off by default.

◆ SetImageProcessingPass()

void vtkPVSynchronizedRenderer::SetImageProcessingPass ( vtkImageProcessingPass )

Get/Set an image processing pass to process the rendered images.

◆ GetImageProcessingPass()

virtual vtkImageProcessingPass* vtkPVSynchronizedRenderer::GetImageProcessingPass ( )
virtual

Get/Set an image processing pass to process the rendered images.

◆ SetRenderPass()

void vtkPVSynchronizedRenderer::SetRenderPass ( vtkRenderPass )

Get/Set geometry rendering pass.

This pass is used to render the geometry. If none specified then default rendering pipeline is used. This is typically the render-pass pipeline after the CameraPass. The CameraPass is setup by ParaView specially since ParaView needs some customizations for multiviews/icet etc.

◆ GetRenderPass()

virtual vtkRenderPass* vtkPVSynchronizedRenderer::GetRenderPass ( )
virtual

Get/Set geometry rendering pass.

This pass is used to render the geometry. If none specified then default rendering pipeline is used. This is typically the render-pass pipeline after the CameraPass. The CameraPass is setup by ParaView specially since ParaView needs some customizations for multiviews/icet etc.

◆ ConfigureCompressor()

void vtkPVSynchronizedRenderer::ConfigureCompressor ( const char *  configuration)

Passes the compressor configuration to the client-server synchronizer, if any.

This affects the image compression used to relay images back to the client. See vtkPVClientServerSynchronizedRenderers::ConfigureCompressor() for details.

◆ SetLossLessCompression()

void vtkPVSynchronizedRenderer::SetLossLessCompression ( bool  )

Passes the compressor configuration to the client-server synchronizer, if any.

This affects the image compression used to relay images back to the client. See vtkPVClientServerSynchronizedRenderers::ConfigureCompressor() for details.

◆ SetUseDepthBuffer()

void vtkPVSynchronizedRenderer::SetUseDepthBuffer ( bool  )

Activates or de-activated the use of Depth Buffer in an ImageProcessingPass.

◆ SetRenderEmptyImages()

void vtkPVSynchronizedRenderer::SetRenderEmptyImages ( bool  )

Enable/Disable empty images optimization.

◆ SetNVPipeSupport()

void vtkPVSynchronizedRenderer::SetNVPipeSupport ( bool  )

Enable/Disable NVPipe.

◆ SetEnableRayTracing()

void vtkPVSynchronizedRenderer::SetEnableRayTracing ( bool  val)

State flags to turn on specialized treatment for ray tracing.

◆ GetEnableRayTracing()

virtual bool vtkPVSynchronizedRenderer::GetEnableRayTracing ( )
virtual

State flags to turn on specialized treatment for ray tracing.

◆ SetEnablePathTracing()

void vtkPVSynchronizedRenderer::SetEnablePathTracing ( bool  val)

State flags to turn on specialized treatment for ray tracing.

◆ GetEnablePathTracing()

virtual bool vtkPVSynchronizedRenderer::GetEnablePathTracing ( )
virtual

State flags to turn on specialized treatment for ray tracing.

◆ GetParallelSynchronizer()

virtual vtkSynchronizedRenderers* vtkPVSynchronizedRenderer::GetParallelSynchronizer ( )
virtual

Not for the faint hearted.

This internal vtkSynchronizedRenderers instances are exposed for advanced users that want to do advanced tricks with rendering. These will change without notice. Do not use them unless you know what you are doing. ParallelSynchronizer is the vtkSynchronizedRenderers used to synchronize rendering between processes in an MPI group – typically vtkIceTSynchronizedRenderers when available. CSSynchronizer is the client-server vtkSynchronizedRenderers used in client-server configurations.

◆ GetCSSynchronizer()

virtual vtkSynchronizedRenderers* vtkPVSynchronizedRenderer::GetCSSynchronizer ( )
virtual

Not for the faint hearted.

This internal vtkSynchronizedRenderers instances are exposed for advanced users that want to do advanced tricks with rendering. These will change without notice. Do not use them unless you know what you are doing. ParallelSynchronizer is the vtkSynchronizedRenderers used to synchronize rendering between processes in an MPI group – typically vtkIceTSynchronizedRenderers when available. CSSynchronizer is the client-server vtkSynchronizedRenderers used in client-server configurations.

◆ SetUseFXAA()

virtual void vtkPVSynchronizedRenderer::SetUseFXAA ( bool  use)
virtual

Enable/disable FXAA antialiasing.

◆ GetUseFXAA()

virtual bool vtkPVSynchronizedRenderer::GetUseFXAA ( )
virtual

Enable/disable FXAA antialiasing.

◆ GetFXAAOptions()

virtual vtkFXAAOptions* vtkPVSynchronizedRenderer::GetFXAAOptions ( )
virtual

Set/Get FXAA options.

◆ SetFXAAOptions()

virtual void vtkPVSynchronizedRenderer::SetFXAAOptions ( vtkFXAAOptions *  )
virtual

◆ SetupPasses()

virtual void vtkPVSynchronizedRenderer::SetupPasses ( )
protectedvirtual

Sets up the render passes on the renderer.

This won't get called on processes where vtkIceTSynchronizedRenderers is used. In that case the passes are forwarded to the vtkIceTSynchronizedRenderers instance.

Member Data Documentation

◆ CSSynchronizer

vtkSynchronizedRenderers* vtkPVSynchronizedRenderer::CSSynchronizer
protected

Definition at line 210 of file vtkPVSynchronizedRenderer.h.

◆ ParallelSynchronizer

vtkSynchronizedRenderers* vtkPVSynchronizedRenderer::ParallelSynchronizer
protected

Definition at line 211 of file vtkPVSynchronizedRenderer.h.

◆ ImageProcessingPass

vtkImageProcessingPass* vtkPVSynchronizedRenderer::ImageProcessingPass
protected

Definition at line 212 of file vtkPVSynchronizedRenderer.h.

◆ RenderPass

vtkRenderPass* vtkPVSynchronizedRenderer::RenderPass
protected

Definition at line 213 of file vtkPVSynchronizedRenderer.h.

◆ Enabled

bool vtkPVSynchronizedRenderer::Enabled
protected

Definition at line 215 of file vtkPVSynchronizedRenderer.h.

◆ DisableIceT

bool vtkPVSynchronizedRenderer::DisableIceT
protected

Definition at line 216 of file vtkPVSynchronizedRenderer.h.

◆ ImageReductionFactor

int vtkPVSynchronizedRenderer::ImageReductionFactor
protected

Definition at line 217 of file vtkPVSynchronizedRenderer.h.

◆ Renderer

vtkOpenGLRenderer* vtkPVSynchronizedRenderer::Renderer
protected

Definition at line 218 of file vtkPVSynchronizedRenderer.h.

◆ UseDepthBuffer

bool vtkPVSynchronizedRenderer::UseDepthBuffer
protected

Definition at line 220 of file vtkPVSynchronizedRenderer.h.

◆ RenderEmptyImages

bool vtkPVSynchronizedRenderer::RenderEmptyImages
protected

Definition at line 221 of file vtkPVSynchronizedRenderer.h.

◆ DataReplicatedOnAllProcesses

bool vtkPVSynchronizedRenderer::DataReplicatedOnAllProcesses
protected

Definition at line 222 of file vtkPVSynchronizedRenderer.h.

◆ EnableRayTracing

bool vtkPVSynchronizedRenderer::EnableRayTracing
protected

Definition at line 224 of file vtkPVSynchronizedRenderer.h.

◆ EnablePathTracing

bool vtkPVSynchronizedRenderer::EnablePathTracing
protected

Definition at line 225 of file vtkPVSynchronizedRenderer.h.

◆ UseFXAA

bool vtkPVSynchronizedRenderer::UseFXAA = false
protected

Definition at line 227 of file vtkPVSynchronizedRenderer.h.

◆ FXAAOptions

vtkFXAAOptions* vtkPVSynchronizedRenderer::FXAAOptions = nullptr
protected

Definition at line 228 of file vtkPVSynchronizedRenderer.h.


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