vtkConvertSelection Class Reference

#include <vtkConvertSelection.h>

Inheritance diagram for vtkConvertSelection:

Inheritance graph
[legend]
Collaboration diagram for vtkConvertSelection:

Collaboration graph
[legend]

List of all members.


Detailed Description

Convert a selection from one type to another.

vtkConvertSelection converts an input selection from one type to another in the context of a data object being selected. The first input is the selection, while the second input is the data object that the selection relates to.

See also:
vtkSelection vtkSelectionNode vtkExtractSelection vtkExtractSelectedGraph
Events:
vtkCommand::ProgressEvent
Examples:
vtkConvertSelection (Examples)
Tests:
vtkConvertSelection (Tests)

Definition at line 54 of file vtkConvertSelection.h.


Public Types

typedef vtkSelectionAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void SetDataObjectConnection (vtkAlgorithmOutput *in)
virtual void SetInputFieldType (int)
virtual int GetInputFieldType ()
virtual void SetOutputType (int)
virtual int GetOutputType ()
virtual void SetArrayName (const char *)
virtual const char * GetArrayName ()
virtual void SetArrayNames (vtkStringArray *)
virtual vtkStringArrayGetArrayNames ()
void AddArrayName (const char *)
void ClearArrayNames ()
virtual void SetMatchAnyValues (bool)
virtual bool GetMatchAnyValues ()
virtual void MatchAnyValuesOn ()
virtual void MatchAnyValuesOff ()

Static Public Member Functions

static vtkConvertSelectionNew ()
static int IsTypeOf (const char *type)
static vtkConvertSelectionSafeDownCast (vtkObject *o)
static vtkSelectionToIndexSelection (vtkSelection *input, vtkDataObject *data)
static vtkSelectionToGlobalIdSelection (vtkSelection *input, vtkDataObject *data)
static vtkSelectionToPedigreeIdSelection (vtkSelection *input, vtkDataObject *data)
static vtkSelectionToValueSelection (vtkSelection *input, vtkDataObject *data, const char *arrayName)
static vtkSelectionToValueSelection (vtkSelection *input, vtkDataObject *data, vtkStringArray *arrayNames)
static void GetSelectedItems (vtkSelection *input, vtkDataObject *data, int fieldType, vtkIdTypeArray *indices)
static void GetSelectedVertices (vtkSelection *input, vtkGraph *data, vtkIdTypeArray *indices)
static void GetSelectedEdges (vtkSelection *input, vtkGraph *data, vtkIdTypeArray *indices)
static void GetSelectedPoints (vtkSelection *input, vtkDataSet *data, vtkIdTypeArray *indices)
static void GetSelectedCells (vtkSelection *input, vtkDataSet *data, vtkIdTypeArray *indices)
static void GetSelectedRows (vtkSelection *input, vtkTable *data, vtkIdTypeArray *indices)
static vtkSelectionToSelectionType (vtkSelection *input, vtkDataObject *data, int type, vtkStringArray *arrayNames=0, int inputFieldType=-1)

Protected Member Functions

 vtkConvertSelection ()
 ~vtkConvertSelection ()
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
int Convert (vtkSelection *input, vtkDataObject *data, vtkSelection *output)
int ConvertCompositeDataSet (vtkSelection *input, vtkCompositeDataSet *data, vtkSelection *output)
int ConvertToIndexSelection (vtkSelectionNode *input, vtkDataSet *data, vtkSelectionNode *output)
int SelectTableFromTable (vtkTable *selTable, vtkTable *dataTable, vtkIdTypeArray *indices)
int ConvertToBlockSelection (vtkSelection *input, vtkCompositeDataSet *data, vtkSelection *output)
virtual int FillInputPortInformation (int port, vtkInformation *info)

Protected Attributes

int OutputType
int InputFieldType
vtkStringArrayArrayNames
bool MatchAnyValues

Member Typedef Documentation

