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

vtkClientServerCompositePass is a render-pass that can handle client-server image delivery. More...

#include <vtkClientServerCompositePass.h>

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

Public Types

typedef vtkRenderPass Superclass
 
- Public Types inherited from vtkRenderPass
typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkClientServerCompositePassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void Render (const vtkRenderState *s) override
 Perform rendering according to a render state s. More...
 
void ReleaseGraphicsResources (vtkWindow *w) override
 Release graphics resources and ask components to release their own resources. More...
 
virtual vtkMultiProcessControllerGetController ()
 Controller If it is NULL, nothing will be rendered and a warning will be emitted. More...
 
virtual void SetController (vtkMultiProcessController *controller)
 Controller If it is NULL, nothing will be rendered and a warning will be emitted. More...
 
void SetRenderPass (vtkRenderPass *)
 Get/Set the render pass used to do the actual rendering. More...
 
virtual vtkRenderPassGetRenderPass ()
 Get/Set the render pass used to do the actual rendering. More...
 
void SetPostProcessingRenderPass (vtkRenderPass *)
 Set/Get the optional post-fetch render pass. More...
 
virtual vtkRenderPassGetPostProcessingRenderPass ()
 Set/Get the optional post-fetch render pass. More...
 
virtual void SetProcessIsServer (bool)
 Set the current process type. More...
 
virtual void ProcessIsServerOn ()
 Set the current process type. More...
 
virtual void ProcessIsServerOff ()
 Set the current process type. More...
 
virtual bool GetProcessIsServer ()
 Set the current process type. More...
 
virtual void SetServerSideRendering (bool)
 Enable/Disable fetching of the image from the server side to the client. More...
 
virtual void ServerSideRenderingOn ()
 Enable/Disable fetching of the image from the server side to the client. More...
 
virtual void ServerSideRenderingOff ()
 Enable/Disable fetching of the image from the server side to the client. More...
 
virtual bool GetServerSideRendering ()
 Enable/Disable fetching of the image from the server side to the client. More...
 
- Public Member Functions inherited from vtkRenderPass
vtkRenderPassNewInstance () const
 
virtual int GetNumberOfRenderedProps ()
 Number of props rendered at the last Render call. More...
 
- 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...
 
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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- 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 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkClientServerCompositePassNew ()
 
static int IsTypeOf (const char *type)
 
static vtkClientServerCompositePassSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkRenderPass
static int IsTypeOf (const char *type)
 
static vtkRenderPassSafeDownCast (vtkObjectBase *o)
 
- 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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
 
 vtkClientServerCompositePass ()
 
 ~vtkClientServerCompositePass ()
 
- Protected Member Functions inherited from vtkRenderPass
 vtkRenderPass ()
 Default constructor. More...
 
 ~vtkRenderPass () override
 Destructor. More...
 
void UpdateCamera (vtkRenderer *renderer)
 Call UpdateCamera() on Renderer. More...
 
void ClearLights (vtkRenderer *renderer)
 Call ClearLights() on Renderer. More...
 
void UpdateLightGeometry (vtkRenderer *renderer)
 Call UpdateLightGeometry() on Renderer. More...
 
void UpdateLights (vtkRenderer *renderer)
 Call UpdateLights() on Renderer. More...
 
void UpdateGeometry (vtkRenderer *renderer)
 Call UpdateGeometry() on Renderer. More...
 
void SetLastRenderingUsedDepthPeeling (vtkRenderer *renderer, bool value)
 Modify protected member LastRenderingUsedDepthPeeling on Renderer. 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=NULL)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- 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

vtkRenderPassRenderPass
 
vtkRenderPassPostProcessingRenderPass
 
vtkMultiProcessControllerController
 
bool ProcessIsServer
 
bool ServerSideRendering
 
- Protected Attributes inherited from vtkRenderPass
int NumberOfRenderedProps
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

vtkClientServerCompositePass is a render-pass that can handle client-server image delivery.

This is designed to be used in configurations in two-processes configurations.

Tests:
vtkClientServerCompositePass (Tests)

Definition at line 34 of file vtkClientServerCompositePass.h.

Member Typedef Documentation

Definition at line 38 of file vtkClientServerCompositePass.h.

Constructor & Destructor Documentation

vtkClientServerCompositePass::vtkClientServerCompositePass ( )
protected
vtkClientServerCompositePass::~vtkClientServerCompositePass ( )
protected

Member Function Documentation

static vtkClientServerCompositePass* vtkClientServerCompositePass::New ( )
static
static int vtkClientServerCompositePass::IsTypeOf ( const char *  type)
static
virtual int vtkClientServerCompositePass::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 vtkRenderPass.

static vtkClientServerCompositePass* vtkClientServerCompositePass::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkClientServerCompositePass::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkRenderPass.

