VTK  9.2.6
vtkSelectionSource Class Reference

Generate selection from given set of ids. 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.
vtkSelectionSourceNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
virtual void RemoveAllNodes ()
 Remove all selection nodes.
virtual void SetElementType (int)
 Set/Get which types of elements are being selected.
virtual int GetElementType ()
virtual void SetProcessID (int)
 Set/Get which process to limit the selection to.
virtual int GetProcessID ()
void SetNodeName (unsigned int nodeId, const char *name)
 Set/Get the node name.
void SetNodeName (const char *name)
const char * GetNodeName (unsigned int nodeId)
const char * GetNodeName ()
void SetNumberOfNodes (unsigned int numberOfNodes)
 Set/Get the number of nodes that will be created for the generated selection.
unsigned int GetNumberOfNodes ()
 Set/Get the number of nodes that will be created for the generated selection.
void RemoveNode (unsigned int idx)
 Remove a selection node.
void RemoveNode (const char *name)
 Remove a selection node.
 vtkSetStdStringFromCharMacro (Expression)
 Set/Get the expression that defines the boolean expression to combine the selection nodes.
 vtkGetCharFromStdStringMacro (Expression)
 Set/Get the expression that defines the boolean expression to combine the selection nodes.
virtual void SetFieldType (int)
 Set/Get the field type for the generated selection.
virtual int GetFieldType ()
 Set/Get the field type for the generated selection.
void AddID (unsigned int nodeId, vtkIdType piece, vtkIdType id)
 Add a (piece, id) to the selection set.
void AddID (vtkIdType piece, vtkIdType id)
 Add a (piece, id) to the selection set.
void AddStringID (unsigned int nodeId, vtkIdType piece, const char *id)
 Add a (piece, id) to the selection set.
void AddStringID (vtkIdType piece, const char *id)
 Add a (piece, id) to the selection set.
void AddLocation (unsigned int nodeId, double x, double y, double z)
 Add a point in world space to probe at.
void AddLocation (double x, double y, double z)
 Add a point in world space to probe at.
void AddThreshold (unsigned int nodeId, double min, double max)
 Add a value range to threshold within.
void AddThreshold (double min, double max)
 Add a value range to threshold within.
void SetFrustum (unsigned int nodeId, double *vertices)
 Set a frustum to choose within.
void SetFrustum (double *vertices)
 Set a frustum to choose within.
void AddBlock (unsigned int nodeId, vtkIdType block)
 Add the flat-index/composite index for a block.
void AddBlock (vtkIdType blockno)
 Add the flat-index/composite index for a block.
void AddBlockSelector (unsigned int nodeId, const char *block)
 Add/Remove block-selectors to make selections with vtkSelectionNode::BLOCK_SELECTORS as the content-type.
void AddBlockSelector (const char *selector)
 Add/Remove block-selectors to make selections with vtkSelectionNode::BLOCK_SELECTORS as the content-type.
void RemoveAllBlockSelectors (unsigned int nodeId)
 Add/Remove block-selectors to make selections with vtkSelectionNode::BLOCK_SELECTORS as the content-type.
void RemoveAllBlockSelectors ()
 Add/Remove block-selectors to make selections with vtkSelectionNode::BLOCK_SELECTORS as the content-type.
void RemoveAllIDs (unsigned int nodeId)
 Removes all IDs.
void RemoveAllIDs ()
 Removes all IDs.
void RemoveAllStringIDs (unsigned int nodeId)
 Removes all IDs.
void RemoveAllStringIDs ()
 Removes all IDs.
void RemoveAllThresholds (unsigned int nodeId)
 Remove all thresholds added with AddThreshold.
void RemoveAllThresholds ()
 Remove all thresholds added with AddThreshold.
void RemoveAllLocations (unsigned int nodeId)
 Remove all locations added with AddLocation.
void RemoveAllLocations ()
 Remove all locations added with AddLocation.
void RemoveAllBlocks (unsigned int nodeId)
 Remove all blocks added with AddBlock.
void RemoveAllBlocks ()
 Remove all blocks added with AddBlock.
void SetContentType (unsigned int nodeId, int type)
 Set/Get the content type.
void SetContentType (int contentType)
 Set/Get the content type.
int GetContentTypeMinValue ()
 Set/Get the content type.
int GetContentTypeMaxValue ()
 Set/Get the content type.
int GetContentType (unsigned int nodeId)
 Set/Get the content type.
int GetContentType ()
 Set/Get the content type.
void SetContainingCells (unsigned int nodeId, vtkTypeBool containingCells)
 When extracting by points, extract the cells that contain the passing points.
void SetContainingCells (vtkTypeBool containingCells)
 When extracting by points, extract the cells that contain the passing points.
vtkTypeBool GetContainingCells (unsigned int nodeId)
 When extracting by points, extract the cells that contain the passing points.
