data object that represents a "selection" in VTK. More...

#include <vtkSelection.h>

Inheritance diagram for vtkSelection:

Collaboration diagram for vtkSelection:

Public Types
typedef vtkDataObject	Superclass

Public Types inherited from vtkDataObject
enum	FieldAssociations { FIELD_ASSOCIATION_POINTS , FIELD_ASSOCIATION_CELLS , FIELD_ASSOCIATION_NONE , FIELD_ASSOCIATION_POINTS_THEN_CELLS , FIELD_ASSOCIATION_VERTICES , FIELD_ASSOCIATION_EDGES , FIELD_ASSOCIATION_ROWS , NUMBER_OF_ASSOCIATIONS }
	Possible values for the FIELD_ASSOCIATION information entry. More...

enum	AttributeTypes { POINT , CELL , FIELD , POINT_THEN_CELL , VERTEX , EDGE , ROW , NUMBER_OF_ATTRIBUTE_TYPES }
	Possible attribute types. More...

enum	FieldOperations { FIELD_OPERATION_PRESERVED , FIELD_OPERATION_REINTERPOLATED , FIELD_OPERATION_MODIFIED , FIELD_OPERATION_REMOVED }
	Possible values for the FIELD_OPERATION information entry. 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.

vtkSelection *	NewInstance () const

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

void	Initialize () override
	Restore data object to initial state,.

int	GetDataObjectType () override
	Returns VTK_SELECTION enumeration value.

unsigned int	GetNumberOfNodes () const
	Returns the number of nodes in this selection.

virtual vtkSelectionNode *	GetNode (unsigned int idx) const
	Returns a node given it's index.

virtual vtkSelectionNode *	GetNode (const std::string &name) const
	Returns a node with the given name, if present, else nullptr is returned.

virtual std::string	AddNode (vtkSelectionNode *)
	Adds a selection node.

virtual void	SetNode (const std::string &name, vtkSelectionNode *)
	Adds a vtkSelectionNode and assigns it the specified name.

virtual std::string	GetNodeNameAtIndex (unsigned int idx) const
	Returns the name for a node at the given index.

virtual void	RemoveAllNodes ()
	Removes all selection nodes.

void	DeepCopy (vtkDataObject *src) override
	Copy selection nodes of the input.

void	ShallowCopy (vtkDataObject *src) override
	Copy selection nodes of the input.

virtual void	Union (vtkSelection *selection)
	Union this selection with the specified selection.

virtual void	Union (vtkSelectionNode *node)
	Union this selection with the specified selection node.

virtual void	Subtract (vtkSelection *selection)
	Remove the nodes from the specified selection from this selection.

virtual void	Subtract (vtkSelectionNode *node)
	Remove the nodes from the specified selection from this selection.

vtkMTimeType	GetMTime () override
	Return the MTime taking into account changes to the properties.

vtkSmartPointer< vtkSignedCharArray >	Evaluate (vtkSignedCharArray const values, unsigned int num_values) const
	Evaluates the expression for each element in the values.

template<typename MapType >
vtkSmartPointer< vtkSignedCharArray >	Evaluate (const MapType &values_map) const
	Convenience method to pass a map of vtkSignedCharArray ptrs (or vtkSmartPointers).


virtual void	RemoveNode (unsigned int idx)
	Removes a selection node.

virtual void	RemoveNode (const std::string &name)
	Removes a selection node.

virtual void	RemoveNode (vtkSelectionNode *)
	Removes a selection node.


virtual void	SetExpression (std::string)
	Get/Set the expression that defines the boolean expression to combine the selection nodes.

virtual std::string	GetExpression ()
	Get/Set the expression that defines the boolean expression to combine the selection nodes.


virtual void	Dump ()
	Dumps the contents of the selection, giving basic information only.

virtual void	Dump (ostream &os)
	Dumps the contents of the selection, giving basic information only.

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

vtkDataObject *	NewInstance () const

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

vtkMTimeType	GetMTime () override
	Data objects are composite objects and need to check each part for MTime.

virtual void	Initialize ()
	Restore data object to initial state,.

void	ReleaseData ()
	Release data back to system to conserve memory resource.

virtual int	GetDataObjectType ()
	Return class name of data type.

vtkMTimeType	GetUpdateTime ()
	Used by Threaded ports to determine if they should initiate an asynchronous update (still in development).

virtual unsigned long	GetActualMemorySize ()
	Return the actual size of the data in kibibytes (1024 bytes).

virtual void	CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
	Copy from the pipeline information to the data object's own information.

virtual void	CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
	Copy information from this data object to the pipeline information.

void	DataHasBeenGenerated ()
	This method is called by the source when it executes to generate data.

