vtkDesktopDeliveryClient Class Reference

An object for remote rendering. More...

#include <vtkDesktopDeliveryClient.h>

List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkDesktopDeliveryClient, vtkParallelRenderManager)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetUseCompositing (int v)
virtual void	SetController (vtkMultiProcessController *controller)
virtual void	SetRenderWindow (vtkRenderWindow *renWin)
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 void	SetReplaceActors (int)
virtual int	GetReplaceActors ()
virtual void	ReplaceActorsOn ()
virtual void	ReplaceActorsOff ()
virtual int	GetRemoteDisplay ()
virtual int	GetSquirt ()
virtual void	SetSquirt (int)
virtual void	SquirtOn ()
virtual void	SquirtOff ()
virtual int	GetSquirtCompressionLevel ()
virtual void	SetSquirtCompressionLevel (int)
Static Public Member Functions
vtkDesktopDeliveryClient *	New ()
Protected Member Functions
	vtkDesktopDeliveryClient ()
	~vtkDesktopDeliveryClient ()
virtual void	PreRenderProcessing ()
virtual void	PostRenderProcessing ()
virtual void	SendWindowInformation ()
void	SquirtDecompress (vtkUnsignedCharArray *in, vtkUnsignedCharArray *out)
Protected Attributes
int	ServerProcessId
int	ReplaceActors
int	RemoteDisplay
double	RemoteImageProcessingTime
double	TransferTime
int	Squirt
int	SquirtCompressionLevel
vtkUnsignedCharArray *	SquirtBuffer
int	UseCompositing
int	ReceivedImageFromServer
vtkCommand *	ReceiveImageCallback

---

Detailed Description

An object for remote rendering.

The two vtkDesktopDelivery objects (vtkDesktopDeliveryClient and vtkDesktopDeliveryServer) work together to enable interactive viewing of remotely rendered data. The client attaches itself to a vtkRenderWindow and, optionally, a vtkRenderWindowInteractor. Whenever a new rendering is requested, the client alerts the server, the server renders a new frame, and ships the image back to the client, which will display the image in the vtkRenderWindow.

Attention:

You should set up the renderers and render window interactor before setting the render window. We set up observers on the renderer, and we have no easy way of knowing when the renderers change.

See also:

vtkDesktopDeliveryServer vtkMultiProcessController vtkRenderWindow vtkRenderWindowInteractor

Definition at line 41 of file vtkDesktopDeliveryClient.h.

---

Constructor & Destructor Documentation

vtkDesktopDeliveryClient::vtkDesktopDeliveryClient (   )  [protected]

vtkDesktopDeliveryClient::~vtkDesktopDeliveryClient (   )  [protected]

---

Member Function Documentation

vtkDesktopDeliveryClient::vtkTypeRevisionMacro (  vtkDesktopDeliveryClient  , vtkParallelRenderManager  )

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

vtkDesktopDeliveryClient* vtkDesktopDeliveryClient::New (   )  [static]

virtual void vtkDesktopDeliveryClient::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 vtkDesktopDeliveryClient::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 vtkDesktopDeliveryClient::SetRenderWindow (  vtkRenderWindow *  renWin  )  [virtual]

virtual void vtkDesktopDeliveryClient::SetReplaceActors (  int   )  [virtual]

If ReplaceActors is set to on (the default), then all the actors of each Renderer attached to the RenderWindow are replaced with a single bounding box. The replacement occurs whenever a camera is reset or the visible prop bounds are calculated. If set to off, the actors are never modified.

virtual int vtkDesktopDeliveryClient::GetReplaceActors (   )  [virtual]

If ReplaceActors is set to on (the default), then all the actors of each Renderer attached to the RenderWindow are replaced with a single bounding box. The replacement occurs whenever a camera is reset or the visible prop bounds are calculated. If set to off, the actors are never modified.

virtual void vtkDesktopDeliveryClient::ReplaceActorsOn (   )  [virtual]

If ReplaceActors is set to on (the default), then all the actors of each Renderer attached to the RenderWindow are replaced with a single bounding box. The replacement occurs whenever a camera is reset or the visible prop bounds are calculated. If set to off, the actors are never modified.

virtual void vtkDesktopDeliveryClient::ReplaceActorsOff (   )  [virtual]

If ReplaceActors is set to on (the default), then all the actors of each Renderer attached to the RenderWindow are replaced with a single bounding box. The replacement occurs whenever a camera is reset or the visible prop bounds are calculated. If set to off, the actors are never modified.

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

virtual int vtkDesktopDeliveryClient::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 vtkDesktopDeliveryClient::GetRemoteImageProcessingTime (   )  [virtual]

virtual double vtkDesktopDeliveryClient::GetTransferTime (   )  [virtual]

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

Definition at line 91 of file vtkDesktopDeliveryClient.h.

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

Definition at line 94 of file vtkDesktopDeliveryClient.h.

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

Definition at line 100 of file vtkDesktopDeliveryClient.h.

virtual int vtkDesktopDeliveryClient::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 vtkDesktopDeliveryClient::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 vtkDesktopDeliveryClient::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 vtkDesktopDeliveryClient::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 vtkDesktopDeliveryClient::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 vtkDesktopDeliveryClient::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 void vtkDesktopDeliveryClient::SetImageReductionFactorForUpdateRate (  double  desiredUpdateRate  )  [virtual]

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

virtual void vtkDesktopDeliveryClient::ReceiveImageFromServer (   )  [virtual]

For internal use.

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

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

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

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

---

Member Data Documentation

int vtkDesktopDeliveryClient::ServerProcessId [protected]

Definition at line 143 of file vtkDesktopDeliveryClient.h.

int vtkDesktopDeliveryClient::ReplaceActors [protected]

Definition at line 145 of file vtkDesktopDeliveryClient.h.

int vtkDesktopDeliveryClient::RemoteDisplay [protected]

Definition at line 148 of file vtkDesktopDeliveryClient.h.

double vtkDesktopDeliveryClient::RemoteImageProcessingTime [protected]

Definition at line 149 of file vtkDesktopDeliveryClient.h.

double vtkDesktopDeliveryClient::TransferTime [protected]

Definition at line 150 of file vtkDesktopDeliveryClient.h.

int vtkDesktopDeliveryClient::Squirt [protected]

Definition at line 155 of file vtkDesktopDeliveryClient.h.

int vtkDesktopDeliveryClient::SquirtCompressionLevel [protected]

Definition at line 156 of file vtkDesktopDeliveryClient.h.

vtkUnsignedCharArray* vtkDesktopDeliveryClient::SquirtBuffer [protected]

Definition at line 157 of file vtkDesktopDeliveryClient.h.

int vtkDesktopDeliveryClient::UseCompositing [protected]

Definition at line 161 of file vtkDesktopDeliveryClient.h.

int vtkDesktopDeliveryClient::ReceivedImageFromServer [protected]

Definition at line 163 of file vtkDesktopDeliveryClient.h.

vtkCommand* vtkDesktopDeliveryClient::ReceiveImageCallback [protected]

Definition at line 164 of file vtkDesktopDeliveryClient.h.

---

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

• Servers/Filters/vtkDesktopDeliveryClient.h

---