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

An object to control sort-last parallel rendering. More...

#include <vtkCompositeRenderManager.h>

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

Public Types

typedef vtkParallelRenderManager Superclass
 
- Public Types inherited from vtkParallelRenderManager
enum  { NEAREST, LINEAR }
 
enum  Tags {
  RENDER_RMI_TAG = 34532, COMPUTE_VISIBLE_PROP_BOUNDS_RMI_TAG = 54636, WIN_INFO_TAG = 87834, REN_INFO_TAG = 87836,
  LIGHT_INFO_TAG = 87838, REN_ID_TAG = 58794, BOUNDS_TAG = 23543
}
 
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...
 
vtkCompositeRenderManagerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetCompositer (vtkCompositer *c)
 Set/Get the composite algorithm. More...
 
virtual vtkCompositerGetCompositer ()
 
- Public Member Functions inherited from vtkParallelRenderManager
vtkParallelRenderManagerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual vtkRenderWindowMakeRenderWindow ()
 Builds a vtkRenderWindow compatible with this render manager. More...
 
virtual vtkRendererMakeRenderer ()
 Builds a vtkRenderer compatible with this render manager. More...
 
virtual vtkRenderWindowGetRenderWindow ()
 Set/Get the RenderWindow to use for compositing. More...
 
virtual void SetRenderWindow (vtkRenderWindow *renWin)
 
virtual vtkMultiProcessControllerGetController ()
 Set/Get the vtkMultiProcessController which will handle communications for the parallel rendering. More...
 
virtual void SetController (vtkMultiProcessController *controller)
 
virtual void InitializePieces ()
 This method sets the piece and number of pieces for each actor with a polydata mapper. More...
 
virtual void InitializeOffScreen ()
 Make all rendering windows not viewable set as off screen rendering. More...
 
virtual void StartInteractor ()
 Initializes the RMIs and then, if on root node, starts the interactor on the attached render window. More...
 
virtual void StartServices ()
 If on node other than root, starts serving RMI requests for parallel renders. More...
 
virtual void StopServices ()
 If on root node, stops the RMI processing on all service nodes. More...
 
virtual void StartRender ()
 Callbacks that initialize and finish rendering and other tasks. More...
 
virtual void EndRender ()
 
virtual void SatelliteStartRender ()
 
virtual void SatelliteEndRender ()
 
virtual void RenderRMI ()
 
virtual void ResetCamera (vtkRenderer *ren)
 
virtual void ResetCameraClippingRange (vtkRenderer *ren)
 
virtual void ComputeVisiblePropBoundsRMI (int renderId)
 
virtual void InitializeRMIs ()
 
virtual void ResetAllCameras ()
 Resets the camera of each renderer contained in the RenderWindow. More...
 
virtual void ComputeVisiblePropBounds (vtkRenderer *ren, double bounds[6])
 Calculates the bounds by gathering information from all processes. More...
 
virtual void SetParallelRendering (int)
 Turns on/off parallel rendering. More...
 
virtual int GetParallelRendering ()
 
virtual void ParallelRenderingOn ()
 
virtual void ParallelRenderingOff ()
 
virtual void SetRenderEventPropagation (int)
 Turns on/off render event propagation. More...
 
virtual int GetRenderEventPropagation ()
 
virtual void RenderEventPropagationOn ()
 
virtual void RenderEventPropagationOff ()
 
virtual void SetUseCompositing (int)
 This is used for tiled display rendering. More...
 
virtual int GetUseCompositing ()
 
virtual void UseCompositingOn ()
 
virtual void UseCompositingOff ()
 
virtual void SetImageReductionFactor (double factor)
 Set/Get the reduction factor (for sort-last based parallel renderers). More...
 
virtual double GetImageReductionFactor ()
 
virtual void SetMaxImageReductionFactor (double)
 
virtual double GetMaxImageReductionFactor ()
 
virtual void SetImageReductionFactorForUpdateRate (double DesiredUpdateRate)
 Sets the ReductionFactor based on the given desired update rate and the rendering metrics taken from the last time UpdateServerInfo was called. More...
 
virtual void SetAutoImageReductionFactor (int)
 If on, the ReductionFactor is automatically adjusted to best meet the the DesiredUpdateRate in the current RenderWindow based on metrics from the last render. More...
 
