vtkSphereTree.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkSphereTree.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm 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 vtkSphereTree_h
#define vtkSphereTree_h

#include "vtkCommonExecutionModelModule.h" // For export macro
#include "vtkPlane.h" // to specify the cutting plane
#include "vtkObject.h"

class vtkDoubleArray;
class vtkDataArray;
class vtkIdList;
class vtkDataSet;
class vtkStructuredGrid;
class vtkUnstructuredGrid;
class vtkTimeStamp;
struct vtkSphereTreeHierarchy;

#define VTK_MAX_SPHERE_TREE_RESOLUTION 10
#define VTK_MAX_SPHERE_TREE_LEVELS 20

// VTK Class proper
class VTKCOMMONEXECUTIONMODEL_EXPORT vtkSphereTree : public vtkObject
{
public:
  static vtkSphereTree *New();


  vtkTypeMacro(vtkSphereTree,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  virtual void SetDataSet(vtkDataSet*);
  vtkGetObjectMacro(DataSet,vtkDataSet);


  void Build();
  void Build(vtkDataSet *input);


  vtkSetMacro(BuildHierarchy, bool);
  vtkGetMacro(BuildHierarchy, bool);
  vtkBooleanMacro(BuildHierarchy, bool);


  const unsigned char *SelectPoint(double point[3],
                                   vtkIdType &numSelected);
  const unsigned char *SelectLine(double origin[3], double ray[3],
                                  vtkIdType &numSelected);
  const unsigned char *SelectPlane(double origin[3], double normal[3],
                                   vtkIdType &numSelected);


  void SelectPoint(double point[3], vtkIdList *cellIds);
  void SelectLine(double origin[3], double ray[3], vtkIdList *cellIds);
  void SelectPlane(double origin[3], double normal[3], vtkIdList *cellIds);


  vtkSetClampMacro(Resolution,int,2,VTK_MAX_SPHERE_TREE_RESOLUTION);
  vtkGetMacro(Resolution,int);


  vtkSetClampMacro(MaxLevel,int,1,VTK_MAX_SPHERE_TREE_LEVELS);
  vtkGetMacro(MaxLevel,int);

  vtkGetMacro(NumberOfLevels,int);


  const double *GetCellSpheres();
  const double *GetTreeSpheres(int level, vtkIdType &numSpheres);

protected:
  vtkSphereTree();
  ~vtkSphereTree() override;

  // Data members
  vtkDataSet *DataSet;
  unsigned char *Selected;
  int Resolution;
  int MaxLevel;
  int NumberOfLevels;
  bool BuildHierarchy;

  // The tree and its hierarchy
  vtkDoubleArray *Tree;
  double         *TreePtr;
  vtkSphereTreeHierarchy *Hierarchy;

  // Supporting data members
  double AverageRadius; //average radius of cell sphere
  double SphereBounds[6]; //the dataset bounds computed from cell spheres
  vtkTimeStamp BuildTime; //time at which tree was built

  // Supporting methods
  void BuildTreeSpheres(vtkDataSet *input);
  void ExtractCellIds(const unsigned char *selected, vtkIdList *cellIds,
                      vtkIdType numSelected);

  void BuildTreeHierarchy(vtkDataSet *input);
  void BuildStructuredHierarchy(vtkStructuredGrid *input, double *tree);
  void BuildUnstructuredHierarchy(vtkDataSet *input, double *tree);
  int SphereTreeType; //keep track of the type of tree hierarchy generated

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

};

#endif