vtkTypeBool GetContainingCells ()
 When extracting by points, extract the cells that contain the passing points.
void SetNumberOfLayers (unsigned int nodeId, int numberOfLayers)
 Set/Get the number of layers to extract connected to the selected elements.
void SetNumberOfLayers (int numberOfLayers)
 Set/Get the number of layers to extract connected to the selected elements.
int GetNumberOfLayersMinValue ()
 Set/Get the number of layers to extract connected to the selected elements.
int GetNumberOfLayersMaxValue ()
 Set/Get the number of layers to extract connected to the selected elements.
int GetNumberOfLayers (unsigned int nodeId)
 Set/Get the number of layers to extract connected to the selected elements.
int GetNumberOfLayers ()
 Set/Get the number of layers to extract connected to the selected elements.
void SetInverse (unsigned int nodeId, vtkTypeBool inverse)
 Determines whether the selection describes what to include or exclude.
void SetInverse (vtkTypeBool inverse)
 Determines whether the selection describes what to include or exclude.
vtkTypeBool GetInverse (unsigned int nodeId)
 Determines whether the selection describes what to include or exclude.
vtkTypeBool GetInverse ()
 Determines whether the selection describes what to include or exclude.
void SetArrayName (unsigned int nodeId, const char *name)
 Get/Set the name used for the SelectionList in the generated vtkSelectionNode.
void SetArrayName (const char *name)
 Get/Set the name used for the SelectionList in the generated vtkSelectionNode.
const char * GetArrayName (unsigned int nodeId)
 Get/Set the name used for the SelectionList in the generated vtkSelectionNode.
const char * GetArrayName ()
 Get/Set the name used for the SelectionList in the generated vtkSelectionNode.
void SetArrayComponent (unsigned int nodeId, int component)
 Set/Get the component number for the array specified by ArrayName.
void SetArrayComponent (int component)
 Set/Get the component number for the array specified by ArrayName.
int GetArrayComponent (unsigned int nodeId)
 Set/Get the component number for the array specified by ArrayName.
int GetArrayComponent ()
 Set/Get the component number for the array specified by ArrayName.
void SetCompositeIndex (unsigned int nodeId, int index)
 Set/Get the CompositeIndex.
void SetCompositeIndex (int compositeIndex)
 Set/Get the CompositeIndex.
int GetCompositeIndex (unsigned int nodeId)
 Set/Get the CompositeIndex.
int GetCompositeIndex ()
 Set/Get the CompositeIndex.
void SetHierarchicalLevel (unsigned int nodeId, int level)
 Set/Get the Hierarchical/HierarchicalIndex.
void SetHierarchicalLevel (int level)
 Set/Get the Hierarchical/HierarchicalIndex.
int GetHierarchicalLevel (unsigned int nodeId)
 Set/Get the Hierarchical/HierarchicalIndex.
int GetHierarchicalLevel ()
 Set/Get the Hierarchical/HierarchicalIndex.
void SetHierarchicalIndex (unsigned int nodeId, int index)
 Set/Get the Hierarchical/HierarchicalIndex.
void SetHierarchicalIndex (int index)
 Set/Get the Hierarchical/HierarchicalIndex.
int GetHierarchicalIndex (unsigned int nodeId)
 Set/Get the Hierarchical/HierarchicalIndex.
int GetHierarchicalIndex ()
 Set/Get the Hierarchical/HierarchicalIndex.
void SetAssemblyName (unsigned int nodeId, const char *name)
 For selector-based selection qualification.
void SetAssemblyName (const char *name)
 For selector-based selection qualification.
const char * GetAssemblyName (unsigned int nodeId)
 For selector-based selection qualification.
const char * GetAssemblyName ()
 For selector-based selection qualification.
void AddSelector (unsigned int nodeId, const char *selector)
 For selector-based selection qualification.
void AddSelector (const char *selector)
 For selector-based selection qualification.
void RemoveAllSelectors (unsigned int nodeId)
 For selector-based selection qualification.
void RemoveAllSelectors ()
 For selector-based selection qualification.
void SetQueryString (unsigned int nodeId, const char *queryString)
 Set/Get the query expression string.
void SetQueryString (const char *query)
 Set/Get the query expression string.
const char * GetQueryString (unsigned int nodeId)
 Set/Get the query expression string.
const char * GetQueryString ()
 Set/Get the query expression string.
Public Member Functions inherited from vtkSelectionAlgorithm
vtkSelectionAlgorithmNewInstance () const
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details
vtkSelectionGetOutput ()
 Get the output data object for a port on this algorithm.
vtkSelectionGetOutput (int index)
void SetInputData (vtkDataObject *obj)
 Assign a data object as input.
void SetInputData (int index, vtkDataObject *obj)
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
int HasExecutive ()
 Check whether this algorithm has an assigned executive.
