vtkPVDesktopDeliveryClient Class Reference

An object for remote rendering. More...

#include <vtkPVDesktopDeliveryClient.h>

List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkPVDesktopDeliveryClient, vtkParallelRenderManager)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetUseCompositing (int v)
virtual void	SetController (vtkMultiProcessController *controller)
virtual void	ComputeVisiblePropBounds (vtkRenderer *ren, double bounds[6])
virtual double	GetRemoteImageProcessingTime ()
virtual double	GetTransferTime ()
virtual double	GetRenderTime ()
virtual double	GetImageProcessingTime ()
void	SetSquirtLevel (int l)
virtual void	SetImageReductionFactorForUpdateRate (double desiredUpdateRate)
float	GetZBufferValue (int x, int y)
virtual void	ReceiveImageFromServer ()
virtual int	GetRemoteDisplay ()
virtual int	GetSquirt ()
virtual void	SetSquirt (int)
virtual void	SquirtOn ()
virtual void	SquirtOff ()
virtual int	GetSquirtCompressionLevel ()
virtual void	SetSquirtCompressionLevel (int)
virtual int	GetId ()
virtual void	SetId (int)
virtual int	GetAnnotationLayer ()
virtual void	SetAnnotationLayer (int)
virtual int *	GetWindowPosition ()
virtual void	GetWindowPosition (int &, int &)
virtual void	GetWindowPosition (int[2])
virtual void	SetWindowPosition (int, int)
void	SetWindowPosition (int[2])
virtual int *	GetGUISize ()
virtual void	GetGUISize (int &, int &)
virtual void	GetGUISize (int[2])
virtual void	SetGUISize (int, int)
void	SetGUISize (int[2])
Static Public Member Functions
vtkPVDesktopDeliveryClient *	New ()
Protected Member Functions
	vtkPVDesktopDeliveryClient ()
	~vtkPVDesktopDeliveryClient ()
virtual void	PreRenderProcessing ()
virtual void	PostRenderProcessing ()
virtual void	SendWindowInformation ()
void	SquirtDecompress (vtkUnsignedCharArray *in, vtkUnsignedCharArray *out)
Protected Attributes
int	ServerProcessId
int	RemoteDisplay
double	RemoteImageProcessingTime
double	TransferTime
int	Squirt
int	SquirtCompressionLevel
vtkUnsignedCharArray *	SquirtBuffer
int	UseCompositing
int	Id
int	AnnotationLayer
int	WindowPosition [2]
int	GUISize [2]
int	ReceivedImageFromServer
vtkCommand *	ReceiveImageCallback

---

Detailed Description

An object for remote rendering.

The two vtkPVDesktopDelivery objects (vtkPVDesktopDeliveryClient and vtkPVDesktopDeliveryServer) work together to enable interactive viewing of remotely rendered data. On the client side, there may be multiple render windows arranged in a GUI, each having its own vtkPVDesktopDeliveryClient object attached. The server has a single render window and vtkPVDesktopDeliveryServer. All the vtkPVDesktopDeliveryClient objects connect to a single vtkPVDesktopDeliveryServer object.

On the client side, each render window is assumed to be placed inside a parent GUI window. The layout of the render windows in the GUI window must be given. The following information must be given: a unique identifier for the window, the position of the render window in the parent GUI window, and the size of the parent GUI window. The server will arrange the renderings in its single render window to match the layout given for the parent GUI window on the client side.

See also:

vtkPVDesktopDeliveryServer

Definition at line 48 of file vtkPVDesktopDeliveryClient.h.

---

Constructor & Destructor Documentation

vtkPVDesktopDeliveryClient::vtkPVDesktopDeliveryClient (   )  [protected]

vtkPVDesktopDeliveryClient::~vtkPVDesktopDeliveryClient (   )  [protected]

---

Member Function Documentation

vtkPVDesktopDeliveryClient::vtkTypeRevisionMacro (  vtkPVDesktopDeliveryClient  , vtkParallelRenderManager  )

virtual void vtkPVDesktopDeliveryClient::PrintSelf (  ostream &  os, vtkIndent  indent )  [virtual]

vtkPVDesktopDeliveryClient* vtkPVDesktopDeliveryClient::New (   )  [static]

virtual void vtkPVDesktopDeliveryClient::SetUseCompositing (  int  v  )  [virtual]

Generally, when you turn compositing off, you expect the image in the local render window to remain unchanged. If you are doing remote display, then there is no point in rendering anything on the server side. Thus, if RemoteDisplay is on and UseCompositing is turned off, then ParallelRendering is also turned off altogether. Likewise, ParallelRendering is turned back on when UseCompositing is turned on.

