vtkClientServerCompositePass Class Reference

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

#include <vtkClientServerCompositePass.h>

Inheritance diagram for vtkClientServerCompositePass:

Collaboration diagram for vtkClientServerCompositePass:

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.
vtkClientServerCompositePass *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	Render (const vtkRenderState *s) override
	Perform rendering according to a render state s.
void	ReleaseGraphicsResources (vtkWindow *w) override
	Release graphics resources and ask components to release their own resources.
virtual vtkMultiProcessController *	GetController ()
	Controller If it is NULL, nothing will be rendered and a warning will be emitted.
virtual void	SetController (vtkMultiProcessController *controller)
	Controller If it is NULL, nothing will be rendered and a warning will be emitted.
void	SetRenderPass (vtkRenderPass *)
	Get/Set the render pass used to do the actual rendering.
virtual vtkRenderPass *	GetRenderPass ()
	Get/Set the render pass used to do the actual rendering.
void	SetPostProcessingRenderPass (vtkRenderPass *)
	Set/Get the optional post-fetch render pass.
virtual vtkRenderPass *	GetPostProcessingRenderPass ()
	Set/Get the optional post-fetch render pass.
virtual void	SetProcessIsServer (bool)
	Set the current process type.
virtual void	ProcessIsServerOn ()
	Set the current process type.
virtual void	ProcessIsServerOff ()
	Set the current process type.
virtual bool	GetProcessIsServer ()
	Set the current process type.
virtual void	SetServerSideRendering (bool)
	Enable/Disable fetching of the image from the server side to the client.
virtual void	ServerSideRenderingOn ()
	Enable/Disable fetching of the image from the server side to the client.
virtual void	ServerSideRenderingOff ()
	Enable/Disable fetching of the image from the server side to the client.
virtual bool	GetServerSideRendering ()
	Enable/Disable fetching of the image from the server side to the client.
Public Member Functions inherited from vtkRenderPass
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkRenderPass *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	Render (const vtkRenderState *s)=0
	Perform rendering according to a render state s.
virtual void	ReleaseGraphicsResources (vtkWindow *w)
	Release graphics resources and ask components to release their own resources.
virtual int	GetNumberOfRenderedProps ()
	Number of props rendered at the last Render call.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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)
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.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
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).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkClientServerCompositePass *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkClientServerCompositePass *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkRenderPass
static vtkTypeBool	IsTypeOf (const char *type)
static vtkRenderPass *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
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).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
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.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkClientServerCompositePass ()
	~vtkClientServerCompositePass () override
Protected Member Functions inherited from vtkRenderPass
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkRenderPass ()
	Default constructor.
	~vtkRenderPass () override
	Destructor.
void	UpdateCamera (vtkRenderer *renderer)
	Call UpdateCamera() on Renderer.
void	ClearLights (vtkRenderer *renderer)
	Call ClearLights() on Renderer.
void	UpdateLightGeometry (vtkRenderer *renderer)
	Call UpdateLightGeometry() on Renderer.
void	UpdateLights (vtkRenderer *renderer)
	Call UpdateLights() on Renderer.
void	UpdateGeometry (vtkRenderer *renderer, vtkFrameBufferObjectBase *fbo=nullptr)
	Call UpdateGeometry() on Renderer.
void	SetLastRenderingUsedDepthPeeling (vtkRenderer *renderer, bool value)
	Modify protected member LastRenderingUsedDepthPeeling on Renderer.
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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkRenderPass *	RenderPass
vtkRenderPass *	PostProcessingRenderPass
vtkMultiProcessController *	Controller
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

typedef vtkRenderPass vtkClientServerCompositePass::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

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.

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

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.

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

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.

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

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.

ProcessIsServerOff()

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.

GetProcessIsServer()

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.

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

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.

ServerSideRenderingOff()

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.

GetServerSideRendering()

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

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:

• Rendering/Parallel/vtkClientServerCompositePass.h