VTK  9.3.1
vtkSelectionNode.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
214 #ifndef vtkSelectionNode_h
215 #define vtkSelectionNode_h
216 
217 #include "vtkCommonDataModelModule.h" // For export macro
218 #include "vtkObject.h"
219 
220 VTK_ABI_NAMESPACE_BEGIN
221 class vtkAbstractArray;
223 class vtkInformation;
229 class vtkProp;
230 class vtkTable;
231 
232 class VTKCOMMONDATAMODEL_EXPORT vtkSelectionNode : public vtkObject
233 {
234 public:
235  vtkTypeMacro(vtkSelectionNode, vtkObject);
236  void PrintSelf(ostream& os, vtkIndent indent) override;
237  static vtkSelectionNode* New();
238 
242  virtual void Initialize();
243 
245 
251  virtual void SetSelectionList(vtkAbstractArray*);
252  virtual vtkAbstractArray* GetSelectionList();
254 
256 
259  virtual void SetSelectionData(vtkDataSetAttributes* data);
260  vtkGetObjectMacro(SelectionData, vtkDataSetAttributes);
262 
264 
267  vtkGetObjectMacro(Properties, vtkInformation);
269 
273  virtual void DeepCopy(vtkSelectionNode* src);
274 
280  virtual void ShallowCopy(vtkSelectionNode* src);
281 
285  vtkMTimeType GetMTime() override;
286 
287  // vtkSelectionNode specific keys follow:
295  static vtkInformationIntegerKey* CONTENT_TYPE();
296 
302  {
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 
337  static vtkInformationIntegerKey* FIELD_TYPE();
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 
375  static int ConvertSelectionFieldToAttributeType(int val);
376  static int ConvertAttributeTypeToSelectionField(int val);
378 
380 
383  vtkSetStringMacro(QueryString);
384  vtkGetStringMacro(QueryString);
386 
390  static vtkInformationDoubleKey* EPSILON();
391 
395  static vtkInformationDoubleKey* ZBUFFER_VALUE();
396 
401  static vtkInformationIntegerKey* CONTAINING_CELLS();
402 
408  static vtkInformationIntegerKey* CONNECTED_LAYERS();
409 
414  static vtkInformationIntegerKey* CONNECTED_LAYERS_REMOVE_SEED();
415 
420  static vtkInformationIntegerKey* CONNECTED_LAYERS_REMOVE_INTERMEDIATE_LAYERS();
421 
429  static vtkInformationIntegerKey* COMPONENT_NUMBER();
430 
434  static vtkInformationIntegerKey* INVERSE();
435 
440  static vtkInformationIntegerKey* PIXEL_COUNT();
441 
445  static vtkInformationObjectBaseKey* SOURCE();
446 
451  static vtkInformationIntegerKey* SOURCE_ID();
452 
456  static vtkInformationObjectBaseKey* PROP();
457 
462  static vtkInformationIntegerKey* PROP_ID();
463 
467  static vtkInformationIntegerKey* PROCESS_ID();
468 
470 
479  static vtkInformationStringKey* ASSEMBLY_NAME();
480  static vtkInformationStringVectorKey* SELECTORS();
482 
486  static vtkInformationIntegerKey* COMPOSITE_INDEX();
487 
489 
492  static vtkInformationIntegerKey* HIERARCHICAL_LEVEL();
493  static vtkInformationIntegerKey* HIERARCHICAL_INDEX();
495 
500  void UnionSelectionList(vtkSelectionNode* other);
501 
507  void SubtractSelectionList(vtkSelectionNode* other);
508 
512  bool EqualProperties(vtkSelectionNode* other, bool fullcompare = true);
513 
514 protected:
516  ~vtkSelectionNode() override;
517 
520  char* QueryString;
521 
522  // Map from content type to content type name
523  static const char ContentTypeNames[SelectionContent::NUM_CONTENT_TYPES][16];
524 
525  // Map from integer field type to field type name
526  static const char FieldTypeNames[SelectionField::NUM_FIELD_TYPES][8];
527 
528 private:
529  vtkSelectionNode(const vtkSelectionNode&) = delete;
530  void operator=(const vtkSelectionNode&) = delete;
531 };
532 
533 VTK_ABI_NAMESPACE_END
534 #endif
a node in a vtkSelection the defines the selection criteria.
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:45
Select entities near the supplied world coordinates.
vtkInformation * Properties
abstract base class for most VTK objects
Definition: vtkObject.h:51
The selection data provided is cell-data.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
Store vtkAlgorithm input/output information.
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:270
The selection data provided is point-data.
Abstract superclass for all arrays.
The selection data provided is graph vertex-data.
Key for string values in vtkInformation.
SelectionContent
Indicate the means by which data is selected.
a simple class to control print indentation
Definition: vtkIndent.h:28
Key for integer values in vtkInformation.
virtual vtkMTimeType GetMTime()
Return this object's modified time.
The selection data provided is graph edge-data.
Key for vtkObjectBase values.
Select entities with a text query.
SelectionField
Indicate the types of entities to which the selection-data applies.
represent and manipulate attribute data in a dataset
Key for String vector values.
Select blocks within a composite dataset by their flat index.
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:58
Select entities that take on specific array values.
The selection data provided is table row-data.
Key for double values in vtkInformation.
vtkDataSetAttributes * SelectionData
Select entities by their offsets into the dataset.
Select entities called out by their globally-unique IDs.
Select entities whose array values fall within a given threshold.
Select entities that have some identifiable pedigree.
Select entities contained within a viewing frustum.
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
Select entities with user-supplied, application-specific logic.
Select datasets within a composite dataset using selector expressions.
The selection data provided is field-data.