VTK  9.0.20210916
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSelectionSource Class Reference

Generate selection from given set of ids vtkSelectionSource generates a vtkSelection from a set of (piece id, cell id) pairs. More...

#include <vtkSelectionSource.h>

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

Public Types

typedef vtkSelectionAlgorithm Superclass
 
- Public Types inherited from vtkSelectionAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkSelectionSourceNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void AddLocation (double x, double y, double z)
 Add a point in world space to probe at. More...
 
void AddThreshold (double min, double max)
 Add a value range to threshold within. More...
 
void SetFrustum (double *vertices)
 Set a frustum to choose within. More...
 
void AddBlock (vtkIdType blockno)
 Add the flat-index/composite index for a block. More...
 
void RemoveAllThresholds ()
 Remove all thresholds added with AddThreshold. More...
 
void RemoveAllLocations ()
 Remove all locations added with AddLocation. More...
 
void RemoveAllBlocks ()
 Remove all blocks added with AddBlock. More...
 
void AddID (vtkIdType piece, vtkIdType id)
 Add a (piece, id) to the selection set. More...
 
void AddStringID (vtkIdType piece, const char *id)
 Add a (piece, id) to the selection set. More...
 
void AddBlockSelector (const char *selector)
 Add/Remove block-selectors to make selections with vtkSelectionNode::BLOCK_SELECTORS as the content-type. More...
 
void RemoveAllBlockSelectors ()
 Add/Remove block-selectors to make selections with vtkSelectionNode::BLOCK_SELECTORS as the content-type. More...
 
void RemoveAllIDs ()
 Removes all IDs. More...
 
void RemoveAllStringIDs ()
 Removes all IDs. More...
 
virtual void SetContentType (int)
 Set the content type for the generated selection. More...
 
virtual int GetContentType ()
 Set the content type for the generated selection. More...
 
virtual void SetFieldType (int)
 Set the field type for the generated selection. More...
 
virtual int GetFieldType ()
 Set the field type for the generated selection. More...
 
virtual void SetContainingCells (int)
 When extracting by points, extract the cells that contain the passing points. More...
 
virtual int GetContainingCells ()
 When extracting by points, extract the cells that contain the passing points. More...
 
virtual void SetNumberOfLayers (int)
 Specify number of layers to extract connected to the selected elements. More...
 
virtual int GetNumberOfLayers ()
 Specify number of layers to extract connected to the selected elements. More...
 
virtual void SetInverse (int)
 Determines whether the selection describes what to include or exclude. More...
 
virtual int GetInverse ()
 Determines whether the selection describes what to include or exclude. More...
 
virtual void SetArrayName (const char *)
 Get/Set the name used for the SelectionList in the generated vtkSelectionNode. More...
 
virtual char * GetArrayName ()
 Get/Set the name used for the SelectionList in the generated vtkSelectionNode. More...
 
virtual void SetArrayComponent (int)
 Access to the component number for the array specified by ArrayName. More...
 
virtual int GetArrayComponent ()
 Access to the component number for the array specified by ArrayName. More...
 
virtual void SetCompositeIndex (int)
 If CompositeIndex < 0 then COMPOSITE_INDEX() is not added to the output. More...
 
virtual int GetCompositeIndex ()
 If CompositeIndex < 0 then COMPOSITE_INDEX() is not added to the output. More...
 
virtual void SetHierarchicalLevel (int)
 If HierarchicalLevel or HierarchicalIndex < 0 , then HIERARCHICAL_LEVEL() and HIERARCHICAL_INDEX() keys are not added to the output. More...
 
virtual int GetHierarchicalLevel ()
 If HierarchicalLevel or HierarchicalIndex < 0 , then HIERARCHICAL_LEVEL() and HIERARCHICAL_INDEX() keys are not added to the output. More...
 
virtual void SetHierarchicalIndex (int)
 If HierarchicalLevel or HierarchicalIndex < 0 , then HIERARCHICAL_LEVEL() and HIERARCHICAL_INDEX() keys are not added to the output. More...
 
virtual int GetHierarchicalIndex ()
 If HierarchicalLevel or HierarchicalIndex < 0 , then HIERARCHICAL_LEVEL() and HIERARCHICAL_INDEX() keys are not added to the output. More...
 