virtual void	PrepareForNewData ()
	make the output data ready for new data to be inserted.

virtual int	GetExtentType ()
	The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstructuredGrid.

virtual void	Crop (const int *updateExtent)
	This method crops the data object (if necessary) so that the extent matches the update extent.

virtual vtkDataSetAttributes *	GetAttributes (int type)
	Returns the attributes of the data object of the specified attribute type.

virtual vtkDataArray *	GetGhostArray (int type)
	Returns the ghost arrays of the data object of the specified atribute type.

virtual vtkFieldData *	GetAttributesAsFieldData (int type)
	Returns the attributes of the data object as a vtkFieldData.

virtual int	GetAttributeTypeForArray (vtkAbstractArray *arr)
	Retrieves the attribute type that an array came from.

virtual vtkIdType	GetNumberOfElements (int type)
	Get the number of elements for a specific attribute type (POINT, CELL, etc.).

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this data object.

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

virtual int	GetDataReleased ()
	Get the flag indicating the data has been released.

virtual void	SetFieldData (vtkFieldData *)
	Assign or retrieve a general field data to this data object.

virtual vtkFieldData *	GetFieldData ()
	Assign or retrieve a general field data to this data object.

void	GlobalReleaseDataFlagOn ()
	Turn on/off flag to control whether every object releases its data after being used by a filter.

void	GlobalReleaseDataFlagOff ()
	Turn on/off flag to control whether every object releases its data after being used by a filter.

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 vtkTypeBool	IsTypeOf (const char *type)

static vtkSelection *	SafeDownCast (vtkObjectBase *o)

static vtkSelection *	New ()


static vtkSelection *	GetData (vtkInformation *info)
	Retrieve a vtkSelection stored inside an invormation object.

static vtkSelection *	GetData (vtkInformationVector *v, int i=0)
	Retrieve a vtkSelection stored inside an invormation object.

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDataObject *	SafeDownCast (vtkObjectBase *o)

static vtkInformation *	GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
	Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and attribute (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS)

static vtkInformation *	GetNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)
	Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and name.

static void	RemoveNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)
	Remove the info associated with an array.

static vtkInformation *	SetActiveAttribute (vtkInformation info, int fieldAssociation, const char attributeName, int attributeType)
	Set the named array to be the active field for the specified type (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) and association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS).

static void	SetActiveAttributeInfo (vtkInformation info, int fieldAssociation, int attributeType, const char name, int arrayType, int numComponents, int numTuples)
	Set the name, array type, number of components, and number of tuples within the passed information object for the active attribute of type attributeType (in specified association, FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS).

static void	SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
	Convenience version of previous method for use (primarily) by the Imaging filters.

