An object to control parallel rendering. More...

#include <vtkParallelRenderManager.h>

Inheritance diagram for vtkParallelRenderManager:

Collaboration diagram for vtkParallelRenderManager:

Classes
struct	LightInfo

struct	RendererInfo

struct	RenderWindowInfo

Public Types
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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkParallelRenderManager *	NewInstance () const

virtual void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkRenderWindow *	MakeRenderWindow ()

virtual vtkRenderer *	MakeRenderer ()

virtual void	InitializePieces ()

virtual void	InitializeOffScreen ()

virtual void	StartInteractor ()

virtual void	StartServices ()

virtual void	StopServices ()

virtual void	InitializeRMIs ()

virtual void	ResetAllCameras ()

virtual void	ComputeVisiblePropBounds (vtkRenderer *ren, double bounds[6])

virtual void	SetMaxImageReductionFactor (double)

virtual double	GetMaxImageReductionFactor ()

virtual void	SetImageReductionFactorForUpdateRate (double DesiredUpdateRate)

void	TileWindows (int xsize, int ysize, int nColumns)

virtual void	CheckForAbortRender ()

virtual int	CheckForAbortComposite ()


virtual vtkRenderWindow *	GetRenderWindow ()

virtual void	SetRenderWindow (vtkRenderWindow *renWin)


virtual vtkMultiProcessController *	GetController ()

virtual void	SetController (vtkMultiProcessController *controller)


virtual void	StartRender ()

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	SetParallelRendering (int)

virtual int	GetParallelRendering ()

virtual void	ParallelRenderingOn ()

virtual void	ParallelRenderingOff ()


virtual void	SetRenderEventPropagation (int)

virtual int	GetRenderEventPropagation ()

virtual void	RenderEventPropagationOn ()

virtual void	RenderEventPropagationOff ()


virtual void	SetUseCompositing (int)

virtual int	GetUseCompositing ()

virtual void	UseCompositingOn ()

virtual void	UseCompositingOff ()


virtual void	SetImageReductionFactor (double factor)

virtual double	GetImageReductionFactor ()


virtual void	SetAutoImageReductionFactor (int)

virtual int	GetAutoImageReductionFactor ()

virtual void	AutoImageReductionFactorOn ()

virtual void	AutoImageReductionFactorOff ()


virtual double	GetRenderTime ()

virtual double	GetImageProcessingTime ()


virtual int	GetSyncRenderWindowRenderers ()

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)

virtual int	GetWriteBackImages ()

virtual void	WriteBackImagesOn ()

virtual void	WriteBackImagesOff ()


virtual void	SetMagnifyImages (int)

virtual int	GetMagnifyImages ()

virtual void	MagnifyImagesOn ()

virtual void	MagnifyImagesOff ()


virtual void	SetMagnifyImageMethod (int method)

virtual int	GetMagnifyImageMethod ()

void	SetMagnifyImageMethodToNearest ()

void	SetMagnifyImageMethodToLinear ()


virtual void	GetPixelData (vtkUnsignedCharArray *data)

virtual void	GetPixelData (int x1, int y1, int x2, int y2, vtkUnsignedCharArray *data)


virtual void	GetReducedPixelData (vtkUnsignedCharArray *data)

virtual void	GetReducedPixelData (int x1, int y1, int x2, int y2, vtkUnsignedCharArray *data)


virtual int *	GetFullImageSize ()

virtual void	GetFullImageSize (int &, int &)

virtual void	GetFullImageSize (int[2])


virtual int *	GetReducedImageSize ()

virtual void	GetReducedImageSize (int &, int &)

virtual void	GetReducedImageSize (int[2])


virtual void	SetUseRGBA (int)

virtual int	GetUseRGBA ()


virtual void	SetForceRenderWindowSize (int)

virtual int	GetForceRenderWindowSize ()


virtual void	SetForcedRenderWindowSize (int, int)

void	SetForcedRenderWindowSize (int[2])

virtual int *	GetForcedRenderWindowSize ()

virtual void	GetForcedRenderWindowSize (int &, int &)

virtual void	GetForcedRenderWindowSize (int[2])


