ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
vtkSMSelectionHelper Class Reference

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

#include <vtkSMSelectionHelper.h>

Inheritance diagram for vtkSMSelectionHelper:
Inheritance graph
[legend]
Collaboration diagram for vtkSMSelectionHelper:
Collaboration graph
[legend]

Public Types

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)
 
- Public Member Functions inherited from vtkSMObject
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static vtkSMSelectionHelperNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMSelectionHelperSafeDownCast (vtkObject *o)
 
static vtkSMProxyNewSelectionSourceFromSelection (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 vtkSMProxyConvertSelection (int outputType, vtkSMProxy *selectionSourceProxy, vtkSMSourceProxy *dataSource, int outputport)
 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 MergeSelection (vtkSMSourceProxy *output, vtkSMSourceProxy *input, vtkSMSourceProxy *dataSource, int outputport)
 Updates output to be a combination of (input | output) if the two selection sources are mergeable. More...
 
static bool SubtractSelection (vtkSMSourceProxy *output, vtkSMSourceProxy *input, vtkSMSourceProxy *dataSource, int outputport)
 Updates output to be a subtraction of input and output (input - output) if the two selection sources are mergeable. More...
 
static bool ToggleSelection (vtkSMSourceProxy *output, vtkSMSourceProxy *input, vtkSMSourceProxy *dataSource, int outputport)
 Updates output to be a toggle of input and output (input + (input | output ) - (input & output ) ) if the two selection sources are mergeable. More...
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkSMSelectionHelper ()
 
 ~vtkSMSelectionHelper ()
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject ()
 

Static Protected Member Functions

static void ConvertSurfaceSelectionToVolumeSelectionInternal (vtkIdType connectionID, vtkSelection *input, vtkSelection *output, int global_ids)
 

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 36 of file vtkSMSelectionHelper.h.

Member Typedef Documentation

§ Superclass

Definition at line 40 of file vtkSMSelectionHelper.h.

Constructor & Destructor Documentation

§ vtkSMSelectionHelper()

vtkSMSelectionHelper::vtkSMSelectionHelper ( )
inlineprotected

Definition at line 96 of file vtkSMSelectionHelper.h.

§ ~vtkSMSelectionHelper()

vtkSMSelectionHelper::~vtkSMSelectionHelper ( )
inlineprotected

Definition at line 97 of file vtkSMSelectionHelper.h.

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 
)

§ 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

§ ConvertSelection()

static vtkSMProxy* vtkSMSelectionHelper::ConvertSelection ( int  outputType,
vtkSMProxy selectionSourceProxy,
vtkSMSourceProxy dataSource,
int  outputport 
)
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.

§ MergeSelection()

static bool vtkSMSelectionHelper::MergeSelection ( vtkSMSourceProxy output,
vtkSMSourceProxy input,
vtkSMSourceProxy dataSource,
int  outputport 
)
static

Updates output to be a combination of (input | output) if the two selection sources are mergeable.

Returns true if merge successful. dataSource and outputport are needed if a conversion is needed to make the input expandable to the type of the output.

§ SubtractSelection()

static bool vtkSMSelectionHelper::SubtractSelection ( vtkSMSourceProxy output,
vtkSMSourceProxy input,
vtkSMSourceProxy dataSource,
int  outputport 
)
static

Updates output to be a subtraction of input and output (input - output) if the two selection sources are mergeable.

Returns true if the subtraction is successful. dataSource and outputport are needed if a conversion is needed to make the input expandable to the type of the output.

§ ToggleSelection()

static bool vtkSMSelectionHelper::ToggleSelection ( vtkSMSourceProxy output,
vtkSMSourceProxy input,
vtkSMSourceProxy dataSource,
int  outputport 
)
static

Updates output to be a toggle of input and output (input + (input | output ) - (input & output ) ) if the two selection sources are mergeable.

Returns true if the toggling is successful. dataSource and outputport are needed if a conversion is needed to make the input expandable to the type of the output.

§ ConvertSurfaceSelectionToVolumeSelectionInternal()

static void vtkSMSelectionHelper::ConvertSurfaceSelectionToVolumeSelectionInternal ( vtkIdType  connectionID,
vtkSelection *  input,
vtkSelection *  output,
int  global_ids 
)
staticprotected

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