vtkExecutiveGetExecutive ()
 Get this algorithm's executive.
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive.
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped.
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.
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.
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port.
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port.
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm.
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm.
void UpdateProgress (double amount)
 Update the progress of the process object.
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess().
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm.
void RemoveAllInputs ()
 Remove all the input data.
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port.
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection.
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index.
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx.
virtual void RemoveAllInputConnections (int port)
 Removes all input connections.
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index.
virtual void SetInputDataObject (vtkDataObject *data)
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port.
virtual void AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm.
vtkAlgorithmOutputGetOutputPort ()
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port.
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm.
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port.
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair.
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0).
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection.
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0)
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection.
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0)
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port.
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).
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port.
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.
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port.
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.
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date.
virtual void UpdateDataObject ()
 Create output object(s).
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream.
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date.
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm.
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm.
bool UsesGarbageCollector () const override
 Participate in garbage collection.
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object.
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object.
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object.
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object.
virtual double GetProgress ()
 Get the execution progress of a process object.
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state.
virtual char * GetProgressText ()
 Set the current text message associated with the progress state.
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file.
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process.
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process.
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process.
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index.
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index.
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index.
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index.
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date.
virtual void Update ()
 Bring this algorithm's outputs up-to-date.
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports.
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports.
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports.
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports.
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.
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.
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents.
int * GetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents.
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.
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.
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents.
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents.
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents.
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents.
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents.
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents.
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents.
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents.
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void DebugOn ()
 Turn debugging output on.
virtual void DebugOff ()
 Turn debugging output off.
bool GetDebug ()
 Get the value of the debug flag.
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
virtual void Modified ()
 Update the modification time for this object.
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
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)
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
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).
virtual void Delete ()
 Delete a VTK object.
virtual void FastDelete ()
 Delete a reference to this object.
void InitializeObjectBase ()
void Print (ostream &os)
 Print an object to an ostream.
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
int GetReferenceCount ()
 Return the current reference count of this object.
void SetReferenceCount (int)
 Sets the reference count.
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.

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.
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.
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
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.
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
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).
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
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.

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

Protected Attributes

std::string Expression
int FieldTypeOption
int FieldType
int ElementType
int ProcessID
std::vector< std::shared_ptr< NodeInformation > > NodesInfo
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.
Protected Attributes inherited from vtkObject
bool Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
std::string ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
vtkWeakPointerBase ** WeakPointers
enum  FieldTypeOptions { FIELD_TYPE , ELEMENT_TYPE }
 Set/Get FieldTypeOption which is used to specify the selection field type for the selection. More...
virtual void SetFieldTypeOption (int)
 Set/Get FieldTypeOption which is used to specify the selection field type for the selection.
virtual void SetFieldTypeOptionToFieldType ()
 Set/Get FieldTypeOption which is used to specify the selection field type for the selection.
virtual void SetFieldTypeOptionToElementType ()
 Set/Get FieldTypeOption which is used to specify the selection field type for the selection.
virtual int GetFieldTypeOption ()
 Set/Get FieldTypeOption which is used to specify the selection field type for the selection.

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). vtkSelectionSource can generate a vtkSelection with one or many vtkSelectionNodes.

To generate only one vtkSelectionNode, use the functions which don't pass a nodeId to set/get the node information. To generate more than one vtkSelectionNode, use the SetNumberOfNodes/RemoveNode to manipulate the number of nodes, and use the functions that pass the nodeId to set the node information The different nodes can have different contentType per node but the fieldType/elementType is common across all nodes.

To define the relation between the nodes you can use SetExpression. If non-empty, the expression is a boolean expression that defines how the selection nodes present in the selection are to be combined together to form the selection. If no expression is specified and there are multiple selection nodes, then the default expression simply combines all the selection nodes using an or operator.

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

Tests:
vtkSelectionSource (Tests)

Definition at line 55 of file vtkSelectionSource.h.

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ FieldTypeOptions

Set/Get FieldTypeOption which is used to specify the selection field type for the selection.

If FIELD_TYPE is defined, set FieldType using accepted values as defined in vtkSelectionNode::SelectionField.

If ELEMENT_TYPE is defined, set ElementType using accepted values as defined in vtkDataObject::AttributeTypes. Note, vtkDataObject::FIELD and vtkDataObject::POINT_THEN_CELL are not supported. ELEMENT_TYPE will be converted to FIELD_TYPE, internally, since vtkSelectionNode only accepts FIELD_TYPE.

The default is FIELD_TYPE.

Enumerator
FIELD_TYPE 
ELEMENT_TYPE 

Definition at line 116 of file vtkSelectionSource.h.

Constructor & Destructor Documentation

◆ vtkSelectionSource()