virtual void vtkPVDesktopDeliveryClient::SetController (  vtkMultiProcessController *  controller  )  [virtual]

Set/Get the controller that is attached to a vtkDesktopDeliveryServer. This object will assume that the controller has two processors, and that the controller on the opposite side of the controller has been given to the server object.

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

virtual int vtkPVDesktopDeliveryClient::GetRemoteDisplay (   )  [virtual]

Returns true if remote display is on. If remote display is on, then the RenderWindow will be updated with an image rendered on the client. If not, the RenderWindow keeps the image its Renderers draw. The RemoteDisplay flag is determined by the server. The remote display is specified by the server, so the value may be out of date if an image has not been rendered since the last time the value changed on the server.

virtual double vtkPVDesktopDeliveryClient::GetRemoteImageProcessingTime (   )  [virtual]

virtual double vtkPVDesktopDeliveryClient::GetTransferTime (   )  [virtual]

virtual double vtkPVDesktopDeliveryClient::GetRenderTime (   )  [inline, virtual]

Definition at line 85 of file vtkPVDesktopDeliveryClient.h.

virtual double vtkPVDesktopDeliveryClient::GetImageProcessingTime (   )  [inline, virtual]

Definition at line 88 of file vtkPVDesktopDeliveryClient.h.

void vtkPVDesktopDeliveryClient::SetSquirtLevel (  int  l  )  [inline]

Definition at line 94 of file vtkPVDesktopDeliveryClient.h.

virtual int vtkPVDesktopDeliveryClient::GetSquirt (   )  [virtual]

Enables or disables SQUIRT compression for image delivery. By default, compression is off. Note that this function may be replaced with a more universal image compression at a later date.

virtual void vtkPVDesktopDeliveryClient::SetSquirt (  int   )  [virtual]

Enables or disables SQUIRT compression for image delivery. By default, compression is off. Note that this function may be replaced with a more universal image compression at a later date.

virtual void vtkPVDesktopDeliveryClient::SquirtOn (   )  [virtual]

Enables or disables SQUIRT compression for image delivery. By default, compression is off. Note that this function may be replaced with a more universal image compression at a later date.

virtual void vtkPVDesktopDeliveryClient::SquirtOff (   )  [virtual]

Enables or disables SQUIRT compression for image delivery. By default, compression is off. Note that this function may be replaced with a more universal image compression at a later date.

virtual int vtkPVDesktopDeliveryClient::GetSquirtCompressionLevel (   )  [virtual]

Sets the compression level used by SQUIRT. Higher values result in better compression but lower resolution in the color space (the size of the image is unaffected by this option).

virtual void vtkPVDesktopDeliveryClient::SetSquirtCompressionLevel (  int   )  [virtual]

Sets the compression level used by SQUIRT. Higher values result in better compression but lower resolution in the color space (the size of the image is unaffected by this option).

virtual int vtkPVDesktopDeliveryClient::GetId (   )  [virtual]

The client may have many render windows and associated desktop delivery client objects that all attach to the same desktop delivery server. This id distinguishes them. The ids themselves do not matter so long as they are unique.

virtual void vtkPVDesktopDeliveryClient::SetId (  int   )  [virtual]

The client may have many render windows and associated desktop delivery client objects that all attach to the same desktop delivery server. This id distinguishes them. The ids themselves do not matter so long as they are unique.

virtual int vtkPVDesktopDeliveryClient::GetAnnotationLayer (   )  [virtual]

Any renderer on this layer or higher will be considered annotation an will be drawn on top of any image received from the server. Set to 1 by default.

virtual void vtkPVDesktopDeliveryClient::SetAnnotationLayer (  int   )  [virtual]

Any renderer on this layer or higher will be considered annotation an will be drawn on top of any image received from the server. Set to 1 by default.

virtual int* vtkPVDesktopDeliveryClient::GetWindowPosition (   )  [virtual]

The location of the upper left corner of the render window in the GUI with (0,0) being the upper most left position. Not that this is different than other most VTK positions, which are referenced from the lower left. This coordinate system was picked to correspond to most GUI APIs.

virtual void vtkPVDesktopDeliveryClient::GetWindowPosition (  int &  , int &  )  [virtual]

The location of the upper left corner of the render window in the GUI with (0,0) being the upper most left position. Not that this is different than other most VTK positions, which are referenced from the lower left. This coordinate system was picked to correspond to most GUI APIs.

virtual void vtkPVDesktopDeliveryClient::GetWindowPosition (  int  [2]  )  [virtual]

The location of the upper left corner of the render window in the GUI with (0,0) being the upper most left position. Not that this is different than other most VTK positions, which are referenced from the lower left. This coordinate system was picked to correspond to most GUI APIs.