virtual void SetAssemblyName (const char *)
 For selector-based selection qualification. More...
 
virtual char * GetAssemblyName ()
 For selector-based selection qualification. More...
 
void AddSelector (const char *selector)
 For selector-based selection qualification. More...
 
void RemoveAllSelectors ()
 For selector-based selection qualification. More...
 
virtual void SetQueryString (const char *)
 Set/Get the query expression string. More...
 
virtual char * GetQueryString ()
 Set/Get the query expression string. More...
 
- Public Member Functions inherited from vtkSelectionAlgorithm
vtkSelectionAlgorithmNewInstance () const
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details More...
 
vtkSelectionGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkSelectionGetOutput (int index)
 
void SetInputData (vtkDataObject *obj)
 Assign a data object as input. More...
 
void SetInputData (int index, vtkDataObject *obj)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool 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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkSelectionSourceNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkSelectionSourceSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkSelectionAlgorithm
static vtkSelectionAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkSelectionAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkSelectionSource ()
 
 ~vtkSelectionSource () override
 
int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 This is called by the superclass. More...
 
- Protected Member Functions inherited from vtkSelectionAlgorithm
 vtkSelectionAlgorithm ()
 
 ~vtkSelectionAlgorithm () override
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int ContentType
 
int FieldType
 
int ContainingCells
 
int PreserveTopology
 
int Inverse
 
int CompositeIndex
 
int HierarchicalLevel
 
int HierarchicalIndex
 
char * ArrayName
 
int ArrayComponent
 
char * QueryString
 
int NumberOfLayers
 
char * AssemblyName
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

Generate selection from given set of ids vtkSelectionSource generates a vtkSelection from a set of (piece id, cell id) pairs.

It will only generate the selection values that match UPDATE_PIECE_NUMBER (i.e. piece == UPDATE_PIECE_NUMBER).

User-supplied, application-specific selections (with a ContentType of vtkSelectionNode::USER) are not supported.

Online Examples:

Definition at line 51 of file vtkSelectionSource.h.

Member Typedef Documentation

◆ Superclass

Definition at line 55 of file vtkSelectionSource.h.

Constructor & Destructor Documentation

◆ vtkSelectionSource()

vtkSelectionSource::vtkSelectionSource ( )
protected

◆ ~vtkSelectionSource()

vtkSelectionSource::~vtkSelectionSource ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSelectionSource* vtkSelectionSource::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkSelectionSource::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkSelectionSource::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.

◆ SafeDownCast()

static vtkSelectionSource* vtkSelectionSource::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkSelectionSource::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkSelectionAlgorithm.

◆ NewInstance()

vtkSelectionSource* vtkSelectionSource::NewInstance ( ) const

◆ PrintSelf()

void vtkSelectionSource::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ AddID()

void vtkSelectionSource::AddID ( vtkIdType  piece,
vtkIdType  id 
)

Add a (piece, id) to the selection set.

The source will generate only the ids for which piece == UPDATE_PIECE_NUMBER. If piece == -1, the id applies to all pieces.

◆ AddStringID()

void vtkSelectionSource::AddStringID ( vtkIdType  piece,
const char *  id 
)

Add a (piece, id) to the selection set.

The source will generate only the ids for which piece == UPDATE_PIECE_NUMBER. If piece == -1, the id applies to all pieces.

◆ AddLocation()

void vtkSelectionSource::AddLocation ( double  x,
double  y,
double  z 
)

Add a point in world space to probe at.

◆ AddThreshold()

void vtkSelectionSource::AddThreshold ( double  min,
double  max 
)

Add a value range to threshold within.

◆ SetFrustum()

void vtkSelectionSource::SetFrustum ( double *  vertices)

Set a frustum to choose within.

◆ AddBlock()

void vtkSelectionSource::AddBlock ( vtkIdType  blockno)

Add the flat-index/composite index for a block.

◆ AddBlockSelector()

void vtkSelectionSource::AddBlockSelector ( const char *  selector)

Add/Remove block-selectors to make selections with vtkSelectionNode::BLOCK_SELECTORS as the content-type.

