Utility class to help with selection tasks. More...

#include <vtkSMSelectionHelper.h>

Inheritance diagram for vtkSMSelectionHelper:

Collaboration diagram for vtkSMSelectionHelper:

[legend]

Public Types
enum	CombineOperation { CombineOperation::DEFAULT = 0, CombineOperation::ADDITION = 1, CombineOperation::SUBTRACTION = 2, CombineOperation::TOGGLE = 3 }

typedef vtkSMObject	Superclass

Public Types inherited from vtkSMObject
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

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 vtkSMSelectionHelper *	New ()

static int	IsTypeOf (const char *type)

static vtkSMSelectionHelper *	SafeDownCast (vtkObject *o)

static vtkSMProxy *	NewAppendSelectionsFromSelectionSource (vtkSMSourceProxy *selectionSource)
	Create an append selection proxy from a selection source. More...

static vtkSMProxy *	NewSelectionSourceFromSelection (vtkSMSession session, vtkSelection selection, bool ignore_composite_keys=false)
	Given a selection, returns a proxy for a selection source that has the ids specified by it. More...

static void	NewSelectionSourcesFromSelection (vtkSelection selection, vtkSMProxy view, vtkCollection selSources, vtkCollection selRepresentations)

static vtkSMProxy *	ConvertAppendSelections (int outputType, vtkSMSourceProxy appendSelections, vtkSMSourceProxy dataSource, int dataPort, bool &selectionChanged)
	Given the ContentType for an output vtkSelection, this create a new append selections proxy generating the selection, the input appendSelections is used to fill the default values for created selection source. More...

static vtkSMProxy *	ConvertSelectionSource (int outputType, vtkSMSourceProxy selectionSourceProxy, vtkSMSourceProxy dataSource, int dataPort)
	Given the ContentType for an output vtkSelection, this create a new source proxy generating the selection, the input selectionSourceProxy is used to fill the default values for created selection source. More...


static bool	CombineSelection (vtkSMSourceProxy appendSelections1, vtkSMSourceProxy appendSelections2, CombineOperation operation, bool deepCopy=false)
	Combine appendSelections1 with appendSelections2 using a combine operation and store the result into appendSelections2. More...

static bool	IgnoreSelection (vtkSMSourceProxy appendSelections1, vtkSMSourceProxy appendSelections2, bool deepCopy=false)
	Combine appendSelections1 with appendSelections2 using a combine operation and store the result into appendSelections2. More...

static bool	AddSelection (vtkSMSourceProxy appendSelections1, vtkSMSourceProxy appendSelections2, bool deepCopy=false)
	Combine appendSelections1 with appendSelections2 using a combine operation and store the result into appendSelections2. More...

static bool	SubtractSelection (vtkSMSourceProxy appendSelections1, vtkSMSourceProxy appendSelections2, bool deepCopy=false)
	Combine appendSelections1 with appendSelections2 using a combine operation and store the result into appendSelections2. More...

static bool	ToggleSelection (vtkSMSourceProxy appendSelections1, vtkSMSourceProxy appendSelections2, bool deepCopy=false)
	Combine appendSelections1 with appendSelections2 using a combine operation and store the result into appendSelections2. More...

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

static int	IsTypeOf (const char *type)

static vtkSMObject *	SafeDownCast (vtkObject *o)

static std::string	CreatePrettyLabel (const std::string &name)
	Return a well-formated label using provided name by adding spaces between lower cases and upper cases: More...

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
	vtkSMSelectionHelper ()=default

	~vtkSMSelectionHelper () override=default

Protected Member Functions inherited from vtkSMObject
	vtkSMObject ()

	~vtkSMObject () 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

Utility class to help with selection tasks.

This class contains several static methods that help with the complicated selection task.

Definition at line 24 of file vtkSMSelectionHelper.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMObject vtkSMSelectionHelper::Superclass

Definition at line 28 of file vtkSMSelectionHelper.h.

Member Enumeration Documentation

◆ CombineOperation

enum vtkSMSelectionHelper::CombineOperation

strong

Enumerator
DEFAULT
ADDITION
SUBTRACTION
TOGGLE