vtkSelectionSource::vtkSelectionSource ( )
protected

◆ ~vtkSelectionSource()

vtkSelectionSource::~vtkSelectionSource ( )
overrideprotected

Member Function Documentation

◆ New()

vtkSelectionSource * vtkSelectionSource::New ( )
static

◆ IsTypeOf()

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

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.

◆ SetNumberOfNodes()

void vtkSelectionSource::SetNumberOfNodes ( unsigned int numberOfNodes)

Set/Get the number of nodes that will be created for the generated selection.

The default is 1.

◆ GetNumberOfNodes()

unsigned int vtkSelectionSource::GetNumberOfNodes ( )
inline

Set/Get the number of nodes that will be created for the generated selection.

The default is 1.

Definition at line 69 of file vtkSelectionSource.h.

◆ RemoveNode() [1/2]

void vtkSelectionSource::RemoveNode ( unsigned int idx)

Remove a selection node.

◆ RemoveNode() [2/2]

void vtkSelectionSource::RemoveNode ( const char * name)

Remove a selection node.

◆ RemoveAllNodes()

virtual void vtkSelectionSource::RemoveAllNodes ( )
virtual

Remove all selection nodes.

◆ vtkSetStdStringFromCharMacro()

vtkSelectionSource::vtkSetStdStringFromCharMacro ( Expression )

Set/Get the expression that defines the boolean expression to combine the selection nodes.

Expression consists of node name identifiers, | for boolean-or, '^' for boolean-xor, '&' for boolean and, '!' for boolean not, and parenthesis ( and ). If you want to set the expression, be sure to define the node names. If no expression is specified and there are multiple selection nodes, then the default expression simply combines all the selection nodes using an or operator.

SetExpression does not validate the expression. It will be validated in `internally.

◆ vtkGetCharFromStdStringMacro()

vtkSelectionSource::vtkGetCharFromStdStringMacro ( Expression )

Set/Get the expression that defines the boolean expression to combine the selection nodes.

Expression consists of node name identifiers, | for boolean-or, '^' for boolean-xor, '&' for boolean and, '!' for boolean not, and parenthesis ( and ). If you want to set the expression, be sure to define the node names. If no expression is specified and there are multiple selection nodes, then the default expression simply combines all the selection nodes using an or operator.

SetExpression does not validate the expression. It will be validated in `internally.

◆ SetFieldTypeOption()

virtual void vtkSelectionSource::SetFieldTypeOption ( int )
virtual

Set/Get FieldTypeOption which is used to specify the selection field type for the selection.

If FIELD_TYPE is defined, set FieldType using accepted values as defined in vtkSelectionNode::SelectionField.

If ELEMENT_TYPE is defined, set ElementType using accepted values as defined in vtkDataObject::AttributeTypes. Note, vtkDataObject::FIELD and vtkDataObject::POINT_THEN_CELL are not supported. ELEMENT_TYPE will be converted to FIELD_TYPE, internally, since vtkSelectionNode only accepts FIELD_TYPE.

The default is FIELD_TYPE.

◆ SetFieldTypeOptionToFieldType()

virtual void vtkSelectionSource::SetFieldTypeOptionToFieldType ( )
inlinevirtual

Set/Get FieldTypeOption which is used to specify the selection field type for the selection.

If FIELD_TYPE is defined, set FieldType using accepted values as defined in vtkSelectionNode::SelectionField.

If ELEMENT_TYPE is defined, set ElementType using accepted values as defined in vtkDataObject::AttributeTypes. Note, vtkDataObject::FIELD and vtkDataObject::POINT_THEN_CELL are not supported. ELEMENT_TYPE will be converted to FIELD_TYPE, internally, since vtkSelectionNode only accepts FIELD_TYPE.

The default is FIELD_TYPE.

Definition at line 122 of file vtkSelectionSource.h.

◆ SetFieldTypeOptionToElementType()

virtual void vtkSelectionSource::SetFieldTypeOptionToElementType ( )
inlinevirtual

Set/Get FieldTypeOption which is used to specify the selection field type for the selection.

If FIELD_TYPE is defined, set FieldType using accepted values as defined in vtkSelectionNode::SelectionField.

If ELEMENT_TYPE is defined, set ElementType using accepted values as defined in vtkDataObject::AttributeTypes. Note, vtkDataObject::FIELD and vtkDataObject::POINT_THEN_CELL are not supported. ELEMENT_TYPE will be converted to FIELD_TYPE, internally, since vtkSelectionNode only accepts FIELD_TYPE.

The default is FIELD_TYPE.

Definition at line 123 of file vtkSelectionSource.h.

◆ GetFieldTypeOption()

virtual int vtkSelectionSource::GetFieldTypeOption ( )
virtual

Set/Get FieldTypeOption which is used to specify the selection field type for the selection.

