VTK
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 =========================================================================*/
52 #ifndef vtkSelectionNode_h
53 #define vtkSelectionNode_h
54 
55 #include "vtkCommonDataModelModule.h" // For export macro
56 #include "vtkObject.h"
57 
58 class vtkAbstractArray;
60 class vtkInformation;
64 class vtkProp;
65 class vtkTable;
66 
67 class VTKCOMMONDATAMODEL_EXPORT vtkSelectionNode : public vtkObject
68 {
69 public:
70  vtkTypeMacro(vtkSelectionNode,vtkObject);
71  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
72  static vtkSelectionNode* New();
73 
77  virtual void Initialize();
78 
80 
86 
88 
92  vtkGetObjectMacro(SelectionData, vtkDataSetAttributes);
94 
96 
99  vtkGetObjectMacro(Properties, vtkInformation);
101 
105  virtual void DeepCopy(vtkSelectionNode* src);
106 
112  virtual void ShallowCopy(vtkSelectionNode* src);
113 
117  vtkMTimeType GetMTime() VTK_OVERRIDE;
118 
119  // vtkSelectionNode specific keys follow:
136  static vtkInformationIntegerKey* CONTENT_TYPE();
137 
139  {
140  SELECTIONS, // Deprecated.
148  BLOCKS, // used to select blocks within a composite dataset.
149  QUERY
150  };
151 
153 
157  virtual void SetContentType(int type);
158  virtual int GetContentType();
160 
168 
170  {
176  ROW
177  };
178 
180 
184  virtual void SetFieldType(int type);
185  virtual int GetFieldType();
187 
189 
196 
198 
201  vtkSetStringMacro(QueryString);
202  vtkGetStringMacro(QueryString);
204 
209 
215 
224 
229 
235 
240 
246 
251 
257 
262 
267 
269 
275 
282 
288 
295 
299  bool EqualProperties(vtkSelectionNode* other, bool fullcompare=true);
300 
301 protected:
303  ~vtkSelectionNode() VTK_OVERRIDE;
304 
305  vtkInformation* Properties;
306  vtkDataSetAttributes* SelectionData;
307  char* QueryString;
308 
309 private:
310  vtkSelectionNode(const vtkSelectionNode&) VTK_DELETE_FUNCTION;
311  void operator=(const vtkSelectionNode&) VTK_DELETE_FUNCTION;
312 
313 };
314 
315 #endif
vtkSelectionNode::SOURCE_ID
static vtkInformationIntegerKey * SOURCE_ID()
ID of the data or algorithm the selection belongs to.
vtkSelectionNode::ShallowCopy
virtual void ShallowCopy(vtkSelectionNode *src)
Copy properties, selection list and children of the input.
vtkSelectionNode::FIELD_TYPE
static vtkInformationIntegerKey * FIELD_TYPE()
Controls whether cell, point, or field data determine what is inside and out.
vtkSelectionNode::ConvertAttributeTypeToSelectionField
static int ConvertAttributeTypeToSelectionField(int val)
vtkSelectionNode
A node in a selection tree.
Definition: vtkSelectionNode.h:68
vtkSelectionNode::LOCATIONS
@ LOCATIONS
Definition: vtkSelectionNode.h:146
vtkSelectionNode::PROCESS_ID
static vtkInformationIntegerKey * PROCESS_ID()
Process id the selection is on.
vtkX3D::type
@ type
Definition: vtkX3D.h:516
vtkSelectionNode::CONTAINING_CELLS
static vtkInformationIntegerKey * CONTAINING_CELLS()
This flag tells the extraction filter, when FIELD_TYPE==POINT, that it should also extract the cells ...
vtkSelectionNode::PROP
static vtkInformationObjectBaseKey * PROP()
Pointer to the prop the selection belongs to.
vtkDataSetAttributes
represent and manipulate attribute data in a dataset
Definition: vtkDataSetAttributes.h:59
vtkX3D::data
@ data
Definition: vtkX3D.h:315
vtkTable
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:69
vtkSelectionNode::PEDIGREEIDS
@ PEDIGREEIDS
Definition: vtkSelectionNode.h:142
vtkSelectionNode::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:60
vtkSelectionNode::EPSILON
static vtkInformationDoubleKey * EPSILON()
For location selection of points, if distance is greater than this reject.
vtkSelectionNode::SubtractSelectionList
void SubtractSelectionList(vtkSelectionNode *other)
Subtracts the items in the selection list, other, from this selection list.
vtkSelectionNode::FRUSTUM
@ FRUSTUM
Definition: vtkSelectionNode.h:145
vtkSelectionNode::SelectionContent
SelectionContent
Definition: vtkSelectionNode.h:139
vtkInformationDoubleKey
Key for double values in vtkInformation.
Definition: vtkInformationDoubleKey.h:35
vtkSelectionNode::VALUES
@ VALUES
Definition: vtkSelectionNode.h:143
vtkMTimeType
vtkTypeUInt64 vtkMTimeType
Definition: vtkType.h:248
vtkSelectionNode::GetSelectionList
virtual vtkAbstractArray * GetSelectionList()
vtkSelectionNode::POINT
@ POINT
Definition: vtkSelectionNode.h:172
vtkSelectionNode::VERTEX
@ VERTEX
Definition: vtkSelectionNode.h:174
vtkSelectionNode::SetSelectionData
virtual void SetSelectionData(vtkDataSetAttributes *data)
Sets the selection table.
vtkSelectionNode::INDEXED_VERTICES
static vtkInformationIntegerKey * INDEXED_VERTICES()
This key is used when making visible vertex selection.
vtkSelectionNode::COMPOSITE_INDEX
static vtkInformationIntegerKey * COMPOSITE_INDEX()
Used to identify a node in composite datasets.
vtkSelectionNode::SetContentType
virtual void SetContentType(int type)
Get or set the content type of the selection.
vtkSelectionNode::SOURCE
static vtkInformationObjectBaseKey * SOURCE()
Pointer to the data or algorithm the selection belongs to.
vtkSelectionNode::BLOCKS
@ BLOCKS
Definition: vtkSelectionNode.h:148
vtkInformationObjectBaseKey
Key for vtkObjectBase values.
Definition: vtkInformationObjectBaseKey.h:37
vtkInformationIntegerKey
Key for integer values in vtkInformation.
Definition: vtkInformationIntegerKey.h:35
vtkSelectionNode::GLOBALIDS
@ GLOBALIDS
Definition: vtkSelectionNode.h:141
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkSelectionNode::GetMTime
vtkMTimeType GetMTime() override
Return the MTime taking into account changes to the properties.
vtkSelectionNode::GetFieldType
virtual int GetFieldType()
vtkSelectionNode::ConvertSelectionFieldToAttributeType
static int ConvertSelectionFieldToAttributeType(int val)
Methods to convert vtkSelectionNode::SelectionField to vtkDataSetAttribute::AttributeTypes and vice-v...
vtkSelectionNode::Initialize
virtual void Initialize()
Restore data object to initial state,.
vtkSelectionNode::DeepCopy
virtual void DeepCopy(vtkSelectionNode *src)
Copy properties, selection list and children of the input.
vtkGetStringMacro
vtkGetStringMacro(ExtensionsString)
Returns a string listing all available extensions.
vtkSelectionNode::FIELD
@ FIELD
Definition: vtkSelectionNode.h:173
vtkSelectionNode::SetSelectionList
virtual void SetSelectionList(vtkAbstractArray *)
Sets the selection list.
vtkObject.h
vtkSelectionNode::GetContentType
virtual int GetContentType()
vtkAbstractArray
Abstract superclass for all arrays.
Definition: vtkAbstractArray.h:79
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkProp
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:48
vtkSelectionNode::INVERSE
static vtkInformationIntegerKey * INVERSE()
This flag tells the extraction filter to exclude the selection.
vtkSelectionNode::SelectionField
SelectionField
Definition: vtkSelectionNode.h:170
vtkSelectionNode::New
static vtkSelectionNode * New()
vtkSelectionNode::PROP_ID
static vtkInformationIntegerKey * PROP_ID()
ID of the prop the selection belongs to.
vtkSelectionNode::vtkSelectionNode
vtkSelectionNode()
vtkSelectionNode::THRESHOLDS
@ THRESHOLDS
Definition: vtkSelectionNode.h:147
vtkSelectionNode::SELECTIONS
@ SELECTIONS
Definition: vtkSelectionNode.h:140
vtkSelectionNode::EDGE
@ EDGE
Definition: vtkSelectionNode.h:175
vtkSelectionNode::COMPONENT_NUMBER
static vtkInformationIntegerKey * COMPONENT_NUMBER()
When ContentType==THRESHOLDS or ContentType==VALUES i.e.
vtkSelectionNode::INDICES
@ INDICES
Definition: vtkSelectionNode.h:144
vtkSelectionNode::HIERARCHICAL_LEVEL
static vtkInformationIntegerKey * HIERARCHICAL_LEVEL()
Used to identify a dataset in a hiererchical box dataset.
vtkSelectionNode::SetFieldType
virtual void SetFieldType(int type)
Get or set the field type of the selection.
vtkSelectionNode::~vtkSelectionNode
~vtkSelectionNode() override
vtkSelectionNode::PIXEL_COUNT
static vtkInformationIntegerKey * PIXEL_COUNT()
A helper for visible cell selector, this is the number of pixels covered by the actor whose cells are...
vtkSelectionNode::CELL
@ CELL
Definition: vtkSelectionNode.h:171
vtkSelectionNode::HIERARCHICAL_INDEX
static vtkInformationIntegerKey * HIERARCHICAL_INDEX()
vtkSelectionNode::EqualProperties
bool EqualProperties(vtkSelectionNode *other, bool fullcompare=true)
Compares Properties of self and other to ensure that they are exactly same.
vtkSelectionNode::UnionSelectionList
void UnionSelectionList(vtkSelectionNode *other)
Merges the selection list between self and the other.