Definition at line 36 of file vtkSMSelectionHelper.h.

Constructor & Destructor Documentation

◆ vtkSMSelectionHelper()

vtkSMSelectionHelper::vtkSMSelectionHelper ( )

protecteddefault

◆ ~vtkSMSelectionHelper()

vtkSMSelectionHelper::~vtkSMSelectionHelper ( )

overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkSMSelectionHelper* vtkSMSelectionHelper::New ( )

static

◆ GetClassName()

virtual const char* vtkSMSelectionHelper::GetClassName ( )

virtual

Reimplemented from vtkSMObject.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMObject.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkSMObject.

◆ NewAppendSelectionsFromSelectionSource()

static vtkSMProxy* vtkSMSelectionHelper::NewAppendSelectionsFromSelectionSource ( vtkSMSourceProxy * selectionSource )

static

Create an append selection proxy from a selection source.

◆ CombineSelection()

static bool vtkSMSelectionHelper::CombineSelection	(	vtkSMSourceProxy *	appendSelections1,
		vtkSMSourceProxy *	appendSelections2,
		CombineOperation	operation,
		bool	deepCopy = `false`
	)

static

Combine appendSelections1 with appendSelections2 using a combine operation and store the result into appendSelections2.

appendSelections1 and appendSelections2 can be combined if they have the same fieldType and containing cells qualifiers. The returned value indicates if the selections could/have be combined.

If operation is DEFAULT, appendSelections2 = appendSelections2 if operation is ADDITION, appendSelections2 = appendSelections1 | appendSelections2 if operation is SUBTRACTION, appendSelections2 = appendSelections1 & !appendSelections2 if operation is TOGGLE, appendSelections2 = appendSelections1 ^ appendSelections2

Note: appendSelections2 must have at least one selection source, but appendSelections1 can be empty (but valid).

◆ IgnoreSelection()

static bool vtkSMSelectionHelper::IgnoreSelection	(	vtkSMSourceProxy *	appendSelections1,
		vtkSMSourceProxy *	appendSelections2,
		bool	deepCopy = `false`
	)

inlinestatic

Combine appendSelections1 with appendSelections2 using a combine operation and store the result into appendSelections2.

appendSelections1 and appendSelections2 can be combined if they have the same fieldType and containing cells qualifiers. The returned value indicates if the selections could/have be combined.

If operation is DEFAULT, appendSelections2 = appendSelections2 if operation is ADDITION, appendSelections2 = appendSelections1 | appendSelections2 if operation is SUBTRACTION, appendSelections2 = appendSelections1 & !appendSelections2 if operation is TOGGLE, appendSelections2 = appendSelections1 ^ appendSelections2

Note: appendSelections2 must have at least one selection source, but appendSelections1 can be empty (but valid).

Definition at line 61 of file vtkSMSelectionHelper.h.

◆ AddSelection()

static bool vtkSMSelectionHelper::AddSelection	(	vtkSMSourceProxy *	appendSelections1,
		vtkSMSourceProxy *	appendSelections2,
		bool	deepCopy = `false`
	)

inlinestatic

Combine appendSelections1 with appendSelections2 using a combine operation and store the result into appendSelections2.

appendSelections1 and appendSelections2 can be combined if they have the same fieldType and containing cells qualifiers. The returned value indicates if the selections could/have be combined.

If operation is DEFAULT, appendSelections2 = appendSelections2 if operation is ADDITION, appendSelections2 = appendSelections1 | appendSelections2 if operation is SUBTRACTION, appendSelections2 = appendSelections1 & !appendSelections2 if operation is TOGGLE, appendSelections2 = appendSelections1 ^ appendSelections2

Note: appendSelections2 must have at least one selection source, but appendSelections1 can be empty (but valid).

Definition at line 67 of file vtkSMSelectionHelper.h.

◆ SubtractSelection()

static bool vtkSMSelectionHelper::SubtractSelection	(	vtkSMSourceProxy *	appendSelections1,
		vtkSMSourceProxy *	appendSelections2,
		bool	deepCopy = `false`
	)

