vtkSelectionNode.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSelectionNode_h
#define vtkSelectionNode_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkObject.h"

VTK_ABI_NAMESPACE_BEGIN
class vtkAbstractArray;
class vtkDataSetAttributes;
class vtkInformation;
class vtkInformationDoubleKey;
class vtkInformationIntegerKey;
class vtkInformationObjectBaseKey;
class vtkInformationStringKey;
class vtkInformationStringVectorKey;
class vtkProp;
class vtkTable;

class VTKCOMMONDATAMODEL_EXPORT vtkSelectionNode : public vtkObject
{
public:
  vtkTypeMacro(vtkSelectionNode, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
  static vtkSelectionNode* New();

  virtual void Initialize();


  virtual void SetSelectionList(vtkAbstractArray*);
  virtual vtkAbstractArray* GetSelectionList();


  virtual void SetSelectionData(vtkDataSetAttributes* data);
  vtkGetObjectMacro(SelectionData, vtkDataSetAttributes);


  vtkGetObjectMacro(Properties, vtkInformation);

  virtual void DeepCopy(vtkSelectionNode* src);

  virtual void ShallowCopy(vtkSelectionNode* src);

  vtkMTimeType GetMTime() override;

  // vtkSelectionNode specific keys follow:
  static vtkInformationIntegerKey* CONTENT_TYPE();

  enum SelectionContent
  {
    GLOBALIDS,       
    PEDIGREEIDS,     
    VALUES,          
    INDICES,         
    FRUSTUM,         
    LOCATIONS,       
    THRESHOLDS,      
    BLOCKS,          
    BLOCK_SELECTORS, 
    QUERY,           
    USER,            
    NUM_CONTENT_TYPES
  };


  virtual void SetContentType(int type);
  virtual int GetContentType();

  static const char* GetContentTypeAsString(int type);

  static vtkInformationIntegerKey* FIELD_TYPE();

  enum SelectionField
  {
    CELL,   
    POINT,  
    FIELD,  
    VERTEX, 
    EDGE,   
    ROW,    
    NUM_FIELD_TYPES
  };


  virtual void SetFieldType(int type);
  virtual int GetFieldType();

  static const char* GetFieldTypeAsString(int type);

  static int GetFieldTypeFromString(const char* type);


  static int ConvertSelectionFieldToAttributeType(int val);
  static int ConvertAttributeTypeToSelectionField(int val);


  vtkSetStringMacro(QueryString);
  vtkGetStringMacro(QueryString);

  static vtkInformationDoubleKey* EPSILON();

  static vtkInformationDoubleKey* ZBUFFER_VALUE();

  static vtkInformationIntegerKey* CONTAINING_CELLS();

  static vtkInformationIntegerKey* CONNECTED_LAYERS();

  static vtkInformationIntegerKey* CONNECTED_LAYERS_REMOVE_SEED();

  static vtkInformationIntegerKey* CONNECTED_LAYERS_REMOVE_INTERMEDIATE_LAYERS();

  static vtkInformationIntegerKey* COMPONENT_NUMBER();

  static vtkInformationIntegerKey* INVERSE();

  static vtkInformationIntegerKey* PIXEL_COUNT();

  static vtkInformationObjectBaseKey* SOURCE();

  static vtkInformationIntegerKey* SOURCE_ID();

  static vtkInformationObjectBaseKey* PROP();

  static vtkInformationIntegerKey* PROP_ID();

  static vtkInformationIntegerKey* PROCESS_ID();


  static vtkInformationStringKey* ASSEMBLY_NAME();
  static vtkInformationStringVectorKey* SELECTORS();

  static vtkInformationIntegerKey* COMPOSITE_INDEX();


  static vtkInformationIntegerKey* HIERARCHICAL_LEVEL();
  static vtkInformationIntegerKey* HIERARCHICAL_INDEX();


  static vtkInformationIntegerKey* CELLGRID_CELL_TYPE_INDEX();
  static vtkInformationIntegerKey* CELLGRID_SOURCE_SPECIFICATION_INDEX();

  void UnionSelectionList(vtkSelectionNode* other);

  void SubtractSelectionList(vtkSelectionNode* other);

  bool EqualProperties(vtkSelectionNode* other, bool fullcompare = true);

protected:
  vtkSelectionNode();
  ~vtkSelectionNode() override;

  vtkInformation* Properties;
  vtkDataSetAttributes* SelectionData;
  char* QueryString;

  // Map from content type to content type name
  static const char ContentTypeNames[SelectionContent::NUM_CONTENT_TYPES][16];

  // Map from integer field type to field type name
  static const char FieldTypeNames[SelectionField::NUM_FIELD_TYPES][8];

private:
  vtkSelectionNode(const vtkSelectionNode&) = delete;
  void operator=(const vtkSelectionNode&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif