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

#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 vtkTypeBool 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...
 
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)
 
void SetRenderPass (vtkRenderPass *)
 Get/Set the render pass used to do the actual rendering. More...
 
virtual vtkRenderPassGetRenderPass ()
 
void SetPostProcessingRenderPass (vtkRenderPass *)
 Set/Get the optional post-fetch render pass. More...
 
virtual vtkRenderPassGetPostProcessingRenderPass ()
 
virtual void SetProcessIsServer (bool)
 Set the current process type. More...
 
virtual void ProcessIsServerOn ()
 
virtual void ProcessIsServerOff ()
 
virtual bool GetProcessIsServer ()
 
virtual void SetServerSideRendering (bool)
 Enable/Disable fetching of the image from the server side to the client. More...
 
virtual void ServerSideRenderingOn ()
 
virtual void ServerSideRenderingOff ()
 
virtual bool GetServerSideRendering ()
 
- 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...
 
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 vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkClientServerCompositePassNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkClientServerCompositePassSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkRenderPass
static vtkTypeBool 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 ()
 
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 vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkClientServerCompositePass ()
 
 ~vtkClientServerCompositePass () override
 
- 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, vtkFrameBufferObjectBase *fbo=nullptr)
 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=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 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
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

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.

Definition at line 31 of file vtkClientServerCompositePass.h.

Member Typedef Documentation

◆ Superclass

Definition at line 35 of file vtkClientServerCompositePass.h.

Constructor & Destructor Documentation

◆ vtkClientServerCompositePass()

vtkClientServerCompositePass::vtkClientServerCompositePass ( )
protected

◆ ~vtkClientServerCompositePass()

vtkClientServerCompositePass::~vtkClientServerCompositePass ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkClientServerCompositePass* vtkClientServerCompositePass::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkClientServerCompositePass::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkRenderPass.

◆ NewInstance()

vtkClientServerCompositePass* vtkClientServerCompositePass::NewInstance ( ) const

◆ PrintSelf()

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.

◆ Render()

void vtkClientServerCompositePass::Render ( const vtkRenderState s)
overridevirtual

Perform rendering according to a render state s.

Precondition
s_exists: s!=0

Implements vtkRenderPass.

◆ ReleaseGraphicsResources()

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.

◆ GetController()

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.

◆ SetController()

virtual void vtkClientServerCompositePass::SetController ( vtkMultiProcessController controller)
virtual

◆ SetRenderPass()

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.

◆ GetRenderPass()

virtual vtkRenderPass* vtkClientServerCompositePass::GetRenderPass ( )
virtual

◆ SetPostProcessingRenderPass()

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.

◆ GetPostProcessingRenderPass()

virtual vtkRenderPass* vtkClientServerCompositePass::GetPostProcessingRenderPass ( )
virtual

◆ SetProcessIsServer()

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.

◆ ProcessIsServerOn()

virtual void vtkClientServerCompositePass::ProcessIsServerOn ( )
virtual

◆ ProcessIsServerOff()

virtual void vtkClientServerCompositePass::ProcessIsServerOff ( )
virtual

◆ GetProcessIsServer()

virtual bool vtkClientServerCompositePass::GetProcessIsServer ( )
virtual

◆ SetServerSideRendering()

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.

◆ ServerSideRenderingOn()

virtual void vtkClientServerCompositePass::ServerSideRenderingOn ( )
virtual

◆ ServerSideRenderingOff()

virtual void vtkClientServerCompositePass::ServerSideRenderingOff ( )
virtual

◆ GetServerSideRendering()

virtual bool vtkClientServerCompositePass::GetServerSideRendering ( )
virtual

Member Data Documentation

◆ RenderPass

vtkRenderPass* vtkClientServerCompositePass::RenderPass
protected

Definition at line 112 of file vtkClientServerCompositePass.h.

◆ PostProcessingRenderPass

vtkRenderPass* vtkClientServerCompositePass::PostProcessingRenderPass
protected

Definition at line 113 of file vtkClientServerCompositePass.h.

◆ Controller

vtkMultiProcessController* vtkClientServerCompositePass::Controller
protected

Definition at line 114 of file vtkClientServerCompositePass.h.

◆ ProcessIsServer

bool vtkClientServerCompositePass::ProcessIsServer
protected

Definition at line 116 of file vtkClientServerCompositePass.h.

◆ ServerSideRendering

bool vtkClientServerCompositePass::ServerSideRendering
protected

Definition at line 117 of file vtkClientServerCompositePass.h.


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