|
virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class. More...
|
|
vtkSelection * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More...
|
|
void | Initialize () override |
| Restore data object to initial state,. More...
|
|
int | GetDataObjectType () override |
| Returns VTK_SELECTION enumeration value. More...
|
|
unsigned int | GetNumberOfNodes () const |
| Returns the number of nodes in this selection. More...
|
|
virtual vtkSelectionNode * | GetNode (unsigned int idx) const |
| Returns a node given it's index. More...
|
|
virtual vtkSelectionNode * | GetNode (const std::string &name) const |
| Returns a node with the given name, if present, else nullptr is returned. More...
|
|
virtual std::string | AddNode (vtkSelectionNode *) |
| Adds a selection node. More...
|
|
virtual void | SetNode (const std::string &name, vtkSelectionNode *) |
| Adds a vtkSelectionNode and assigns it the specified name. More...
|
|
virtual std::string | GetNodeNameAtIndex (unsigned int idx) const |
| Returns the name for a node at the given index. More...
|
|
virtual void | RemoveAllNodes () |
| Removes all selection nodes. More...
|
|
void | DeepCopy (vtkDataObject *src) override |
| Copy selection nodes of the input. More...
|
|
void | ShallowCopy (vtkDataObject *src) override |
| Copy selection nodes of the input. More...
|
|
virtual void | Union (vtkSelection *selection) |
| Union this selection with the specified selection. More...
|
|
virtual void | Union (vtkSelectionNode *node) |
| Union this selection with the specified selection node. More...
|
|
virtual void | Subtract (vtkSelection *selection) |
| Remove the nodes from the specified selection from this selection. More...
|
|
virtual void | Subtract (vtkSelectionNode *node) |
| Remove the nodes from the specified selection from this selection. More...
|
|
vtkMTimeType | GetMTime () override |
| Return the MTime taking into account changes to the properties. More...
|
|
vtkSmartPointer< vtkSignedCharArray > | Evaluate (vtkSignedCharArray *const *values, unsigned int num_values) const |
| Evaluates the expression for each element in the values. More...
|
|
template<typename MapType > |
vtkSmartPointer< vtkSignedCharArray > | Evaluate (const MapType &values_map) const |
| Convenience method to pass a map of vtkSignedCharArray ptrs (or vtkSmartPointers). More...
|
|
|
virtual void | RemoveNode (unsigned int idx) |
| Removes a selection node. More...
|
|
virtual void | RemoveNode (const std::string &name) |
| Removes a selection node. More...
|
|
virtual void | RemoveNode (vtkSelectionNode *) |
| Removes a selection node. More...
|
|
|
virtual void | SetExpression (std::string) |
| Get/Set the expression that defines the boolean expression to combine the selection nodes. More...
|
|
virtual std::string | GetExpression () |
| Get/Set the expression that defines the boolean expression to combine the selection nodes. More...
|
|
|
virtual void | Dump () |
| Dumps the contents of the selection, giving basic information only. More...
|
|
virtual void | Dump (ostream &os) |
| Dumps the contents of the selection, giving basic information only. More...
|
|
vtkDataObject * | NewInstance () const |
|
void | ReleaseData () |
| Release data back to system to conserve memory resource. More...
|
|
vtkMTimeType | GetUpdateTime () |
| Used by Threaded ports to determine if they should initiate an asynchronous update (still in development). More...
|
|
virtual unsigned long | GetActualMemorySize () |
| Return the actual size of the data in kibibytes (1024 bytes). More...
|
|
virtual void | CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info)) |
| Copy from the pipeline information to the data object's own information. More...
|
|
virtual void | CopyInformationToPipeline (vtkInformation *vtkNotUsed(info)) |
| Copy information from this data object to the pipeline information. More...
|
|
void | DataHasBeenGenerated () |
| This method is called by the source when it executes to generate data. More...
|
|
virtual void | PrepareForNewData () |
| make the output data ready for new data to be inserted. More...
|
|
virtual int | GetExtentType () |
| The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstructuredGrid. More...
|
|
virtual void | Crop (const int *updateExtent) |
| This method crops the data object (if necessary) so that the extent matches the update extent. More...
|
|
virtual vtkDataSetAttributes * | GetAttributes (int type) |
| Returns the attributes of the data object of the specified attribute type. More...
|
|
virtual vtkFieldData * | GetAttributesAsFieldData (int type) |
| Returns the attributes of the data object as a vtkFieldData. More...
|
|
virtual int | GetAttributeTypeForArray (vtkAbstractArray *arr) |
| Retrieves the attribute type that an array came from. More...
|
|
virtual vtkIdType | GetNumberOfElements (int type) |
| Get the number of elements for a specific attribute type (POINT, CELL, etc.). More...
|
|
virtual vtkInformation * | GetInformation () |
| Set/Get the information object associated with this data object. More...
|
|
virtual void | SetInformation (vtkInformation *) |
| Set/Get the information object associated with this data object. More...
|
|
virtual int | GetDataReleased () |
| Get the flag indicating the data has been released. More...
|
|
virtual void | SetFieldData (vtkFieldData *) |
| Assign or retrieve a general field data to this data object. More...
|
|
virtual vtkFieldData * | GetFieldData () |
| Assign or retrieve a general field data to this data object. More...
|
|
void | GlobalReleaseDataFlagOn () |
| Turn on/off flag to control whether every object releases its data after being used by a filter. More...
|
|
void | GlobalReleaseDataFlagOff () |
| Turn on/off flag to control whether every object releases its data after being used by a filter. More...
|
|
| vtkBaseTypeMacro (vtkObject, vtkObjectBase) |
|
virtual void | DebugOn () |
| Turn debugging output on. More...
|
|
virtual void | DebugOff () |
| Turn debugging output off. More...
|
|
bool | GetDebug () |
| Get the value of the debug flag. More...
|
|
void | SetDebug (bool debugFlag) |
| Set the value of the debug flag. More...
|
|
virtual void | Modified () |
| Update the modification time for this object. More...
|
|
void | RemoveObserver (unsigned long tag) |
|
void | RemoveObservers (unsigned long event) |
|
void | RemoveObservers (const char *event) |
|
void | RemoveAllObservers () |
|
vtkTypeBool | HasObserver (unsigned long event) |
|
vtkTypeBool | HasObserver (const char *event) |
|
int | InvokeEvent (unsigned long event) |
|
int | InvokeEvent (const char *event) |
|
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
|
|
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
|
|
vtkCommand * | GetCommand (unsigned long tag) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
|
|
void | RemoveObserver (vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
|
|
void | RemoveObservers (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
|
|
void | RemoveObservers (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
|
|
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
|
|
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
|
|
template<class U , class T > |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
|
|
template<class U , class T > |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
|
|
template<class U , class T > |
unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Allow user to set the AbortFlagOn() with the return value of the callback method. More...
|
|
int | InvokeEvent (unsigned long event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More...
|
|
int | InvokeEvent (const char *event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More...
|
|
const char * | GetClassName () const |
| Return the class name as a string. More...
|
|
virtual void | Delete () |
| Delete a VTK object. More...
|
|
virtual void | FastDelete () |
| Delete a reference to this object. More...
|
|
void | InitializeObjectBase () |
|
void | Print (ostream &os) |
| Print an object to an ostream. More...
|
|
virtual void | Register (vtkObjectBase *o) |
| Increase the reference count (mark as used by another object). More...
|
|
virtual void | UnRegister (vtkObjectBase *o) |
| Decrease the reference count (release by another object). More...
|
|
int | GetReferenceCount () |
| Return the current reference count of this object. More...
|
|
void | SetReferenceCount (int) |
| Sets the reference count. More...
|
|
void | PrintRevisions (ostream &) |
| Legacy. More...
|
|
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More...
|
|
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More...
|
|
|
static 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. More...
|
|
static vtkSelection * | GetData (vtkInformationVector *v, int i=0) |
| Retrieve a vtkSelection stored inside an invormation object. More...
|
|
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) More...
|
|
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. More...
|
|
static void | RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name) |
| Remove the info associated with an array. More...
|
|
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). More...
|
|
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). More...
|
|
static void | SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents) |
| Convenience version of previous method for use (primarily) by the Imaging filters. More...
|
|
static const char * | GetAssociationTypeAsString (int associationType) |
| Given an integer association type, this static method returns a string type for the attribute (i.e. More...
|
|
static int | GetAssociationTypeFromString (const char *associationType) |
| Given an integer association type, this static method returns a string type for the attribute (i.e. More...
|
|
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 * | BOUNDING_BOX () |
|
static vtkInformationDataObjectKey * | SIL () |
|
static vtkDataObject * | GetData (vtkInformation *info) |
| Retrieve an instance of this class from an information object. More...
|
|
static vtkDataObject * | GetData (vtkInformationVector *v, int i=0) |
| Retrieve an instance of this class from an information object. More...
|
|
static void | SetGlobalReleaseDataFlag (int val) |
| Turn on/off flag to control whether every object releases its data after being used by a filter. More...
|
|
static int | GetGlobalReleaseDataFlag () |
| Turn on/off flag to control whether every object releases its data after being used by a filter. More...
|
|
static vtkObject * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
|
|
static void | BreakOnError () |
| This method is called when vtkErrorMacro executes. More...
|
|
static void | SetGlobalWarningDisplay (int val) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More...
|
|
static void | GlobalWarningDisplayOn () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More...
|
|
static void | GlobalWarningDisplayOff () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More...
|
|
static int | GetGlobalWarningDisplay () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More...
|
|
static vtkTypeBool | IsTypeOf (const char *name) |
| Return 1 if this class type is the same type of (or a subclass of) the named class. More...
|
|
static vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
|
|
data object that represents a "selection" in VTK.
vtkSelection is a data object that represents a selection definition. It is used to define the elements that are selected. The criteria of the selection is defined using one or more vtkSelectionNode instances. Parameters of the vtkSelectionNode define what kind of elements are being selected (vtkSelectionNode::GetFieldType), how the selection criteria is defined (vtkSelectionNode::GetContentType), etc.
Filters like vtkExtractSelection, vtkExtractDataArraysOverTime can be used to extract the selected elements from a dataset.
Combining Selections
When a vtkSelection contains multiple vtkSelectionNode instances, the selection defined is a union of all the elements identified by each of the nodes.
Optionally, one can use vtkSelection::SetExpression
to define a boolean expression to build arbitrarily complex combinations. The expression can be defined using names assigned to the selection nodes when the nodes are added to vtkSelection (either explicitly or automatically).
- See also
- vtkSelectionNode
- Examples:
- vtkSelection (Examples)
- Tests:
- vtkSelection (Tests)
Definition at line 63 of file vtkSelection.h.