If FIELD_TYPE is defined, set FieldType using accepted values as defined in vtkSelectionNode::SelectionField.

If ELEMENT_TYPE is defined, set ElementType using accepted values as defined in vtkDataObject::AttributeTypes. Note, vtkDataObject::FIELD and vtkDataObject::POINT_THEN_CELL are not supported. ELEMENT_TYPE will be converted to FIELD_TYPE, internally, since vtkSelectionNode only accepts FIELD_TYPE.

The default is FIELD_TYPE.

◆ SetFieldType()

virtual void vtkSelectionSource::SetFieldType ( int )
virtual

Set/Get the field type for the generated selection.

Possible values are as defined by vtkSelectionNode::SelectionField.

The default is vtkSelectionNode::SelectionField::CELL.

◆ GetFieldType()

virtual int vtkSelectionSource::GetFieldType ( )
virtual

Set/Get the field type for the generated selection.

Possible values are as defined by vtkSelectionNode::SelectionField.

The default is vtkSelectionNode::SelectionField::CELL.

◆ SetElementType()

virtual void vtkSelectionSource::SetElementType ( int )
virtual

Set/Get which types of elements are being selected.

Accepted values are defined in vtkDataObject::AttributeTypes. Note, vtkDataObject::FIELD and vtkDataObject::POINT_THEN_CELL are not supported.

The default is vtkDataObject::AttributeTypes::Cell.

◆ GetElementType()

virtual int vtkSelectionSource::GetElementType ( )
virtual

◆ SetProcessID()

virtual void vtkSelectionSource::SetProcessID ( int )
virtual

Set/Get which process to limit the selection to.

-1 is treated as all processes.

The default is -1.

◆ GetProcessID()

virtual int vtkSelectionSource::GetProcessID ( )
virtual

◆ SetNodeName() [1/2]

void vtkSelectionSource::SetNodeName ( unsigned int nodeId,
const char * name )

Set/Get the node name.

If you want to set the Expression, be sure to define the node names.

If the node name is not defined, a default node name is created atomically at each execution of the filter to guarantee uniqueness. GetNodeName() will return a non-empty name only if you have defined it before.

◆ SetNodeName() [2/2]

void vtkSelectionSource::SetNodeName ( const char * name)
inline

Definition at line 178 of file vtkSelectionSource.h.

◆ GetNodeName() [1/2]

const char * vtkSelectionSource::GetNodeName ( unsigned int nodeId)

◆ GetNodeName() [2/2]

const char * vtkSelectionSource::GetNodeName ( )
inline

Definition at line 180 of file vtkSelectionSource.h.

◆ AddID() [1/2]

