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.

vtkSelectionSource *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	AddLocation (double x, double y, double z)
	Add a point in world space to probe at.

void	AddThreshold (double min, double max)
	Add a value range to threshold within.

void	SetFrustum (double *vertices)
	Set a frustum to choose within.

void	AddBlock (vtkIdType blockno)
	Add the flat-index/composite index for a block.

void	RemoveAllThresholds ()
	Remove all thresholds added with AddThreshold.

void	RemoveAllLocations ()
	Remove all locations added with AddLocation.

void	RemoveAllBlocks ()
	Remove all blocks added with AddBlock.


void	AddID (vtkIdType piece, vtkIdType 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	AddBlockSelector (const char *selector)
	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 ()
	Removes all IDs.

void	RemoveAllStringIDs ()
	Removes all IDs.


virtual void	SetContentType (int)
	Set the content type for the generated selection.

virtual int	GetContentType ()
	Set the content type for the generated selection.


virtual void	SetFieldType (int)
	Set the field type for the generated selection.

virtual int	GetFieldType ()
	Set the field type for the generated selection.


virtual void	SetContainingCells (int)
	When extracting by points, extract the cells that contain the passing points.

virtual int	GetContainingCells ()
	When extracting by points, extract the cells that contain the passing points.


virtual void	SetNumberOfLayers (int)
	Specify number of layers to extract connected to the selected elements.

virtual int	GetNumberOfLayers ()
	Specify number of layers to extract connected to the selected elements.


virtual void	SetInverse (int)
	Determines whether the selection describes what to include or exclude.

virtual int	GetInverse ()
	Determines whether the selection describes what to include or exclude.


virtual void	SetArrayName (const char *)
	Get/Set the name used for the SelectionList in the generated vtkSelectionNode.

virtual char *	GetArrayName ()
	Get/Set the name used for the SelectionList in the generated vtkSelectionNode.


virtual void	SetArrayComponent (int)
	Access to the component number for the array specified by ArrayName.

virtual int	GetArrayComponent ()
	Access to the component number for the array specified by ArrayName.


virtual void	SetCompositeIndex (int)
	If CompositeIndex < 0 then COMPOSITE_INDEX() is not added to the output.

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


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

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

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

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


virtual void	SetAssemblyName (const char *)
	For selector-based selection qualification.

virtual char *	GetAssemblyName ()
	For selector-based selection qualification.

void	AddSelector (const char *selector)
	For selector-based selection qualification.

void	RemoveAllSelectors ()
	For selector-based selection qualification.


virtual void	SetQueryString (const char *)
	Set/Get the query expression string.

virtual char *	GetQueryString ()
	Set/Get the query expression string.

Public Member Functions inherited from vtkSelectionAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkSelectionAlgorithm *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

vtkTypeBool	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	see vtkAlgorithm for details

vtkSelection *	GetOutput ()
	Get the output data object for a port on this algorithm.

vtkSelection *	GetOutput (int index)

void	SetInputData (vtkDataObject *obj)
	Assign a data object as input.

void	SetInputData (int index, vtkDataObject *obj)

Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkAlgorithm *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

int	HasExecutive ()
	Check whether this algorithm has an assigned executive.

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.

virtual vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.

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.

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.

vtkInformation *	GetOutputPortInformation (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	SetProgress (double)
	`SetProgress` is deprecated.

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

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.

void	RemoveAllInputs ()
	Remove all the input data.

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.

vtkDataObject *	GetInputDataObject (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)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.

vtkAlgorithmOutput *	GetOutputPort ()

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.

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0)

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0)

vtkInformation *	GetOutputInformation (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 vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.

void	Register (vtkObjectBase *o) override
	Participate in garbage collection.

void	UnRegister (vtkObjectBase *o) 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 vtkProgressObserver *	GetProgressObserver ()
	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	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (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.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

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 vtkSelectionSource *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkSelectionSource *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkSelectionAlgorithm
static vtkSelectionAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkSelectionAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_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 vtkInformationIntegerKey *	CAN_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 vtkObject *	New ()
	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 vtkObjectBase *	New ()
	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 vtkObjectBase *	NewInstanceInternal () 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
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkSelectionAlgorithm ()

	~vtkSelectionAlgorithm () override

virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
	This is called by the superclass.

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
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAlgorithm ()

	~vtkAlgorithm () override

virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm.

virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm.

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 assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.

virtual vtkExecutive *	CreateDefaultExecutive ()
	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.

vtkDataArray *	GetInputArrayToProcess (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.

vtkDataArray *	GetInputArrayToProcess (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.

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (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.

vtkAbstractArray *	GetInputAbstractArrayToProcess (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.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (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 ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	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
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

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

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 vtkInformationIntegerKey *	PORT_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 vtkExecutive *	DefaultExecutivePrototype

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:

SelectionSource

Definition at line 51 of file vtkSelectionSource.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSelectionAlgorithm vtkSelectionSource::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:

Filters/Sources/vtkSelectionSource.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSelectionSource()

◆ ~vtkSelectionSource()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ AddID()

◆ AddStringID()

◆ AddLocation()

◆ AddThreshold()

◆ SetFrustum()

◆ AddBlock()

◆ AddBlockSelector()

◆ RemoveAllBlockSelectors()

◆ RemoveAllIDs()

◆ RemoveAllStringIDs()

◆ RemoveAllThresholds()

◆ RemoveAllLocations()

◆ RemoveAllBlocks()

◆ SetContentType()

◆ GetContentType()

◆ SetFieldType()

◆ GetFieldType()

◆ SetContainingCells()

◆ GetContainingCells()

◆ SetNumberOfLayers()

◆ GetNumberOfLayers()

◆ SetInverse()

◆ GetInverse()

◆ SetArrayName()

◆ GetArrayName()

◆ SetArrayComponent()

◆ GetArrayComponent()

◆ SetCompositeIndex()

◆ GetCompositeIndex()

◆ SetHierarchicalLevel()

◆ GetHierarchicalLevel()

◆ SetHierarchicalIndex()

◆ GetHierarchicalIndex()

◆ SetAssemblyName()

◆ GetAssemblyName()

◆ AddSelector()

◆ RemoveAllSelectors()

◆ SetQueryString()

◆ GetQueryString()

◆ RequestInformation()

◆ RequestData()

Member Data Documentation

◆ ContentType

◆ FieldType

◆ ContainingCells

◆ PreserveTopology

◆ Inverse

◆ CompositeIndex

◆ HierarchicalLevel

◆ HierarchicalIndex

◆ ArrayName

◆ ArrayComponent

◆ QueryString

◆ NumberOfLayers

◆ AssemblyName