virtual int GetAutoImageReductionFactor ()
 
virtual void AutoImageReductionFactorOn ()
 
virtual void AutoImageReductionFactorOff ()
 
virtual double GetRenderTime ()
 Get rendering metrics. More...
 
virtual double GetImageProcessingTime ()
 
virtual int GetSyncRenderWindowRenderers ()
 By default, the state of all renderers in the root's render window is propagated to the rest of the processes. More...
 
virtual void SetSyncRenderWindowRenderers (int)
 
virtual void SyncRenderWindowRenderersOn ()
 
virtual void SyncRenderWindowRenderersOff ()
 
virtual void AddRenderer (vtkRenderer *)
 
virtual void RemoveRenderer (vtkRenderer *)
 
virtual void RemoveAllRenderers ()
 
virtual void SetWriteBackImages (int)
 If on (the default), the result of any image space manipulations are written back to the render window frame buffer. More...
 
virtual int GetWriteBackImages ()
 
virtual void WriteBackImagesOn ()
 
virtual void WriteBackImagesOff ()
 
virtual void SetMagnifyImages (int)
 If on (the default), when the ImageReductionFactor is greater than 1 and WriteBackImages is on, the image will be magnified to fill the entire render window. More...
 
virtual int GetMagnifyImages ()
 
virtual void MagnifyImagesOn ()
 
virtual void MagnifyImagesOff ()
 
virtual void SetMagnifyImageMethod (int method)
 Sets the method used to magnify images. More...
 
virtual int GetMagnifyImageMethod ()
 
void SetMagnifyImageMethodToNearest ()
 
void SetMagnifyImageMethodToLinear ()
 
virtual void MagnifyImage (vtkUnsignedCharArray *fullImage, const int fullImageSize[2], vtkUnsignedCharArray *reducedImage, const int reducedImageSize[2], const int fullImageViewport[4]=nullptr, const int reducedImageViewport[4]=nullptr)
 Convenience functions for magnifying images. More...
 
virtual void GetPixelData (vtkUnsignedCharArray *data)
 The most appropriate way to retrieve full size image data after a render. More...
 
virtual void GetPixelData (int x1, int y1, int x2, int y2, vtkUnsignedCharArray *data)
 
virtual void GetReducedPixelData (vtkUnsignedCharArray *data)
 The most appropriate way to retrieve reduced size image data after a render. More...
 
virtual void GetReducedPixelData (int x1, int y1, int x2, int y2, vtkUnsignedCharArray *data)
 
virtual int * GetFullImageSize ()
 Returns the full image size calculated at the last render. More...
 
virtual void GetFullImageSize (int &, int &)
 
virtual void GetFullImageSize (int[2])
 
virtual int * GetReducedImageSize ()
 Returns the reduced image size calculated at the last render. More...
 
virtual void GetReducedImageSize (int &, int &)
 
virtual void GetReducedImageSize (int[2])
 
void TileWindows (int xsize, int ysize, int nColumns)
 Given the x and y size of the render windows, reposition them in a tile of n columns. More...
 
virtual void SetUseRGBA (int)
 Get/Set if all Images must use RGBA instead of RGB. More...
 
virtual int GetUseRGBA ()
 
virtual void SetForceRenderWindowSize (int)
 If ForceRenderWindowSize is set to true, the render manager will use the RenderWindowSize ivar instead of getting the size from the render window. More...
 
virtual int GetForceRenderWindowSize ()
 
virtual void SetForcedRenderWindowSize (int, int)
 If ForceRenderWindowSize is set to true, the render manager will use the Size ivar instead of getting the size from the render window. More...
 
void SetForcedRenderWindowSize (int[2])
 
virtual int * GetForcedRenderWindowSize ()
 
virtual void GetForcedRenderWindowSize (int &, int &)
 
virtual void GetForcedRenderWindowSize (int[2])
 
virtual void CheckForAbortRender ()
 
virtual int CheckForAbortComposite ()
 
virtual void SetUseBackBuffer (int)
 The default is to allow the use of the back buffer for compositing. More...
 
virtual int GetUseBackBuffer ()
 
virtual void UseBackBufferOn ()
 
virtual void UseBackBufferOff ()
 
virtual void SetSynchronizeTileProperties (int)
 When set the render manager will synchronize the TileViewport and TileScale properties. More...
 