virtual void	SetUseBackBuffer (int)

virtual int	GetUseBackBuffer ()

virtual void	UseBackBufferOn ()

virtual void	UseBackBufferOff ()


virtual void	SetSynchronizeTileProperties (int)

virtual int	GetSynchronizeTileProperties ()

virtual void	SynchronizeTilePropertiesOn ()

virtual void	SynchronizeTilePropertiesOff ()


virtual void	GenericStartRenderCallback ()

virtual void	GenericEndRenderCallback ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (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 )

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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

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)

int	InvokeEvent (unsigned long event, void *callData)

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

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkParallelRenderManager *	SafeDownCast (vtkObjectBase *o)


static void	SetDefaultRenderEventPropagation (bool val)

static bool	GetDefaultRenderEventPropagation ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkParallelRenderManager ()

	~vtkParallelRenderManager ()

virtual vtkRendererCollection *	GetRenderers ()

virtual void	SetRenderWindowSize ()

virtual void	LocalComputeVisiblePropBounds (vtkRenderer *ren, double bounds[6])

virtual void	MagnifyReducedImage ()

virtual void	WriteFullImage ()

virtual void	ReadReducedImage ()

virtual int	LastRenderInFrontBuffer ()

virtual int	ChooseBuffer ()

virtual int	ImageReduceRenderer (vtkRenderer *)


void	AddRenderWindowEventHandlers ()

void	RemoveRenderWindowEventHandlers ()


virtual void	SendWindowInformation ()

virtual void	ReceiveWindowInformation ()

virtual void	SendRendererInformation (vtkRenderer *)

virtual void	ReceiveRendererInformation (vtkRenderer *)


virtual void	CollectWindowInformation (vtkMultiProcessStream &)

virtual bool	ProcessWindowInformation (vtkMultiProcessStream &)

virtual void	CollectRendererInformation (vtkRenderer *, vtkMultiProcessStream &)

virtual bool	ProcessRendererInformation (vtkRenderer *, vtkMultiProcessStream &)


virtual void	PreRenderProcessing ()=0

virtual void	PostRenderProcessing ()=0


virtual void	SetRenderWindowPixelData (vtkUnsignedCharArray *pixels, const int pixelDimensions[2])

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

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
vtkRenderWindow *	RenderWindow

vtkMultiProcessController *	Controller

vtkRendererCollection *	Renderers

int	ForceRenderWindowSize

int	ForcedRenderWindowSize [2]

int	RootProcessId

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]

vtkUnsignedCharArray *	FullImage

vtkUnsignedCharArray *	ReducedImage

int	FullImageUpToDate

int	ReducedImageUpToDate

int	RenderWindowImageUpToDate

vtkDoubleArray *	Viewports

int	Lock

int	ParallelRendering

int	RenderEventPropagation

int	UseCompositing

int	SyncRenderWindowRenderers

vtkTimerLog *	Timer

double	RenderTime

double	ImageProcessingTime

double	AverageTimePerPixel

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
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Static Protected Attributes
static bool	DefaultRenderEventPropagation

static void	MagnifyImageNearest (vtkUnsignedCharArray fullImage, const int fullImageSize[2], vtkUnsignedCharArray reducedImage, const int reducedImageSize[2], const int fullImageViewport[4]=NULL, const int reducedImageViewport[4]=NULL)

static void	MagnifyImageLinear (vtkUnsignedCharArray fullImage, const int fullImageSize[2], vtkUnsignedCharArray reducedImage, const int reducedImageSize[2], const int fullImageViewport[4]=NULL, const int reducedImageViewport[4]=NULL)

virtual void	MagnifyImage (vtkUnsignedCharArray fullImage, const int fullImageSize[2], vtkUnsignedCharArray reducedImage, const int reducedImageSize[2], const int fullImageViewport[4]=NULL, const int reducedImageViewport[4]=NULL)

Detailed Description

An object to control parallel rendering.

vtkParallelRenderManager operates in multiple processes. It provides proper renderers and render windows for performing the parallel rendering correctly. It can also attach itself to render windows and propagate rendering events and camera views.

Attention: Many parallel rendering schemes do not correctly handle transparency. Unless otherwise documented, assume a sub class does not.