Reimplemented from vtkSelectionAlgorithm.

Definition at line 58 of file vtkConvertSelection.h.


Constructor & Destructor Documentation

vtkConvertSelection::vtkConvertSelection (  )  [protected]

vtkConvertSelection::~vtkConvertSelection (  )  [protected]


Member Function Documentation

static vtkConvertSelection* vtkConvertSelection::New (  )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkSelectionAlgorithm.

virtual const char* vtkConvertSelection::GetClassName (  )  [virtual]

Reimplemented from vtkSelectionAlgorithm.

static int vtkConvertSelection::IsTypeOf ( const char *  name  )  [static]

Return 1 if this class type 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 vtkSelectionAlgorithm.

virtual int vtkConvertSelection::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 vtkSelectionAlgorithm.

static vtkConvertSelection* vtkConvertSelection::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkSelectionAlgorithm.

void vtkConvertSelection::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

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 vtkSelectionAlgorithm.

void vtkConvertSelection::SetDataObjectConnection ( vtkAlgorithmOutput in  ) 

A convenience method for setting the second input (i.e. the data object).

virtual void vtkConvertSelection::SetInputFieldType ( int   )  [virtual]

The input field type. If this is set to a number other than -1, ignores the input selection field type and instead assumes that all selection nodes have the field type specified. This should be one of the constants defined in vtkSelectionNode.h. Default is -1.

virtual int vtkConvertSelection::GetInputFieldType (  )  [virtual]

The input field type. If this is set to a number other than -1, ignores the input selection field type and instead assumes that all selection nodes have the field type specified. This should be one of the constants defined in vtkSelectionNode.h. Default is -1.

virtual void vtkConvertSelection::SetOutputType ( int   )  [virtual]

The output selection content type. This should be one of the constants defined in vtkSelectionNode.h.

virtual int vtkConvertSelection::GetOutputType (  )  [virtual]

The output selection content type. This should be one of the constants defined in vtkSelectionNode.h.

virtual void vtkConvertSelection::SetArrayName ( const char *   )  [virtual]

The output array name for value or threshold selections.

virtual const char* vtkConvertSelection::GetArrayName (  )  [virtual]

The output array name for value or threshold selections.

virtual void vtkConvertSelection::SetArrayNames ( vtkStringArray  )  [virtual]

The output array names for value selection.

virtual vtkStringArray* vtkConvertSelection::GetArrayNames (  )  [virtual]

The output array names for value selection.

void vtkConvertSelection::AddArrayName ( const char *   ) 

Convenience methods used by UI

void vtkConvertSelection::ClearArrayNames (  ) 

Convenience methods used by UI

virtual void vtkConvertSelection::SetMatchAnyValues ( bool   )  [virtual]

When on, creates a separate selection node for each array. Defaults to OFF.

virtual bool vtkConvertSelection::GetMatchAnyValues (  )  [virtual]

When on, creates a separate selection node for each array. Defaults to OFF.

virtual void vtkConvertSelection::MatchAnyValuesOn (  )  [virtual]

When on, creates a separate selection node for each array. Defaults to OFF.

virtual void vtkConvertSelection::MatchAnyValuesOff (  )  [virtual]

When on, creates a separate selection node for each array. Defaults to OFF.

static vtkSelection* vtkConvertSelection::ToIndexSelection ( vtkSelection input,
vtkDataObject data 
) [static]

Static methods for easily converting between selection types. NOTE: The returned selection pointer IS reference counted, so be sure to Delete() it when you are done with it.

static vtkSelection* vtkConvertSelection::ToGlobalIdSelection ( vtkSelection input,
vtkDataObject data 
) [static]

Static methods for easily converting between selection types. NOTE: The returned selection pointer IS reference counted, so be sure to Delete() it when you are done with it.

static vtkSelection* vtkConvertSelection::ToPedigreeIdSelection ( vtkSelection input,
vtkDataObject data 
) [static]