◆ RemoveAllBlockSelectors()

void vtkSelectionSource::RemoveAllBlockSelectors ( )

Add/Remove block-selectors to make selections with vtkSelectionNode::BLOCK_SELECTORS as the content-type.

◆ RemoveAllIDs()

void vtkSelectionSource::RemoveAllIDs ( )

Removes all IDs.

◆ RemoveAllStringIDs()

void vtkSelectionSource::RemoveAllStringIDs ( )

Removes all IDs.

◆ RemoveAllThresholds()

void vtkSelectionSource::RemoveAllThresholds ( )

Remove all thresholds added with AddThreshold.

◆ RemoveAllLocations()

void vtkSelectionSource::RemoveAllLocations ( )

Remove all locations added with AddLocation.

◆ RemoveAllBlocks()

void vtkSelectionSource::RemoveAllBlocks ( )

Remove all blocks added with AddBlock.

◆ SetContentType()

virtual void vtkSelectionSource::SetContentType ( int  )
virtual

Set the content type for the generated selection.

Possible values are as defined by vtkSelection::SelectionContent.

◆ GetContentType()

virtual int vtkSelectionSource::GetContentType ( )
virtual

Set the content type for the generated selection.

Possible values are as defined by vtkSelection::SelectionContent.

◆ SetFieldType()

virtual void vtkSelectionSource::SetFieldType ( int  )
virtual

Set the field type for the generated selection.

Possible values are as defined by vtkSelection::SelectionField.

◆ GetFieldType()

virtual int vtkSelectionSource::GetFieldType ( )
virtual

Set the field type for the generated selection.

Possible values are as defined by vtkSelection::SelectionField.

◆ SetContainingCells()

virtual void vtkSelectionSource::SetContainingCells ( int  )
virtual

When extracting by points, extract the cells that contain the passing points.

◆ GetContainingCells()

virtual int vtkSelectionSource::GetContainingCells ( )
virtual

When extracting by points, extract the cells that contain the passing points.

◆ SetNumberOfLayers()

virtual void vtkSelectionSource::SetNumberOfLayers ( int  )
virtual

Specify number of layers to extract connected to the selected elements.

◆ GetNumberOfLayers()

virtual int vtkSelectionSource::GetNumberOfLayers ( )
virtual

Specify number of layers to extract connected to the selected elements.

◆ SetInverse()

virtual void vtkSelectionSource::SetInverse ( int  )
virtual

Determines whether the selection describes what to include or exclude.

Default is 0, meaning include.

◆ GetInverse()

virtual int vtkSelectionSource::GetInverse ( )
virtual

Determines whether the selection describes what to include or exclude.

Default is 0, meaning include.

◆ SetArrayName()

virtual void vtkSelectionSource::SetArrayName ( const char *  )
virtual

Get/Set the name used for the SelectionList in the generated vtkSelectionNode.

◆ GetArrayName()

virtual char* vtkSelectionSource::GetArrayName ( )
virtual

Get/Set the name used for the SelectionList in the generated vtkSelectionNode.

◆ SetArrayComponent()

virtual void vtkSelectionSource::SetArrayComponent ( int  )
virtual

Access to the component number for the array specified by ArrayName.

Default is component 0. Use -1 for magnitude.

◆ GetArrayComponent()

virtual int vtkSelectionSource::GetArrayComponent ( )
virtual

Access to the component number for the array specified by ArrayName.

Default is component 0. Use -1 for magnitude.

◆ SetCompositeIndex()

virtual void vtkSelectionSource::SetCompositeIndex ( int  )
virtual

If CompositeIndex < 0 then COMPOSITE_INDEX() is not added to the output.

◆ GetCompositeIndex()

virtual int vtkSelectionSource::GetCompositeIndex ( )
virtual

If CompositeIndex < 0 then COMPOSITE_INDEX() is not added to the output.

◆ SetHierarchicalLevel()

virtual void vtkSelectionSource::SetHierarchicalLevel ( int  )
virtual

If HierarchicalLevel or HierarchicalIndex < 0 , then HIERARCHICAL_LEVEL() and HIERARCHICAL_INDEX() keys are not added to the output.

◆ GetHierarchicalLevel()