inlinestatic

Combine appendSelections1 with appendSelections2 using a combine operation and store the result into appendSelections2.

appendSelections1 and appendSelections2 can be combined if they have the same fieldType and containing cells qualifiers. The returned value indicates if the selections could/have be combined.

If operation is DEFAULT, appendSelections2 = appendSelections2 if operation is ADDITION, appendSelections2 = appendSelections1 | appendSelections2 if operation is SUBTRACTION, appendSelections2 = appendSelections1 & !appendSelections2 if operation is TOGGLE, appendSelections2 = appendSelections1 ^ appendSelections2

Note: appendSelections2 must have at least one selection source, but appendSelections1 can be empty (but valid).

Definition at line 73 of file vtkSMSelectionHelper.h.

◆ ToggleSelection()

static bool vtkSMSelectionHelper::ToggleSelection	(	vtkSMSourceProxy *	appendSelections1,
		vtkSMSourceProxy *	appendSelections2,
		bool	deepCopy = `false`
	)

inlinestatic

Combine appendSelections1 with appendSelections2 using a combine operation and store the result into appendSelections2.

appendSelections1 and appendSelections2 can be combined if they have the same fieldType and containing cells qualifiers. The returned value indicates if the selections could/have be combined.

If operation is DEFAULT, appendSelections2 = appendSelections2 if operation is ADDITION, appendSelections2 = appendSelections1 | appendSelections2 if operation is SUBTRACTION, appendSelections2 = appendSelections1 & !appendSelections2 if operation is TOGGLE, appendSelections2 = appendSelections1 ^ appendSelections2

Note: appendSelections2 must have at least one selection source, but appendSelections1 can be empty (but valid).

Definition at line 79 of file vtkSMSelectionHelper.h.

◆ NewSelectionSourceFromSelection()

static vtkSMProxy* vtkSMSelectionHelper::NewSelectionSourceFromSelection	(	vtkSMSession *	session,
		vtkSelection *	selection,
		bool	ignore_composite_keys = `false`
	)

static

Given a selection, returns a proxy for a selection source that has the ids specified by it.

This source can then be used as input to a vtkExtractSelection filter. CAVEAT: Make sure to specify the connection id for the server on which the selection was performed. This method can only handle 3 types of selection FRUSTUM, INDICES and GLOBALIDS. We can easily change this to handle all other types of selection but that's not required currently and hence we not adding that code.

◆ NewSelectionSourcesFromSelection()

static void vtkSMSelectionHelper::NewSelectionSourcesFromSelection	(	vtkSelection *	selection,
		vtkSMProxy *	view,
		vtkCollection *	selSources,
		vtkCollection *	selRepresentations
	)

static

◆ ConvertAppendSelections()

static vtkSMProxy* vtkSMSelectionHelper::ConvertAppendSelections	(	int	outputType,
		vtkSMSourceProxy *	appendSelections,
		vtkSMSourceProxy *	dataSource,
		int	dataPort,
		bool &	selectionChanged
	)

static

Given the ContentType for an output vtkSelection, this create a new append selections proxy generating the selection, the input appendSelections is used to fill the default values for created selection source.

◆ ConvertSelectionSource()

static vtkSMProxy* vtkSMSelectionHelper::ConvertSelectionSource	(	int	outputType,
		vtkSMSourceProxy *	selectionSourceProxy,
		vtkSMSourceProxy *	dataSource,
		int	dataPort
	)

static

Given the ContentType for an output vtkSelection, this create a new source proxy generating the selection, the input selectionSourceProxy is used to fill the default values for created selection source.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ CombineOperation

Constructor & Destructor Documentation

◆ vtkSMSelectionHelper()

◆ ~vtkSMSelectionHelper()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ NewAppendSelectionsFromSelectionSource()

◆ CombineSelection()

◆ IgnoreSelection()

◆ AddSelection()

◆ SubtractSelection()

◆ ToggleSelection()

◆ NewSelectionSourceFromSelection()

◆ NewSelectionSourcesFromSelection()

◆ ConvertAppendSelections()

◆ ConvertSelectionSource()