virtual void vtkPVDesktopDeliveryClient::SetWindowPosition (  int  , int  )  [virtual]

The location of the upper left corner of the render window in the GUI with (0,0) being the upper most left position. Not that this is different than other most VTK positions, which are referenced from the lower left. This coordinate system was picked to correspond to most GUI APIs.

void vtkPVDesktopDeliveryClient::SetWindowPosition (  int  [2]  )

The location of the upper left corner of the render window in the GUI with (0,0) being the upper most left position. Not that this is different than other most VTK positions, which are referenced from the lower left. This coordinate system was picked to correspond to most GUI APIs.

virtual int* vtkPVDesktopDeliveryClient::GetGUISize (   )  [virtual]

The size of the GUI in which the render window is placed. By default, the size is the same as the render window.

virtual void vtkPVDesktopDeliveryClient::GetGUISize (  int &  , int &  )  [virtual]

The size of the GUI in which the render window is placed. By default, the size is the same as the render window.

virtual void vtkPVDesktopDeliveryClient::GetGUISize (  int  [2]  )  [virtual]

The size of the GUI in which the render window is placed. By default, the size is the same as the render window.

virtual void vtkPVDesktopDeliveryClient::SetGUISize (  int  , int  )  [virtual]

The size of the GUI in which the render window is placed. By default, the size is the same as the render window.

void vtkPVDesktopDeliveryClient::SetGUISize (  int  [2]  )

The size of the GUI in which the render window is placed. By default, the size is the same as the render window.

virtual void vtkPVDesktopDeliveryClient::SetImageReductionFactorForUpdateRate (  double  desiredUpdateRate  )  [virtual]

float vtkPVDesktopDeliveryClient::GetZBufferValue (  int  x, int  y )

virtual void vtkPVDesktopDeliveryClient::ReceiveImageFromServer (   )  [virtual]

For internal use.

virtual void vtkPVDesktopDeliveryClient::PreRenderProcessing (   )  [protected, virtual]

virtual void vtkPVDesktopDeliveryClient::PostRenderProcessing (   )  [protected, virtual]

virtual void vtkPVDesktopDeliveryClient::SendWindowInformation (   )  [protected, virtual]

void vtkPVDesktopDeliveryClient::SquirtDecompress (  vtkUnsignedCharArray *  in, vtkUnsignedCharArray *  out )  [protected]

---

Member Data Documentation

int vtkPVDesktopDeliveryClient::ServerProcessId [protected]

Definition at line 171 of file vtkPVDesktopDeliveryClient.h.

int vtkPVDesktopDeliveryClient::RemoteDisplay [protected]

Definition at line 174 of file vtkPVDesktopDeliveryClient.h.

double vtkPVDesktopDeliveryClient::RemoteImageProcessingTime [protected]

Definition at line 175 of file vtkPVDesktopDeliveryClient.h.

double vtkPVDesktopDeliveryClient::TransferTime [protected]

Definition at line 176 of file vtkPVDesktopDeliveryClient.h.

int vtkPVDesktopDeliveryClient::Squirt [protected]

Definition at line 181 of file vtkPVDesktopDeliveryClient.h.

int vtkPVDesktopDeliveryClient::SquirtCompressionLevel [protected]

Definition at line 182 of file vtkPVDesktopDeliveryClient.h.

vtkUnsignedCharArray* vtkPVDesktopDeliveryClient::SquirtBuffer [protected]

Definition at line 183 of file vtkPVDesktopDeliveryClient.h.

int vtkPVDesktopDeliveryClient::UseCompositing [protected]

Definition at line 187 of file vtkPVDesktopDeliveryClient.h.

int vtkPVDesktopDeliveryClient::Id [protected]

Definition at line 189 of file vtkPVDesktopDeliveryClient.h.

int vtkPVDesktopDeliveryClient::AnnotationLayer [protected]

Definition at line 190 of file vtkPVDesktopDeliveryClient.h.

int vtkPVDesktopDeliveryClient::WindowPosition[2] [protected]

Definition at line 192 of file vtkPVDesktopDeliveryClient.h.

int vtkPVDesktopDeliveryClient::GUISize[2] [protected]

Definition at line 193 of file vtkPVDesktopDeliveryClient.h.

int vtkPVDesktopDeliveryClient::ReceivedImageFromServer [protected]

Definition at line 195 of file vtkPVDesktopDeliveryClient.h.

vtkCommand* vtkPVDesktopDeliveryClient::ReceiveImageCallback [protected]

Definition at line 196 of file vtkPVDesktopDeliveryClient.h.

---

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

• Servers/Filters/vtkPVDesktopDeliveryClient.h

---