VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkConvertSelection Class Reference

Convert a selection from one type to another. More...

#include <vtkConvertSelection.h>

Inheritance diagram for vtkConvertSelection:
[legend]
Collaboration diagram for vtkConvertSelection:
[legend]

Public Types

typedef vtkSelectionAlgorithm Superclass
 
- Public Types inherited from vtkSelectionAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkConvertSelectionNewInstance () const
 
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 vtkStringArray * GetArrayNames ()
 
void AddArrayName (const char *)
 
void ClearArrayNames ()
 
virtual void SetMatchAnyValues (bool)
 
virtual bool GetMatchAnyValues ()
 
virtual void MatchAnyValuesOn ()
 
virtual void MatchAnyValuesOff ()
 
virtual void SetSelectionExtractor (vtkExtractSelection *)
 
virtual vtkExtractSelectionGetSelectionExtractor ()
 
- Public Member Functions inherited from vtkSelectionAlgorithm
vtkSelectionAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
vtkSelectionGetOutput ()
 
vtkSelectionGetOutput (int index)
 
void SetInputData (vtkDataObject *obj)
 
void SetInputData (int index, vtkDataObject *obj)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
virtual void SetExecutive (vtkExecutive *executive)
 
virtual int ModifyRequest (vtkInformation *request, int when)
 
vtkInformation * GetInputPortInformation (int port)
 
vtkInformation * GetOutputPortInformation (int port)
 
int GetNumberOfInputPorts ()
 
int GetNumberOfOutputPorts ()
 
void UpdateProgress (double amount)
 
vtkInformation * GetInputArrayInformation (int idx)
 
void RemoveAllInputs ()
 
vtkDataObjectGetOutputDataObject (int port)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, int idx)
 
virtual void RemoveAllInputConnections (int port)
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 
vtkExecutiveGetInputExecutive (int port, int index)
 
vtkInformation * GetInputInformation (int port, int index)
 
vtkInformation * GetOutputInformation (int port)
 
virtual void UpdateInformation ()
 
virtual void PropagateUpdateExtent ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
virtual double ComputePriority ()
 
int SetUpdateExtentToWholeExtent (int port)
 
int SetUpdateExtentToWholeExtent ()
 
void SetUpdateExtent (int port, int extent[6])
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
 
virtual vtkInformation * GetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
virtual void SetAbortExecute (int)
 
virtual int GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual void SetProgress (double)
 
virtual double GetProgress ()
 
void SetProgressText (const char *ptext)
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 
vtkDataObjectGetInputDataObject (int port, int connection)
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
vtkInformation * GetInputInformation ()
 
virtual void Update (int port)
 
virtual void Update ()
 
virtual void SetReleaseDataFlag (int)
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
void SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int extent[6])
 
int * GetUpdateExtent ()
 
int * GetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 

Static Public Member Functions

static vtkConvertSelectionNew ()
 
static int IsTypeOf (const char *type)
 
static vtkConvertSelectionSafeDownCast (vtkObjectBase *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)
 
- Static Public Member Functions inherited from vtkSelectionAlgorithm
static vtkSelectionAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSelectionAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
static vtkInformationIntegerKey * INPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKey * INPUT_IS_REPEATABLE ()
 
static
vtkInformationInformationVectorKey * 
INPUT_REQUIRED_FIELDS ()
 
static
vtkInformationStringVectorKey * 
INPUT_REQUIRED_DATA_TYPE ()
 
static
vtkInformationInformationVectorKey * 
INPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKey * INPUT_PORT ()
 
static vtkInformationIntegerKey * INPUT_CONNECTION ()
 
static vtkInformationIntegerKey * PRESERVES_DATASET ()
 
static vtkInformationIntegerKey * PRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKey * PRESERVES_BOUNDS ()
 
static vtkInformationIntegerKey * PRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKey * PRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKey * PRESERVES_RANGES ()
 
static vtkInformationIntegerKey * MANAGES_METAINFORMATION ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 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 Member Functions inherited from vtkSelectionAlgorithm
 vtkSelectionAlgorithm ()
 
 ~vtkSelectionAlgorithm ()
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm ()
 
virtual void SetNumberOfInputPorts (int n)
 
virtual void SetNumberOfOutputPorts (int n)
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 
virtual vtkExecutiveCreateDefaultExecutive ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void SetNumberOfInputConnections (int port, int n)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformation * GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 
void SetInputDataInternal (int port, vtkDataObject *input)
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
virtual void SetErrorCode (unsigned long)
 

Protected Attributes

int OutputType
 
int InputFieldType
 
vtkStringArray * ArrayNames
 
bool MatchAnyValues
 
vtkExtractSelectionSelectionExtractor
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformation * Information
 
double Progress
 
char * ProgressText
 
unsigned long ErrorCode
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey * PORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

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 56 of file vtkConvertSelection.h.

Member Typedef Documentation

Definition at line 60 of file vtkConvertSelection.h.

Constructor & Destructor Documentation

vtkConvertSelection::vtkConvertSelection ( )
protected
vtkConvertSelection::~vtkConvertSelection ( )
protected

Member Function Documentation

static vtkConvertSelection* vtkConvertSelection::New ( )
static
static int vtkConvertSelection::IsTypeOf ( const char *  type)
static
virtual int vtkConvertSelection::IsA ( const char *  type)
virtual

Reimplemented from vtkSelectionAlgorithm.

static vtkConvertSelection* vtkConvertSelection::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkConvertSelection::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkSelectionAlgorithm.

vtkConvertSelection* vtkConvertSelection::NewInstance ( ) const
void vtkConvertSelection::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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.

virtual void vtkConvertSelection::SetSelectionExtractor ( vtkExtractSelection )
virtual

Set/get a selection extractor used in some conversions to obtain IDs.

virtual vtkExtractSelection* vtkConvertSelection::GetSelectionExtractor ( )
virtual

Set/get a selection extractor used in some conversions to obtain IDs.

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 
)
protectedvirtual

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 
)
protectedvirtual

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

int vtkConvertSelection::OutputType
protected

Definition at line 220 of file vtkConvertSelection.h.

int vtkConvertSelection::InputFieldType
protected

Definition at line 221 of file vtkConvertSelection.h.

vtkStringArray* vtkConvertSelection::ArrayNames
protected

Definition at line 222 of file vtkConvertSelection.h.

bool vtkConvertSelection::MatchAnyValues
protected

Definition at line 223 of file vtkConvertSelection.h.

vtkExtractSelection* vtkConvertSelection::SelectionExtractor
protected

Definition at line 224 of file vtkConvertSelection.h.


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