Todo:: Synchronization/barrier primitives.

Todo:: Query ranges of scalar values of objects in addition to the boundary in three-space

Events:: vtkCommand::StartEvent vtkCommand::EndEvent

Tests:: vtkParallelRenderManager (Tests)

Definition at line 64 of file vtkParallelRenderManager.h.

Member Typedef Documentation

typedef vtkObject vtkParallelRenderManager::Superclass

Definition at line 67 of file vtkParallelRenderManager.h.

Member Enumeration Documentation

anonymous enum

Enumerator
NEAREST
LINEAR

Definition at line 263 of file vtkParallelRenderManager.h.

enum vtkParallelRenderManager::Tags

Enumerator
RENDER_RMI_TAG
COMPUTE_VISIBLE_PROP_BOUNDS_RMI_TAG
WIN_INFO_TAG
REN_INFO_TAG
LIGHT_INFO_TAG
REN_ID_TAG
BOUNDS_TAG

Definition at line 360 of file vtkParallelRenderManager.h.

Constructor & Destructor Documentation

vtkParallelRenderManager::vtkParallelRenderManager ( )

protected

vtkParallelRenderManager::~vtkParallelRenderManager ( )

protected

Member Function Documentation

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

static

virtual int vtkParallelRenderManager::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 vtkObject.

Reimplemented in vtkCompositeRenderManager, and vtkImageRenderManager.

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

static

virtual vtkObjectBase* vtkParallelRenderManager::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkCompositeRenderManager, and vtkImageRenderManager.

vtkParallelRenderManager* vtkParallelRenderManager::NewInstance ( ) const

virtual void vtkParallelRenderManager::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

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.

Reimplemented in vtkCompositeRenderManager, and vtkImageRenderManager.

virtual vtkRenderWindow* vtkParallelRenderManager::MakeRenderWindow ( )

virtual

Builds a vtkRenderWindow compatible with this render manager. The user program is responsible for registering the render window with the SetRenderWindow method and calling Delete. It is not advisable to use a parallel render manager with a render window that was not built with this method.

virtual vtkRenderer* vtkParallelRenderManager::MakeRenderer ( )

virtual

Builds a vtkRenderer compatible with this render manager. (Should we also register it?) The user program is responsible for calling Delete. It is not advisable to use a parallel render manager with a renderer that was not built with this method.

virtual vtkRenderWindow* vtkParallelRenderManager::GetRenderWindow ( )

virtual

Set/Get the RenderWindow to use for compositing. We add a start and end observer to the window.

virtual void vtkParallelRenderManager::SetRenderWindow ( vtkRenderWindow * renWin )

virtual

Set/Get the RenderWindow to use for compositing. We add a start and end observer to the window.

virtual vtkMultiProcessController* vtkParallelRenderManager::GetController ( )

virtual

Set/Get the vtkMultiProcessController which will handle communications for the parallel rendering.

virtual void vtkParallelRenderManager::SetController ( vtkMultiProcessController * controller )

virtual

Set/Get the vtkMultiProcessController which will handle communications for the parallel rendering.

virtual void vtkParallelRenderManager::InitializePieces ( )

virtual

This method sets the piece and number of pieces for each actor with a polydata mapper.

virtual void vtkParallelRenderManager::InitializeOffScreen ( )

virtual

Make all rendering windows not viewable set as off screen rendering. To make all renderwindows on screen rendering again, call OffScreenRenderingOff on all the render windows. This class assumes the window on root node is the only one viewable. Subclasses should change this as necessary.

virtual void vtkParallelRenderManager::StartInteractor ( )

virtual

Initializes the RMIs and then, if on root node, starts the interactor on the attached render window. Otherwise, starts processing RMIs. When the interactor returns, it breaks the RMI listening on all other processors.

virtual void vtkParallelRenderManager::StartServices ( )

virtual

If on node other than root, starts serving RMI requests for parallel renders.

virtual void vtkParallelRenderManager::StopServices ( )

virtual

If on root node, stops the RMI processing on all service nodes.

virtual void vtkParallelRenderManager::StartRender ( )

virtual