void vtkSelectionSource::AddID ( unsigned int nodeId,
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.

◆ AddID() [2/2]

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

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.

Definition at line 190 of file vtkSelectionSource.h.

◆ AddStringID() [1/2]

void vtkSelectionSource::AddStringID ( unsigned int nodeId,
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.

◆ AddStringID() [2/2]

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

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.

Definition at line 192 of file vtkSelectionSource.h.

◆ AddLocation() [1/2]

void vtkSelectionSource::AddLocation ( unsigned int nodeId,
double x,
double y,
double z )

Add a point in world space to probe at.

◆ AddLocation() [2/2]

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

Add a point in world space to probe at.

Definition at line 200 of file vtkSelectionSource.h.

◆ AddThreshold() [1/2]

void vtkSelectionSource::AddThreshold ( unsigned int nodeId,
double min,
double max )

Add a value range to threshold within.

◆ AddThreshold() [2/2]

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

Add a value range to threshold within.

Definition at line 208 of file vtkSelectionSource.h.

◆ SetFrustum() [1/2]

void vtkSelectionSource::SetFrustum ( unsigned int nodeId,
double * vertices )

Set a frustum to choose within.

◆ SetFrustum() [2/2]

void vtkSelectionSource::SetFrustum ( double * vertices)
inline

Set a frustum to choose within.

Definition at line 216 of file vtkSelectionSource.h.

◆ AddBlock() [1/2]

void vtkSelectionSource::AddBlock ( unsigned int nodeId,
vtkIdType block )

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

◆ AddBlock() [2/2]

void vtkSelectionSource::AddBlock ( vtkIdType blockno)
inline

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

Definition at line 224 of file vtkSelectionSource.h.

◆ AddBlockSelector() [1/2]

void vtkSelectionSource::AddBlockSelector ( unsigned int nodeId,
const char * block )

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

◆ AddBlockSelector() [2/2]

void vtkSelectionSource::AddBlockSelector ( const char * selector)
inline

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

Definition at line 233 of file vtkSelectionSource.h.

◆ RemoveAllBlockSelectors() [1/2]

void vtkSelectionSource::RemoveAllBlockSelectors ( unsigned int nodeId)

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

◆ RemoveAllBlockSelectors() [2/2]

void vtkSelectionSource::RemoveAllBlockSelectors ( )
inline

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

Definition at line 235 of file vtkSelectionSource.h.

◆ RemoveAllIDs() [1/2]

void vtkSelectionSource::RemoveAllIDs ( unsigned int nodeId)

Removes all IDs.

◆ RemoveAllIDs() [2/2]

void vtkSelectionSource::RemoveAllIDs ( )
inline

Removes all IDs.

Definition at line 243 of file vtkSelectionSource.h.

◆ RemoveAllStringIDs() [1/2]

void vtkSelectionSource::RemoveAllStringIDs ( unsigned int nodeId)

Removes all IDs.

◆ RemoveAllStringIDs() [2/2]

void vtkSelectionSource::RemoveAllStringIDs ( )
inline

Removes all IDs.

Definition at line 245 of file vtkSelectionSource.h.

◆ RemoveAllThresholds() [1/2]

void vtkSelectionSource::RemoveAllThresholds ( unsigned int nodeId)

Remove all thresholds added with AddThreshold.

◆ RemoveAllThresholds() [2/2]

void vtkSelectionSource::RemoveAllThresholds ( )
inline

Remove all thresholds added with AddThreshold.

Definition at line 253 of file vtkSelectionSource.h.

◆ RemoveAllLocations() [1/2]

void vtkSelectionSource::RemoveAllLocations ( unsigned int nodeId)

Remove all locations added with AddLocation.

◆ RemoveAllLocations() [2/2]

void vtkSelectionSource::RemoveAllLocations ( )
inline

Remove all locations added with AddLocation.

Definition at line 261 of file vtkSelectionSource.h.

◆ RemoveAllBlocks() [1/2]

void vtkSelectionSource::RemoveAllBlocks ( unsigned int nodeId)

Remove all blocks added with AddBlock.

◆ RemoveAllBlocks() [2/2]

void vtkSelectionSource::RemoveAllBlocks ( )
inline

Remove all blocks added with AddBlock.

Definition at line 269 of file vtkSelectionSource.h.

◆ SetContentType() [1/2]

void vtkSelectionSource::SetContentType ( unsigned int nodeId,
int type )

Set/Get the content type.

Possible values are as defined by vtkSelectionNode::SelectionContent.

The default is vtkSelectionNode::SelectionContent::INDICES.

◆ SetContentType() [2/2]

void vtkSelectionSource::SetContentType ( int contentType)
inline

Set/Get the content type.

Possible values are as defined by vtkSelectionNode::SelectionContent.

The default is vtkSelectionNode::SelectionContent::INDICES.

Definition at line 281 of file vtkSelectionSource.h.

◆ GetContentTypeMinValue()

int vtkSelectionSource::GetContentTypeMinValue ( )
inline

Set/Get the content type.

Possible values are as defined by vtkSelectionNode::SelectionContent.

The default is vtkSelectionNode::SelectionContent::INDICES.

Definition at line 282 of file vtkSelectionSource.h.

◆ GetContentTypeMaxValue()

int vtkSelectionSource::GetContentTypeMaxValue ( )
inline

Set/Get the content type.

Possible values are as defined by vtkSelectionNode::SelectionContent.

The default is vtkSelectionNode::SelectionContent::INDICES.

Definition at line 283 of file vtkSelectionSource.h.

◆ GetContentType() [1/2]

int vtkSelectionSource::GetContentType ( unsigned int nodeId)

Set/Get the content type.

Possible values are as defined by vtkSelectionNode::SelectionContent.

The default is vtkSelectionNode::SelectionContent::INDICES.

◆ GetContentType() [2/2]

int vtkSelectionSource::GetContentType ( )
inline

Set/Get the content type.

Possible values are as defined by vtkSelectionNode::SelectionContent.

The default is vtkSelectionNode::SelectionContent::INDICES.

Definition at line 285 of file vtkSelectionSource.h.

◆ SetContainingCells() [1/2]

void vtkSelectionSource::SetContainingCells ( unsigned int nodeId,
vtkTypeBool containingCells )

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

The default is false.

◆ SetContainingCells() [2/2]

void vtkSelectionSource::SetContainingCells ( vtkTypeBool containingCells)
inline

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

The default is false.

Definition at line 296 of file vtkSelectionSource.h.

◆ GetContainingCells() [1/2]

vtkTypeBool vtkSelectionSource::GetContainingCells ( unsigned int nodeId)

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

The default is false.

◆ GetContainingCells() [2/2]

vtkTypeBool vtkSelectionSource::GetContainingCells ( )
inline

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

The default is false.

Definition at line 301 of file vtkSelectionSource.h.

◆ SetNumberOfLayers() [1/2]

void vtkSelectionSource::SetNumberOfLayers ( unsigned int nodeId,
int numberOfLayers )

Set/Get the number of layers to extract connected to the selected elements.

The default is 0.

◆ SetNumberOfLayers() [2/2]

void vtkSelectionSource::SetNumberOfLayers ( int numberOfLayers)
inline

Set/Get the number of layers to extract connected to the selected elements.

The default is 0.

Definition at line 311 of file vtkSelectionSource.h.

◆ GetNumberOfLayersMinValue()

int vtkSelectionSource::GetNumberOfLayersMinValue ( )
inline

Set/Get the number of layers to extract connected to the selected elements.

The default is 0.

Definition at line 312 of file vtkSelectionSource.h.

◆ GetNumberOfLayersMaxValue()

int vtkSelectionSource::GetNumberOfLayersMaxValue ( )
inline

Set/Get the number of layers to extract connected to the selected elements.

The default is 0.

Definition at line 313 of file vtkSelectionSource.h.

◆ GetNumberOfLayers() [1/2]

int vtkSelectionSource::GetNumberOfLayers ( unsigned int nodeId)

Set/Get the number of layers to extract connected to the selected elements.

The default is 0.

◆ GetNumberOfLayers() [2/2]

int vtkSelectionSource::GetNumberOfLayers ( )
inline

Set/Get the number of layers to extract connected to the selected elements.

The default is 0.

Definition at line 315 of file vtkSelectionSource.h.

◆ SetInverse() [1/2]

void vtkSelectionSource::SetInverse ( unsigned int nodeId,
vtkTypeBool inverse )

Determines whether the selection describes what to include or exclude.

The Default is 0, meaning include.

◆ SetInverse() [2/2]

void vtkSelectionSource::SetInverse ( vtkTypeBool inverse)
inline

Determines whether the selection describes what to include or exclude.

The Default is 0, meaning include.

Definition at line 325 of file vtkSelectionSource.h.

◆ GetInverse() [1/2]

vtkTypeBool vtkSelectionSource::GetInverse ( unsigned int nodeId)

Determines whether the selection describes what to include or exclude.

The Default is 0, meaning include.

◆ GetInverse() [2/2]

vtkTypeBool vtkSelectionSource::GetInverse ( )
inline

Determines whether the selection describes what to include or exclude.

The Default is 0, meaning include.

Definition at line 327 of file vtkSelectionSource.h.

◆ SetArrayName() [1/2]

void vtkSelectionSource::SetArrayName ( unsigned int nodeId,
const char * name )

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

◆ SetArrayName() [2/2]

void vtkSelectionSource::SetArrayName ( const char * name)
inline

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

Definition at line 336 of file vtkSelectionSource.h.

◆ GetArrayName() [1/2]

const char * vtkSelectionSource::GetArrayName ( unsigned int nodeId)

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

◆ GetArrayName() [2/2]

const char * vtkSelectionSource::GetArrayName ( )
inline

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

Definition at line 338 of file vtkSelectionSource.h.

◆ SetArrayComponent() [1/2]

void vtkSelectionSource::SetArrayComponent ( unsigned int nodeId,
int component )

Set/Get the component number for the array specified by ArrayName.

The default is component 0. Use -1 for magnitude.

◆ SetArrayComponent() [2/2]

void vtkSelectionSource::SetArrayComponent ( int component)
inline

Set/Get the component number for the array specified by ArrayName.

The default is component 0. Use -1 for magnitude.

Definition at line 348 of file vtkSelectionSource.h.

◆ GetArrayComponent() [1/2]

int vtkSelectionSource::GetArrayComponent ( unsigned int nodeId)

Set/Get the component number for the array specified by ArrayName.

The default is component 0. Use -1 for magnitude.

◆ GetArrayComponent() [2/2]

int vtkSelectionSource::GetArrayComponent ( )
inline

Set/Get the component number for the array specified by ArrayName.

The default is component 0. Use -1 for magnitude.

Definition at line 350 of file vtkSelectionSource.h.

◆ SetCompositeIndex() [1/2]

void vtkSelectionSource::SetCompositeIndex ( unsigned int nodeId,
int index )

Set/Get the CompositeIndex.

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

The default is -1.

◆ SetCompositeIndex() [2/2]

void vtkSelectionSource::SetCompositeIndex ( int compositeIndex)
inline

Set/Get the CompositeIndex.

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

The default is -1.

Definition at line 361 of file vtkSelectionSource.h.

◆ GetCompositeIndex() [1/2]

int vtkSelectionSource::GetCompositeIndex ( unsigned int nodeId)

Set/Get the CompositeIndex.

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

The default is -1.

◆ GetCompositeIndex() [2/2]

int vtkSelectionSource::GetCompositeIndex ( )
inline

Set/Get the CompositeIndex.

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

The default is -1.

Definition at line 363 of file vtkSelectionSource.h.

◆ SetHierarchicalLevel() [1/2]

void vtkSelectionSource::SetHierarchicalLevel ( unsigned int nodeId,
int level )

Set/Get the Hierarchical/HierarchicalIndex.

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

The default for both is -1.

◆ SetHierarchicalLevel() [2/2]

void vtkSelectionSource::SetHierarchicalLevel ( int level)
inline

Set/Get the Hierarchical/HierarchicalIndex.

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

The default for both is -1.

Definition at line 375 of file vtkSelectionSource.h.

◆ GetHierarchicalLevel() [1/2]

int vtkSelectionSource::GetHierarchicalLevel ( unsigned int nodeId)

Set/Get the Hierarchical/HierarchicalIndex.

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

The default for both is -1.

◆ GetHierarchicalLevel() [2/2]

int vtkSelectionSource::GetHierarchicalLevel ( )
inline

Set/Get the Hierarchical/HierarchicalIndex.

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

The default for both is -1.

Definition at line 377 of file vtkSelectionSource.h.

◆ SetHierarchicalIndex() [1/2]

void vtkSelectionSource::SetHierarchicalIndex ( unsigned int nodeId,
int index )

Set/Get the Hierarchical/HierarchicalIndex.

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

The default for both is -1.

◆ SetHierarchicalIndex() [2/2]

void vtkSelectionSource::SetHierarchicalIndex ( int index)
inline

Set/Get the Hierarchical/HierarchicalIndex.

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

The default for both is -1.

Definition at line 379 of file vtkSelectionSource.h.

◆ GetHierarchicalIndex() [1/2]

int vtkSelectionSource::GetHierarchicalIndex ( unsigned int nodeId)

Set/Get the Hierarchical/HierarchicalIndex.

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

The default for both is -1.

◆ GetHierarchicalIndex() [2/2]

int vtkSelectionSource::GetHierarchicalIndex ( )
inline

Set/Get the Hierarchical/HierarchicalIndex.

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

The default for both is -1.

Definition at line 381 of file vtkSelectionSource.h.

◆ SetAssemblyName() [1/2]

void vtkSelectionSource::SetAssemblyName ( unsigned int nodeId,
const char * name )

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.

◆ SetAssemblyName() [2/2]

void vtkSelectionSource::SetAssemblyName ( const char * name)
inline

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.

Definition at line 391 of file vtkSelectionSource.h.

◆ GetAssemblyName() [1/2]

const char * vtkSelectionSource::GetAssemblyName ( unsigned int nodeId)

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() [2/2]

const char * vtkSelectionSource::GetAssemblyName ( )
inline

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.

Definition at line 393 of file vtkSelectionSource.h.

◆ AddSelector() [1/2]

void vtkSelectionSource::AddSelector ( unsigned int nodeId,
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.

◆ AddSelector() [2/2]

void vtkSelectionSource::AddSelector ( const char * selector)
inline

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.

Definition at line 395 of file vtkSelectionSource.h.

◆ RemoveAllSelectors() [1/2]

void vtkSelectionSource::RemoveAllSelectors ( unsigned int nodeId)

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() [2/2]

void vtkSelectionSource::RemoveAllSelectors ( )
inline

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.

Definition at line 397 of file vtkSelectionSource.h.

◆ SetQueryString() [1/2]

void vtkSelectionSource::SetQueryString ( unsigned int nodeId,
const char * queryString )

Set/Get the query expression string.

◆ SetQueryString() [2/2]

void vtkSelectionSource::SetQueryString ( const char * query)
inline

Set/Get the query expression string.

Definition at line 405 of file vtkSelectionSource.h.

◆ GetQueryString() [1/2]

const char * vtkSelectionSource::GetQueryString ( unsigned int nodeId)

Set/Get the query expression string.

◆ GetQueryString() [2/2]

const char * vtkSelectionSource::GetQueryString ( )
inline

Set/Get the query expression string.

Definition at line 407 of file vtkSelectionSource.h.

◆ 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

◆ Expression

std::string vtkSelectionSource::Expression
protected

Definition at line 419 of file vtkSelectionSource.h.

◆ FieldTypeOption

int vtkSelectionSource::FieldTypeOption
protected

Definition at line 420 of file vtkSelectionSource.h.

◆ FieldType

int vtkSelectionSource::FieldType
protected

Definition at line 421 of file vtkSelectionSource.h.

◆ ElementType

int vtkSelectionSource::ElementType
protected

Definition at line 422 of file vtkSelectionSource.h.

◆ ProcessID

int vtkSelectionSource::ProcessID
protected

Definition at line 423 of file vtkSelectionSource.h.

◆ NodesInfo

std::vector<std::shared_ptr<NodeInformation> > vtkSelectionSource::NodesInfo
protected

Definition at line 425 of file vtkSelectionSource.h.


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