Static methods for easily converting between selection types. NOTE: The returned selection pointer IS reference counted, so be sure to Delete() it when you are done with it.

static vtkSelection* vtkConvertSelection::ToValueSelection ( vtkSelection input,
vtkDataObject data,
const char *  arrayName 
) [static]

Static methods for easily converting between selection types. NOTE: The returned selection pointer IS reference counted, so be sure to Delete() it when you are done with it.

static vtkSelection* vtkConvertSelection::ToValueSelection ( vtkSelection input,
vtkDataObject data,
vtkStringArray arrayNames 
) [static]

Static methods for easily converting between selection types. NOTE: The returned selection pointer IS reference counted, so be sure to Delete() it when you are done with it.

static void vtkConvertSelection::GetSelectedItems ( vtkSelection input,
vtkDataObject data,
int  fieldType,
vtkIdTypeArray indices 
) [static]

Static generic method for obtaining selected items from a data object. Other static methods (e.g. GetSelectedVertices) call this one.

static void vtkConvertSelection::GetSelectedVertices ( vtkSelection input,
vtkGraph data,
vtkIdTypeArray indices 
) [static]

Static methods for easily obtaining selected items from a data object. The array argument will be filled with the selected items.

static void vtkConvertSelection::GetSelectedEdges ( vtkSelection input,
vtkGraph data,
vtkIdTypeArray indices 
) [static]

Static methods for easily obtaining selected items from a data object. The array argument will be filled with the selected items.

static void vtkConvertSelection::GetSelectedPoints ( vtkSelection input,
vtkDataSet data,
vtkIdTypeArray indices 
) [static]

Static methods for easily obtaining selected items from a data object. The array argument will be filled with the selected items.

static void vtkConvertSelection::GetSelectedCells ( vtkSelection input,
vtkDataSet data,
vtkIdTypeArray indices 
) [static]

Static methods for easily obtaining selected items from a data object. The array argument will be filled with the selected items.

static void vtkConvertSelection::GetSelectedRows ( vtkSelection input,
vtkTable data,
vtkIdTypeArray indices 
) [static]

Static methods for easily obtaining selected items from a data object. The array argument will be filled with the selected items.

static vtkSelection* vtkConvertSelection::ToSelectionType ( vtkSelection input,
vtkDataObject data,
int  type,
vtkStringArray arrayNames = 0,
int  inputFieldType = -1 
) [static]

A generic static method for converting selection types. The type should be an integer constant defined in vtkSelectionNode.h.

virtual int vtkConvertSelection::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

This is called by the superclass. This is the method you should override.

Reimplemented from vtkSelectionAlgorithm.

int vtkConvertSelection::Convert ( vtkSelection input,
vtkDataObject data,
vtkSelection output 
) [protected]

int vtkConvertSelection::ConvertCompositeDataSet ( vtkSelection input,
vtkCompositeDataSet data,
vtkSelection output 
) [protected]

int vtkConvertSelection::ConvertToIndexSelection ( vtkSelectionNode input,
vtkDataSet data,
vtkSelectionNode output 
) [protected]

int vtkConvertSelection::SelectTableFromTable ( vtkTable selTable,
vtkTable dataTable,
vtkIdTypeArray indices 
) [protected]

int vtkConvertSelection::ConvertToBlockSelection ( vtkSelection input,
vtkCompositeDataSet data,
vtkSelection output 
) [protected]

virtual int vtkConvertSelection::FillInputPortInformation ( int  port,
vtkInformation info 
) [protected, virtual]

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkSelectionAlgorithm.


Member Data Documentation

Definition at line 212 of file vtkConvertSelection.h.

Definition at line 213 of file vtkConvertSelection.h.

Definition at line 214 of file vtkConvertSelection.h.

Definition at line 215 of file vtkConvertSelection.h.


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

Generated on Wed Aug 24 11:32:28 2011 for VTK by  doxygen 1.5.6