vtkClientServerCompositePass* vtkClientServerCompositePass::NewInstance ( ) const
void vtkClientServerCompositePass::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 vtkRenderPass.

virtual void vtkClientServerCompositePass::Render ( const vtkRenderState s)
overridevirtual

Perform rendering according to a render state s.

Precondition
s_exists: s!=0

Implements vtkRenderPass.

void vtkClientServerCompositePass::ReleaseGraphicsResources ( vtkWindow w)
overridevirtual

Release graphics resources and ask components to release their own resources.

Precondition
w_exists: w!=0

Reimplemented from vtkRenderPass.

virtual vtkMultiProcessController* vtkClientServerCompositePass::GetController ( )
virtual

Controller If it is NULL, nothing will be rendered and a warning will be emitted.

Initial value is a NULL pointer. This must be set to the socket controller used for communicating between the client and the server.

virtual void vtkClientServerCompositePass::SetController ( vtkMultiProcessController controller)
virtual

Controller If it is NULL, nothing will be rendered and a warning will be emitted.

Initial value is a NULL pointer. This must be set to the socket controller used for communicating between the client and the server.

void vtkClientServerCompositePass::SetRenderPass ( vtkRenderPass )

Get/Set the render pass used to do the actual rendering.

When ServerSideRendering is true, the rendering-pass is called only on the server side.

virtual vtkRenderPass* vtkClientServerCompositePass::GetRenderPass ( )
virtual

Get/Set the render pass used to do the actual rendering.

When ServerSideRendering is true, the rendering-pass is called only on the server side.

void vtkClientServerCompositePass::SetPostProcessingRenderPass ( vtkRenderPass )

Set/Get the optional post-fetch render pass.

On the client-process this is called after the server-side image is fetched (if ServerSideRendering is true). On server-process, this is called after the image rendered by this->RenderPass is delivered to the client (if ServerSideRendering is true). This is optional, so you can set this either on one of the two processes or both or neither.

virtual vtkRenderPass* vtkClientServerCompositePass::GetPostProcessingRenderPass ( )
virtual

Set/Get the optional post-fetch render pass.

On the client-process this is called after the server-side image is fetched (if ServerSideRendering is true). On server-process, this is called after the image rendered by this->RenderPass is delivered to the client (if ServerSideRendering is true). This is optional, so you can set this either on one of the two processes or both or neither.

virtual void vtkClientServerCompositePass::SetProcessIsServer ( bool  )
virtual

Set the current process type.

This is needed since when using the socket communicator there's no easy way of determining which process is the server and which one is the client.

virtual void vtkClientServerCompositePass::ProcessIsServerOn ( )
virtual

Set the current process type.

This is needed since when using the socket communicator there's no easy way of determining which process is the server and which one is the client.

virtual void vtkClientServerCompositePass::ProcessIsServerOff ( )
virtual

Set the current process type.

This is needed since when using the socket communicator there's no easy way of determining which process is the server and which one is the client.

virtual bool vtkClientServerCompositePass::GetProcessIsServer ( )
virtual

Set the current process type.

This is needed since when using the socket communicator there's no easy way of determining which process is the server and which one is the client.

virtual void vtkClientServerCompositePass::SetServerSideRendering ( bool  )
virtual

Enable/Disable fetching of the image from the server side to the client.

If this flag is disabled, then this pass just acts as a "pass-through" pass. This flag must be set to the same value on both the processes.

virtual void vtkClientServerCompositePass::ServerSideRenderingOn ( )
virtual

Enable/Disable fetching of the image from the server side to the client.

If this flag is disabled, then this pass just acts as a "pass-through" pass. This flag must be set to the same value on both the processes.

virtual void vtkClientServerCompositePass::ServerSideRenderingOff ( )
virtual

Enable/Disable fetching of the image from the server side to the client.

If this flag is disabled, then this pass just acts as a "pass-through" pass. This flag must be set to the same value on both the processes.

virtual bool vtkClientServerCompositePass::GetServerSideRendering ( )
virtual

Enable/Disable fetching of the image from the server side to the client.

If this flag is disabled, then this pass just acts as a "pass-through" pass. This flag must be set to the same value on both the processes.

Member Data Documentation

vtkRenderPass* vtkClientServerCompositePass::RenderPass
protected

Definition at line 115 of file vtkClientServerCompositePass.h.

vtkRenderPass* vtkClientServerCompositePass::PostProcessingRenderPass
protected

Definition at line 116 of file vtkClientServerCompositePass.h.

vtkMultiProcessController* vtkClientServerCompositePass::Controller
protected

Definition at line 117 of file vtkClientServerCompositePass.h.

bool vtkClientServerCompositePass::ProcessIsServer
protected

Definition at line 119 of file vtkClientServerCompositePass.h.

bool vtkClientServerCompositePass::ServerSideRendering
protected

Definition at line 120 of file vtkClientServerCompositePass.h.


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