virtual int GetSynchronizeTileProperties ()
 
virtual void SynchronizeTilePropertiesOn ()
 
virtual void SynchronizeTilePropertiesOff ()
 
virtual void GenericStartRenderCallback ()
 INTERNAL METHODS (DON NOT USE). More...
 
virtual void GenericEndRenderCallback ()
 
- 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 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...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCompositeRenderManagerSafeDownCast (vtkObjectBase *o)
 
static vtkCompositeRenderManagerNew ()
 
- Static Public Member Functions inherited from vtkParallelRenderManager
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkParallelRenderManagerSafeDownCast (vtkObjectBase *o)
 
static void SetDefaultRenderEventPropagation (bool val)
 Get/Set the default value used for RenderEventPropagation when a new instance of vtkParallelRenderManager is created. More...
 
static bool GetDefaultRenderEventPropagation ()
 
static void MagnifyImageNearest (vtkUnsignedCharArray *fullImage, const int fullImageSize[2], vtkUnsignedCharArray *reducedImage, const int reducedImageSize[2], const int fullImageViewport[4]=nullptr, const int reducedImageViewport[4]=nullptr)
 
static void MagnifyImageLinear (vtkUnsignedCharArray *fullImage, const int fullImageSize[2], vtkUnsignedCharArray *reducedImage, const int reducedImageSize[2], const int fullImageViewport[4]=nullptr, const int reducedImageViewport[4]=nullptr)
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCompositeRenderManager ()
 
 ~vtkCompositeRenderManager () override
 
void PreRenderProcessing () override
 Here is a good place to handle processing of data before and after render. More...
 
void PostRenderProcessing () override
 
- Protected Member Functions inherited from vtkParallelRenderManager
 vtkParallelRenderManager ()
 
 ~vtkParallelRenderManager () override
 
void AddRenderWindowEventHandlers ()
 Add/Remove event handlers for the render window. More...
 
void RemoveRenderWindowEventHandlers ()
 
virtual vtkRendererCollectionGetRenderers ()
 
virtual void SendWindowInformation ()
 Used to synchronize rendering information per frame. More...
 
virtual void ReceiveWindowInformation ()
 
virtual void SendRendererInformation (vtkRenderer *)
 
virtual void ReceiveRendererInformation (vtkRenderer *)
 
virtual void CollectWindowInformation (vtkMultiProcessStream &)
 Subclass should override these methods (instead of SendWindowInformation/ReceiveWindowInformation or SendRendererInformation/ReceiveRendererInformation) to collect or process meta-data to synchronize rendering information per frame. More...
 
virtual bool ProcessWindowInformation (vtkMultiProcessStream &)
 
virtual void CollectRendererInformation (vtkRenderer *, vtkMultiProcessStream &)
 
virtual bool ProcessRendererInformation (vtkRenderer *, vtkMultiProcessStream &)
 
virtual void SetRenderWindowSize ()
 Called in satellites to set the render window size to the current FullImageSize and ReducedImageSize (or vice versa). More...
 
virtual void LocalComputeVisiblePropBounds (vtkRenderer *ren, double bounds[6])
 Called by ComputeVisiblePropBoundsRMI to get the bounds of a local renderer. More...
 
virtual void MagnifyReducedImage ()
 When called, fills FullImage. More...
 
virtual void WriteFullImage ()
 Write the full image back to the RenderWindow. More...
 
virtual void ReadReducedImage ()
 Reads in the reduced image from the RenderWindow. More...
 
virtual int LastRenderInFrontBuffer ()
 Returns 1 if the RenderWindow's last image is in the front buffer, 0 if it is in the back. More...
 
virtual int ChooseBuffer ()
 Select buffer to read from / render into. More...
 
virtual void SetRenderWindowPixelData (vtkUnsignedCharArray *pixels, const int pixelDimensions[2])
 Sets the current render window's pixel data. More...
 
virtual int ImageReduceRenderer (vtkRenderer *)
 Returns true if the image for the given renderer should be rendered at a reduced size to be magnified later. 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 CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkCompositerCompositer
 
vtkFloatArrayDepthData
 
vtkUnsignedCharArrayTmpPixelData
 
vtkFloatArrayTmpDepthData
 
int SavedMultiSamplesSetting
 
