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"

//BTX
class vtkAbstractArray;
class vtkDataSetAttributes;
class vtkInformation;
class vtkInformationDoubleKey;
class vtkInformationIntegerKey;
class vtkInformationObjectBaseKey;
class vtkProp;
class vtkTable;
//ETX

class VTKCOMMONDATAMODEL_EXPORT vtkSelectionNode : public vtkObject
{
public:
  vtkTypeMacro(vtkSelectionNode,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);
  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);

  unsigned long GetMTime();

  // vtkSelectionNode specific keys follow:

  static vtkInformationIntegerKey* CONTENT_TYPE();
//BTX
  enum SelectionContent
  {
    SELECTIONS,  // Deprecated.
    GLOBALIDS,
    PEDIGREEIDS,
    VALUES,
    INDICES,
    FRUSTUM,
    LOCATIONS,
    THRESHOLDS,
    BLOCKS,       // used to select blocks within a composite dataset.
    QUERY
  };
//ETX


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


  static vtkInformationIntegerKey* FIELD_TYPE();
//BTX
  enum SelectionField
  {
    CELL,
    POINT,
    FIELD,
    VERTEX,
    EDGE,
    ROW
  };
//ETX


  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 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);

//BTX
protected:
  vtkSelectionNode();
  ~vtkSelectionNode();

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

private:
  vtkSelectionNode(const vtkSelectionNode&);  // Not implemented.
  void operator=(const vtkSelectionNode&);  // Not implemented.
//ETX
};

#endif