VTK  9.1.0
vtkSelectionNode.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: vtkSelectionNode.h
5 
6  Copyright (c) Kitware, Inc.
7  All rights reserved.
8  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
213 #ifndef vtkSelectionNode_h
214 #define vtkSelectionNode_h
215 
216 #include "vtkCommonDataModelModule.h" // For export macro
217 #include "vtkDeprecation.h" // for deprecation
218 #include "vtkObject.h"
219 
220 class vtkAbstractArray;
222 class vtkInformation;
228 class vtkProp;
229 class vtkTable;
230 
231 class VTKCOMMONDATAMODEL_EXPORT vtkSelectionNode : public vtkObject
232 {
233 public:
234  vtkTypeMacro(vtkSelectionNode, vtkObject);
235  void PrintSelf(ostream& os, vtkIndent indent) override;
237 
241  virtual void Initialize();
242 
244 
253 
255 
259  vtkGetObjectMacro(SelectionData, vtkDataSetAttributes);
261 
263 
266  vtkGetObjectMacro(Properties, vtkInformation);
268 
272  virtual void DeepCopy(vtkSelectionNode* src);
273 
279  virtual void ShallowCopy(vtkSelectionNode* src);
280 
284  vtkMTimeType GetMTime() override;
285 
286  // vtkSelectionNode specific keys follow:
295 
301  {
314  NUM_CONTENT_TYPES
315  };
316 
318 
322  virtual void SetContentType(int type);
323  virtual int GetContentType();
325 
329  static const char* GetContentTypeAsString(int type);
330 
338 
341  {
347  ROW,
348  NUM_FIELD_TYPES
349  };
350 
352 
356  virtual void SetFieldType(int type);
357  virtual int GetFieldType();
359 
363  static const char* GetFieldTypeAsString(int type);
364 
368  static int GetFieldTypeFromString(const char* type);
369 
371 
378 
380 
383  vtkSetStringMacro(QueryString);
384  vtkGetStringMacro(QueryString);
386 
391 
396 
402 
409 
418 
423 
429 
434 
440 
445 
451 
456 
458 
470 
475 
477 
483 
487  VTK_DEPRECATED_IN_9_1_0("no longer relevant")
488  static vtkInformationIntegerKey* INDEXED_VERTICES();
489 
494  void UnionSelectionList(vtkSelectionNode* other);
495 
501  void SubtractSelectionList(vtkSelectionNode* other);
502 
506  bool EqualProperties(vtkSelectionNode* other, bool fullcompare = true);
507 
508 protected:
510  ~vtkSelectionNode() override;
511 
512  vtkInformation* Properties;
513  vtkDataSetAttributes* SelectionData;
514  char* QueryString;
515 
516  // Map from content type to content type name
517  static const char ContentTypeNames[SelectionContent::NUM_CONTENT_TYPES][16];
518 
519  // Map from integer field type to field type name
520  static const char FieldTypeNames[SelectionField::NUM_FIELD_TYPES][8];
521 
522 private:
523  vtkSelectionNode(const vtkSelectionNode&) = delete;
524  void operator=(const vtkSelectionNode&) = delete;
525 };
526 
527 #endif
Abstract superclass for all arrays.
represent and manipulate attribute data in a dataset
a simple class to control print indentation
Definition: vtkIndent.h:34
Key for double values in vtkInformation.
Key for integer values in vtkInformation.
Key for vtkObjectBase values.
Key for string values in vtkInformation.
Store vtkAlgorithm input/output information.
abstract base class for most VTK objects
Definition: vtkObject.h:63
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:57
a node in a vtkSelection the defines the selection criteria.
static int GetFieldTypeFromString(const char *type)
Get field type from string.
static vtkInformationObjectBaseKey * SOURCE()
Pointer to the data or algorithm the selection belongs to.
static vtkInformationIntegerKey * PIXEL_COUNT()
A helper for visible cell selector, this is the number of pixels covered by the actor whose cells are...
static vtkInformationObjectBaseKey * PROP()
Pointer to the prop the selection belongs to.
virtual void SetFieldType(int type)
Get or set the field type of the selection.
static const char * GetFieldTypeAsString(int type)
Get the field type as a string.
static vtkInformationIntegerKey * PROP_ID()
ID of the prop the selection belongs to.
virtual void SetSelectionList(vtkAbstractArray *)
Get/Set the selection list.
static vtkInformationIntegerKey * FIELD_TYPE()
Controls whether cell, point, or field data determine what is inside and out.
static vtkInformationIntegerKey * COMPOSITE_INDEX()
Used to identify a node in composite datasets.
virtual void Initialize()
Restore data object to initial state,.
static vtkInformationDoubleKey * ZBUFFER_VALUE()
If present, closest zbuffer value of this selection.
static vtkInformationIntegerKey * HIERARCHICAL_INDEX()
Used to identify a dataset in a hiererchical box dataset.
virtual vtkAbstractArray * GetSelectionList()
Get/Set the selection list.
static const char * GetContentTypeAsString(int type)
Get the content type as a string.
SelectionField
Indicate the types of entities to which the selection-data applies.
@ POINT
The selection data provided is point-data.
@ EDGE
The selection data provided is graph edge-data.
@ CELL
The selection data provided is cell-data.
@ FIELD
The selection data provided is field-data.
@ ROW
The selection data provided is table row-data.
@ VERTEX
The selection data provided is graph vertex-data.
static vtkInformationIntegerKey * COMPONENT_NUMBER()
When ContentType==THRESHOLDS or ContentType==VALUES i.e.
static vtkInformationIntegerKey * CONTAINING_CELLS()
This flag tells the extraction filter, when FIELD_TYPE==POINT, that it should also extract the cells ...
static vtkInformationDoubleKey * EPSILON()
For location selection of points, if distance is greater than this reject.
static vtkInformationIntegerKey * SOURCE_ID()
ID of the data or algorithm the selection belongs to.
static vtkInformationIntegerKey * INVERSE()
This flag tells the extraction filter to exclude the selection.
virtual int GetContentType()
Get or set the content type of the selection.
static vtkInformationIntegerKey * CONTENT_TYPE()
Get the (primary) property that describes the content of a selection node's data.
static vtkInformationIntegerKey * CONNECTED_LAYERS()
When specified, this indicates how many layers of connected elements in addition to those chosen expl...
virtual void SetContentType(int type)
Get or set the content type of the selection.
static vtkInformationStringKey * ASSEMBLY_NAME()
Keys for selector-based identification of blocks to choose from a composite dataset.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void SetSelectionData(vtkDataSetAttributes *data)
Sets the selection table.
static int ConvertAttributeTypeToSelectionField(int val)
Methods to convert vtkSelectionNode::SelectionField to vtkDataSetAttribute::AttributeTypes and vice-v...
SelectionContent
Indicate the means by which data is selected.
@ VALUES
Select entities that take on specific array values.
@ PEDIGREEIDS
Select entities that have some identifiable pedigree.
@ GLOBALIDS
Select entities called out by their globally-unique IDs.
@ SELECTIONS
Deprecated.
@ LOCATIONS
Select entities near the supplied world coordinates.
@ BLOCK_SELECTORS
Select datasets within a composite dataset using selector expressions.
@ INDICES
Select entities by their offsets into the dataset.
@ THRESHOLDS
Select entities whose array values fall within a given threshold.
@ QUERY
Select entities with a text query.
@ BLOCKS
Select blocks within a composite dataset by their flat index.
@ USER
Select entities with user-supplied, application-specific logic.
@ FRUSTUM
Select entities contained within a viewing frustum.
virtual void DeepCopy(vtkSelectionNode *src)
Copy properties, selection list and children of the input.
static vtkInformationIntegerKey * HIERARCHICAL_LEVEL()
Used to identify a dataset in a hiererchical box dataset.
vtkMTimeType GetMTime() override
Return the MTime taking into account changes to the properties.
virtual int GetFieldType()
Get or set the field type of the selection.
static vtkSelectionNode * New()
static vtkInformationStringVectorKey * SELECTORS()
Keys for selector-based identification of blocks to choose from a composite dataset.
static vtkInformationIntegerKey * PROCESS_ID()
Process id the selection is on.
virtual void ShallowCopy(vtkSelectionNode *src)
Copy properties, selection list and children of the input.
static int ConvertSelectionFieldToAttributeType(int val)
Methods to convert vtkSelectionNode::SelectionField to vtkDataSetAttribute::AttributeTypes and vice-v...
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:63
@ type
Definition: vtkX3D.h:522
@ data
Definition: vtkX3D.h:321
#define VTK_DEPRECATED_IN_9_1_0(reason)
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287