virtual int vtkSelectionSource::GetHierarchicalLevel ( )
virtual

If HierarchicalLevel or HierarchicalIndex < 0 , then HIERARCHICAL_LEVEL() and HIERARCHICAL_INDEX() keys are not added to the output.

◆ SetHierarchicalIndex()

virtual void vtkSelectionSource::SetHierarchicalIndex ( int  )
virtual

If HierarchicalLevel or HierarchicalIndex < 0 , then HIERARCHICAL_LEVEL() and HIERARCHICAL_INDEX() keys are not added to the output.

◆ GetHierarchicalIndex()

virtual int vtkSelectionSource::GetHierarchicalIndex ( )
virtual

If HierarchicalLevel or HierarchicalIndex < 0 , then HIERARCHICAL_LEVEL() and HIERARCHICAL_INDEX() keys are not added to the output.

◆ SetAssemblyName()

virtual void vtkSelectionSource::SetAssemblyName ( const char *  )
virtual

For selector-based selection qualification.

Note, this should not be confused with block-selectors used to select blocks using selectors. These here are qualifiers i.e. they limit the selected items.

◆ GetAssemblyName()

virtual char* vtkSelectionSource::GetAssemblyName ( )
virtual

For selector-based selection qualification.

Note, this should not be confused with block-selectors used to select blocks using selectors. These here are qualifiers i.e. they limit the selected items.

◆ AddSelector()

void vtkSelectionSource::AddSelector ( const char *  selector)

For selector-based selection qualification.

Note, this should not be confused with block-selectors used to select blocks using selectors. These here are qualifiers i.e. they limit the selected items.

◆ RemoveAllSelectors()

void vtkSelectionSource::RemoveAllSelectors ( )

For selector-based selection qualification.

Note, this should not be confused with block-selectors used to select blocks using selectors. These here are qualifiers i.e. they limit the selected items.

◆ SetQueryString()

virtual void vtkSelectionSource::SetQueryString ( const char *  )
virtual

Set/Get the query expression string.

◆ GetQueryString()

virtual char* vtkSelectionSource::GetQueryString ( )
virtual

Set/Get the query expression string.

◆ RequestInformation()

int vtkSelectionSource::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

Reimplemented from vtkSelectionAlgorithm.

◆ RequestData()

int vtkSelectionSource::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkSelectionAlgorithm.

Member Data Documentation

◆ ContentType

int vtkSelectionSource::ContentType
protected

Definition at line 232 of file vtkSelectionSource.h.

◆ FieldType

int vtkSelectionSource::FieldType
protected

Definition at line 233 of file vtkSelectionSource.h.

◆ ContainingCells

int vtkSelectionSource::ContainingCells
protected

Definition at line 234 of file vtkSelectionSource.h.

◆ PreserveTopology

int vtkSelectionSource::PreserveTopology
protected

Definition at line 235 of file vtkSelectionSource.h.

◆ Inverse

int vtkSelectionSource::Inverse
protected

Definition at line 236 of file vtkSelectionSource.h.

◆ CompositeIndex

int vtkSelectionSource::CompositeIndex
protected

Definition at line 237 of file vtkSelectionSource.h.

◆ HierarchicalLevel

int vtkSelectionSource::HierarchicalLevel
protected

Definition at line 238 of file vtkSelectionSource.h.

◆ HierarchicalIndex

int vtkSelectionSource::HierarchicalIndex
protected

Definition at line 239 of file vtkSelectionSource.h.

◆ ArrayName

char* vtkSelectionSource::ArrayName
protected

Definition at line 240 of file vtkSelectionSource.h.

◆ ArrayComponent

int vtkSelectionSource::ArrayComponent
protected

Definition at line 241 of file vtkSelectionSource.h.

◆ QueryString

char* vtkSelectionSource::QueryString
protected

Definition at line 242 of file vtkSelectionSource.h.

◆ NumberOfLayers

int vtkSelectionSource::NumberOfLayers
protected

Definition at line 243 of file vtkSelectionSource.h.

◆ AssemblyName

char* vtkSelectionSource::AssemblyName
protected

Definition at line 244 of file vtkSelectionSource.h.


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