vtkSelectionNode.h

Go to the documentation of this file.

/*=========================================================================

  Program:   ParaView
  Module:    vtkSelectionNode.h

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkSelectionNode_h
#define vtkSelectionNode_h

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

class vtkAbstractArray;
class vtkDataSetAttributes;
class vtkInformation;
class vtkInformationDoubleKey;
class vtkInformationIntegerKey;
class vtkInformationObjectBaseKey;
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
  {
    SELECTIONS,   
    GLOBALIDS,    
    PEDIGREEIDS,  
    VALUES,       
    INDICES,      
    FRUSTUM,      
    LOCATIONS,    
    THRESHOLDS,   
    BLOCKS,       
    QUERY,        
    USER          
  };


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

  static vtkInformationIntegerKey* FIELD_TYPE();

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


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


  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* 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 vtkInformationIntegerKey* COMPOSITE_INDEX();


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

  static vtkInformationIntegerKey* INDEXED_VERTICES();

  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;

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

};

#endif