static const char *	GetAssociationTypeAsString (int associationType)
	Given an integer association type, this static method returns a string type for the attribute (i.e.

static int	GetAssociationTypeFromString (const char *associationName)
	Given a string association name, this static method returns an integer association type for the attribute (i.e.

static vtkInformationStringKey *	DATA_TYPE_NAME ()

static vtkInformationDataObjectKey *	DATA_OBJECT ()

static vtkInformationIntegerKey *	DATA_EXTENT_TYPE ()

static vtkInformationIntegerPointerKey *	DATA_EXTENT ()

static vtkInformationIntegerVectorKey *	ALL_PIECES_EXTENT ()

static vtkInformationIntegerKey *	DATA_PIECE_NUMBER ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_PIECES ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_GHOST_LEVELS ()

static vtkInformationDoubleKey *	DATA_TIME_STEP ()

static vtkInformationInformationVectorKey *	POINT_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	CELL_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	VERTEX_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	EDGE_DATA_VECTOR ()

static vtkInformationIntegerKey *	FIELD_ARRAY_TYPE ()

static vtkInformationIntegerKey *	FIELD_ASSOCIATION ()

static vtkInformationIntegerKey *	FIELD_ATTRIBUTE_TYPE ()

static vtkInformationIntegerKey *	FIELD_ACTIVE_ATTRIBUTE ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_COMPONENTS ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_TUPLES ()

static vtkInformationIntegerKey *	FIELD_OPERATION ()

static vtkInformationDoubleVectorKey *	FIELD_RANGE ()

static vtkInformationIntegerVectorKey *	PIECE_EXTENT ()

static vtkInformationStringKey *	FIELD_NAME ()

static vtkInformationDoubleVectorKey *	ORIGIN ()

static vtkInformationDoubleVectorKey *	SPACING ()

static vtkInformationDoubleVectorKey *	DIRECTION ()

static vtkInformationDoubleVectorKey *	BOUNDING_BOX ()

static vtkInformationDataObjectKey *	SIL ()

static vtkDataObject *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object.

static vtkDataObject *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object.

static void	SetGlobalReleaseDataFlag (int val)
	Turn on/off flag to control whether every object releases its data after being used by a filter.

static int	GetGlobalReleaseDataFlag ()
	Turn on/off flag to control whether every object releases its data after being used by a filter.

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

	vtkSelection ()

	~vtkSelection () override

Protected Member Functions inherited from vtkDataObject
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkDataObject ()

	~vtkDataObject () override

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
std::string	Expression

Protected Attributes inherited from vtkDataObject
vtkFieldData *	FieldData

int	DataReleased

vtkTimeStamp	UpdateTime

vtkInformation *	Information

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
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

data object that represents a "selection" in VTK.

vtkSelection defines a selection. A selection is a data-object that defines which entities from another data-object are to treated as "selected". Filters like vtkExtractSelection or vtkExtractDataArraysOverTime can then be used to extract these selected entities from the other data-object.

vtkSelection comprises of vtkSelectionNodes and optionally, an expression specified using vtkSelection::SetExpression. If non-empty, the expression is a boolean expression that defines now 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.

Each vtkSelectionNode is used to define the selection criteria. vtkSelectionNode API lets one select what kind of entities are being selected (vtkSelectionNode::FieldType) and how they are being selected (vtkSelectionNode::ContentType).

See also: vtkSelectionNode

Online Examples:

ExtractVisibleCells

VectorFieldNonZeroExtraction

SelectedVerticesAndEdges

ExtractSelectionCells

ExtractSelectionOriginalId

VertexConnectivity

Definition at line 162 of file vtkSelection.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataObject vtkSelection::Superclass

Definition at line 165 of file vtkSelection.h.

Constructor & Destructor Documentation

◆ vtkSelection()

vtkSelection::vtkSelection ( )

protected

◆ ~vtkSelection()

vtkSelection::~vtkSelection ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkSelection::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDataObject.

◆ NewInstance()

vtkSelection * vtkSelection::NewInstance ( ) const

◆ PrintSelf()

void vtkSelection::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 vtkDataObject.

◆ New()

static vtkSelection * vtkSelection::New ( )

static

◆ Initialize()

void vtkSelection::Initialize ( )

overridevirtual

Restore data object to initial state,.

Reimplemented from vtkDataObject.

◆ GetDataObjectType()

int vtkSelection::GetDataObjectType ( )

inlineoverridevirtual

Returns VTK_SELECTION enumeration value.

Reimplemented from vtkDataObject.

Definition at line 177 of file vtkSelection.h.

◆ GetNumberOfNodes()

unsigned int vtkSelection::GetNumberOfNodes ( ) const

Returns the number of nodes in this selection.

Each node contains information about part of the selection.

◆ GetNode() [1/2]

virtual vtkSelectionNode * vtkSelection::GetNode ( unsigned int idx ) const

virtual

Returns a node given it's index.

Performs bound checking and will return nullptr if out-of-bounds.

◆ GetNode() [2/2]

virtual vtkSelectionNode * vtkSelection::GetNode ( const std::string & name ) const

virtual

Returns a node with the given name, if present, else nullptr is returned.

◆ AddNode()

virtual std::string vtkSelection::AddNode ( vtkSelectionNode * )

virtual

Adds a selection node.

Assigns the node a unique name and returns that name. This API is primarily provided for backwards compatibility and SetNode is the preferred method.

◆ SetNode()

virtual void vtkSelection::SetNode	(	const std::string &	name,
		vtkSelectionNode *
	)

virtual

Adds a vtkSelectionNode and assigns it the specified name.

The name must be a non-empty string. If an item with the same name has already been added, it will be removed.

◆ GetNodeNameAtIndex()

virtual std::string vtkSelection::GetNodeNameAtIndex ( unsigned int idx ) const

virtual

Returns the name for a node at the given index.

◆ RemoveNode() [1/3]

virtual void vtkSelection::RemoveNode ( unsigned int idx )

virtual

Removes a selection node.

◆ RemoveNode() [2/3]

virtual void vtkSelection::RemoveNode ( const std::string & name )

virtual

Removes a selection node.

◆ RemoveNode() [3/3]

virtual void vtkSelection::RemoveNode ( vtkSelectionNode * )

virtual

Removes a selection node.

◆ RemoveAllNodes()

virtual void vtkSelection::RemoveAllNodes ( )

virtual

Removes all selection nodes.

◆ SetExpression()

virtual void vtkSelection::SetExpression ( std::string )

virtual

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

Expression consists of node name identifiers, | for boolean-or, '&' for boolean and, '!' for boolean not, and parenthesis ( and ). If the expression consists of a node name identifier that is not assigned any vtkSelectionNode (using SetNode) then it is evaluates to false.

SetExpression does not validate the expression. It will be validated in Evaluate call.

◆ GetExpression()

virtual std::string vtkSelection::GetExpression ( )

virtual

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

Expression consists of node name identifiers, | for boolean-or, '&' for boolean and, '!' for boolean not, and parenthesis ( and ). If the expression consists of a node name identifier that is not assigned any vtkSelectionNode (using SetNode) then it is evaluates to false.

SetExpression does not validate the expression. It will be validated in Evaluate call.

◆ DeepCopy()

void vtkSelection::DeepCopy ( vtkDataObject * src )

overridevirtual

Copy selection nodes of the input.

Reimplemented from vtkDataObject.

◆ ShallowCopy()

void vtkSelection::ShallowCopy ( vtkDataObject * src )

overridevirtual

Copy selection nodes of the input.

This is a shallow copy: selection lists and pointers in the properties are passed by reference.

Reimplemented from vtkDataObject.

◆ Union() [1/2]

virtual void vtkSelection::Union ( vtkSelection * selection )

virtual

Union this selection with the specified selection.

Attempts to reuse selection nodes in this selection if properties match exactly. Otherwise, creates new selection nodes.

◆ Union() [2/2]

virtual void vtkSelection::Union ( vtkSelectionNode * node )

virtual

Union this selection with the specified selection node.

Attempts to reuse a selection node in this selection if properties match exactly. Otherwise, creates a new selection node.

◆ Subtract() [1/2]

virtual void vtkSelection::Subtract ( vtkSelection * selection )

virtual

Remove the nodes from the specified selection from this selection.

Assumes that selection node internal arrays are vtkIdTypeArrays.

◆ Subtract() [2/2]

virtual void vtkSelection::Subtract ( vtkSelectionNode * node )

virtual

Remove the nodes from the specified selection from this selection.

Assumes that selection node internal arrays are vtkIdTypeArrays.

◆ GetMTime()

vtkMTimeType vtkSelection::GetMTime ( )

overridevirtual

Return the MTime taking into account changes to the properties.

Reimplemented from vtkDataObject.

◆ Dump() [1/2]

virtual void vtkSelection::Dump ( )

virtual

Dumps the contents of the selection, giving basic information only.

◆ Dump() [2/2]

virtual void vtkSelection::Dump ( ostream & os )

virtual

Dumps the contents of the selection, giving basic information only.

◆ GetData() [1/2]

static vtkSelection * vtkSelection::GetData ( vtkInformation * info )

static

Retrieve a vtkSelection stored inside an invormation object.

◆ GetData() [2/2]

static vtkSelection * vtkSelection::GetData	(	vtkInformationVector *	v,
		int	i = `0`
	)

static

Retrieve a vtkSelection stored inside an invormation object.

◆ Evaluate() [1/2]

vtkSmartPointer< vtkSignedCharArray > vtkSelection::Evaluate	(	vtkSignedCharArray const	values,
		unsigned int	num_values
	)		const

Evaluates the expression for each element in the values.

The order matches the order of the selection nodes. If not expression is set or if it's an empty string, then an expression that simply combines all selection nodes in an binary-or is assumed.

◆ Evaluate() [2/2]

template<typename MapType >

vtkSmartPointer< vtkSignedCharArray > vtkSelection::Evaluate ( const MapType & values_map ) const

inline

Convenience method to pass a map of vtkSignedCharArray ptrs (or vtkSmartPointers).

Definition at line 336 of file vtkSelection.h.

Member Data Documentation

◆ Expression

std::string vtkSelection::Expression

protected

Definition at line 324 of file vtkSelection.h.

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

Common/DataModel/vtkSelection.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

◆ vtkSelection()

◆ ~vtkSelection()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ Initialize()

◆ GetDataObjectType()

◆ GetNumberOfNodes()

◆ GetNode() [1/2]

◆ GetNode() [2/2]

◆ AddNode()

◆ SetNode()

◆ GetNodeNameAtIndex()

◆ RemoveNode() [1/3]

◆ RemoveNode() [2/3]

◆ RemoveNode() [3/3]

◆ RemoveAllNodes()

◆ SetExpression()

◆ GetExpression()

◆ DeepCopy()

◆ ShallowCopy()

◆ Union() [1/2]

◆ Union() [2/2]

◆ Subtract() [1/2]

◆ Subtract() [2/2]

◆ GetMTime()

◆ Dump() [1/2]

◆ Dump() [2/2]

◆ GetData() [1/2]

◆ GetData() [2/2]

◆ Evaluate() [1/2]

◆ Evaluate() [2/2]

Member Data Documentation

◆ Expression