Convert a client-side selection into proxies holding server-side selection sources. More...

#include <vtkPVEncodeSelectionForServer.h>

Inheritance diagram for vtkPVEncodeSelectionForServer:

Collaboration diagram for vtkPVEncodeSelectionForServer:

[legend]

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

virtual bool	ProcessSelection (vtkSelection rawSelection, vtkSMRenderViewProxy viewProxy, bool multipleSelectionsAllowed, vtkCollection selectedRepresentations, vtkCollection selectionSources, int modifier, bool selectBlocks)
	Populate the selection sources given a raw (client-side) selection. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

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)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkPVEncodeSelectionForServer *	New ()

static int	IsTypeOf (const char *type)

static vtkPVEncodeSelectionForServer *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkPVEncodeSelectionForServer ()

	~vtkPVEncodeSelectionForServer () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Convert a client-side selection into proxies holding server-side selection sources.

In ParaView, selection occurs on the client using a framebuffer whose pixel-values have associated prop, cell, and point IDs obtained by compositing images rendered on each server. The selection is then simplified and broadcast to the server(s) where representations are provided access.

By subclassing this object and registering a vtkObjectFactory override, it is possible for applications to get access to the raw selection (with prop IDs and other information) that is created on the client before it is simplified, serialized, and sent to the server.

Definition at line 32 of file vtkPVEncodeSelectionForServer.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkPVEncodeSelectionForServer::Superclass

Definition at line 36 of file vtkPVEncodeSelectionForServer.h.

Constructor & Destructor Documentation

◆ vtkPVEncodeSelectionForServer()

vtkPVEncodeSelectionForServer::vtkPVEncodeSelectionForServer ( )

protected

◆ ~vtkPVEncodeSelectionForServer()

vtkPVEncodeSelectionForServer::~vtkPVEncodeSelectionForServer ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkPVEncodeSelectionForServer* vtkPVEncodeSelectionForServer::New ( )

static

◆ GetClassName()

virtual const char* vtkPVEncodeSelectionForServer::GetClassName ( )

virtual

◆ IsTypeOf()

static int vtkPVEncodeSelectionForServer::IsTypeOf ( const char * type )

static

◆ IsA()

virtual int vtkPVEncodeSelectionForServer::IsA ( const char * type )

virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkPVEncodeSelectionForServer* vtkPVEncodeSelectionForServer::SafeDownCast ( vtkObject * o )

static

◆ PrintSelf()

void vtkPVEncodeSelectionForServer::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Reimplemented from vtkObject.

◆ ProcessSelection()

virtual bool vtkPVEncodeSelectionForServer::ProcessSelection	(	vtkSelection *	rawSelection,
		vtkSMRenderViewProxy *	viewProxy,
		bool	multipleSelectionsAllowed,
		vtkCollection *	selectedRepresentations,
		vtkCollection *	selectionSources,
		int	modifier,
		bool	selectBlocks
	)

virtual

Populate the selection sources given a raw (client-side) selection.

This should return true on success (i.e., when selectionSources is modified) and false on failure.

This method is invoked by vtkSMRenderViewProxy::FetchLastSelection. By default, this method will call vtkShrinkSelection if multiple_selections is false and then use vtkSMSelectionHelper::NewSelectionSourcesFromSelection to create a selection-source object from the selection. Subclasses may override this method and register themselves with the object factory to change the behavior at runtime.

The last 2 arguments are not used by the default implementation but are passed for subclasses;

modifier may be any value in pqView::SelectionModifier but defaults to 0 (which is used when the selection should replace any prior selection).
selectBlocks indicates whether the selected entities themselves or the blocks containing them should be selected.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Views/vtkPVEncodeSelectionForServer.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPVEncodeSelectionForServer()

◆ ~vtkPVEncodeSelectionForServer()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ ProcessSelection()