- Protected Attributes inherited from vtkParallelRenderManager
vtkRenderWindowRenderWindow
 
vtkMultiProcessControllerController
 
vtkRendererCollectionRenderers
 
int ForceRenderWindowSize
 
int ForcedRenderWindowSize [2]
 
int RootProcessId
 The "root" node's process id. More...
 
int ObservingRenderWindow
 
int ObservingAbort
 
unsigned long StartRenderTag
 
unsigned long EndRenderTag
 
unsigned long ResetCameraTag
 
unsigned long ResetCameraClippingRangeTag
 
unsigned long AbortRenderCheckTag
 
double ImageReductionFactor
 
double MaxImageReductionFactor
 
int AutoImageReductionFactor
 
int WriteBackImages
 
int MagnifyImages
 
int MagnifyImageMethod
 
int UseRGBA
 
int SynchronizeTileProperties
 
int FullImageSize [2]
 
int ReducedImageSize [2]
 
vtkUnsignedCharArrayFullImage
 
vtkUnsignedCharArrayReducedImage
 
int FullImageUpToDate
 
int ReducedImageUpToDate
 
int RenderWindowImageUpToDate
 
vtkDoubleArrayViewports
 
int Lock
 
int ParallelRendering
 
int RenderEventPropagation
 
int UseCompositing
 
int SyncRenderWindowRenderers
 
vtkTimerLogTimer
 
double RenderTime
 
double ImageProcessingTime
 
double AverageTimePerPixel
 Used by SetImageReductionFactorForUpdateRate to smooth transitions transitions between image reduction factors. More...
 
int AddedRMIs
 
unsigned long RenderRMIId
 
unsigned long BoundsRMIId
 
int UseBackBuffer
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Attributes inherited from vtkParallelRenderManager
static bool DefaultRenderEventPropagation
 

Detailed Description

An object to control sort-last parallel rendering.

vtkCompositeRenderManager is a subclass of vtkParallelRenderManager that uses compositing to do parallel rendering. This class has replaced vtkCompositeManager.

Definition at line 35 of file vtkCompositeRenderManager.h.

Member Typedef Documentation

◆ Superclass

Definition at line 38 of file vtkCompositeRenderManager.h.

Constructor & Destructor Documentation

◆ vtkCompositeRenderManager()

vtkCompositeRenderManager::vtkCompositeRenderManager ( )
protected

◆ ~vtkCompositeRenderManager()

vtkCompositeRenderManager::~vtkCompositeRenderManager ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkCompositeRenderManager::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkParallelRenderManager.

◆ NewInstance()

vtkCompositeRenderManager* vtkCompositeRenderManager::NewInstance ( ) const

◆ New()

static vtkCompositeRenderManager* vtkCompositeRenderManager::New ( )
static

◆ PrintSelf()

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

◆ SetCompositer()

void vtkCompositeRenderManager::SetCompositer ( vtkCompositer c)

Set/Get the composite algorithm.

◆ GetCompositer()

virtual vtkCompositer* vtkCompositeRenderManager::GetCompositer ( )
virtual

◆ PreRenderProcessing()

void vtkCompositeRenderManager::PreRenderProcessing ( )
overrideprotectedvirtual

Here is a good place to handle processing of data before and after render.

Implements vtkParallelRenderManager.

◆ PostRenderProcessing()

void vtkCompositeRenderManager::PostRenderProcessing ( )
overrideprotectedvirtual

Member Data Documentation

◆ Compositer

vtkCompositer* vtkCompositeRenderManager::Compositer
protected

Definition at line 54 of file vtkCompositeRenderManager.h.

◆ DepthData

vtkFloatArray* vtkCompositeRenderManager::DepthData
protected

Definition at line 59 of file vtkCompositeRenderManager.h.

◆ TmpPixelData

vtkUnsignedCharArray* vtkCompositeRenderManager::TmpPixelData
protected

Definition at line 60 of file vtkCompositeRenderManager.h.

◆ TmpDepthData

vtkFloatArray* vtkCompositeRenderManager::TmpDepthData
protected

Definition at line 61 of file vtkCompositeRenderManager.h.

◆ SavedMultiSamplesSetting

int vtkCompositeRenderManager::SavedMultiSamplesSetting
protected

Definition at line 63 of file vtkCompositeRenderManager.h.


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