dox/Filtering/vtkSelection.h

Go to the documentation of this file.

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

  Program:   ParaView
  Module:    $RCSfile: vtkSelection.h,v $

  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 __vtkSelection_h
#define __vtkSelection_h

#include "vtkDataObject.h"

//BTX
class vtkAbstractArray;
class vtkFieldData;
class vtkInformation;
class vtkInformationIntegerKey;
class vtkInformationObjectBaseKey;
class vtkTable;
struct vtkSelectionInternals;
//ETX

class VTK_FILTERING_EXPORT vtkSelection : public vtkDataObject
{
public:
  vtkTypeRevisionMacro(vtkSelection,vtkDataObject);
  void PrintSelf(ostream& os, vtkIndent indent);
  static vtkSelection* New();

  virtual void Initialize();
  
  virtual int GetDataObjectType() {return VTK_SELECTION;}

  virtual void SetSelectionList(vtkAbstractArray*);

  virtual vtkAbstractArray* GetSelectionList();

  virtual void SetSelectionData(vtkFieldData* data) { this->SetFieldData(data); }
  
  virtual vtkFieldData* GetSelectionData() { return this->GetFieldData(); }
  

  vtkGetObjectMacro(Properties, vtkInformation);

  unsigned int GetNumberOfChildren();

  virtual vtkSelection* GetChild(unsigned int idx);


  virtual vtkSelection* GetParentNode()
    {
      return this->ParentNode;
    }

  virtual void AddChild(vtkSelection*);


  virtual void RemoveChild(unsigned int idx);
  virtual void RemoveChild(vtkSelection*);
  virtual void RemoveAllChildren();

  virtual void Clear();

  virtual void DeepCopy(vtkDataObject* src);

  virtual void ShallowCopy(vtkDataObject* src);

  virtual void CopyChildren(vtkSelection*);
  
  virtual void Union(vtkSelection* selection);

  unsigned long GetMTime();

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

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

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

  virtual void SetFieldType(int type);
  virtual int GetFieldType();
  
  static vtkInformationDoubleKey* EPSILON();

  static vtkInformationIntegerKey* CONTAINING_CELLS();

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


  static vtkSelection* GetData(vtkInformation* info);
  static vtkSelection* GetData(vtkInformationVector* v, int i=0);

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

  void UnionSelectionList(vtkSelection* other);


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

  vtkInformation* Properties;
  vtkSelection* ParentNode;

private:
  vtkSelection(const vtkSelection&);  // Not implemented.
  void operator=(const vtkSelection&);  // Not implemented.

  vtkSelectionInternals* Internal;
//ETX
};

#endif

---