common/vtkLocator.h Source File

00001 /*=========================================================================
00002 
00003   Program:   Visualization Toolkit
00004   Module:    $RCSfile: vtkLocator.h,v $
00005   Language:  C++
00006 
00007 
00008 Copyright (c) 1993-2001 Ken Martin, Will Schroeder, Bill Lorensen 
00009 All rights reserved.
00010 
00011 Redistribution and use in source and binary forms, with or without
00012 modification, are permitted provided that the following conditions are met:
00013 
00014  * Redistributions of source code must retain the above copyright notice,
00015    this list of conditions and the following disclaimer.
00016 
00017  * Redistributions in binary form must reproduce the above copyright notice,
00018    this list of conditions and the following disclaimer in the documentation
00019    and/or other materials provided with the distribution.
00020 
00021  * Neither name of Ken Martin, Will Schroeder, or Bill Lorensen nor the names
00022    of any contributors may be used to endorse or promote products derived
00023    from this software without specific prior written permission.
00024 
00025  * Modified source versions must be plainly marked as such, and must not be
00026    misrepresented as being the original software.
00027 
00028 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
00029 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00030 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00031 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
00032 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00033 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00034 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00035 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00036 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00037 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00038 
00039 =========================================================================*/
00078 #ifndef __vtkLocator_h
00079 #define __vtkLocator_h
00080 
00081 #include "vtkObject.h"
00082 #include "vtkDataSet.h"
00083 class vtkPolyData;
00084 
00085 class VTK_EXPORT vtkLocator : public vtkObject
00086 {
00087 public:
00088   vtkTypeMacro(vtkLocator,vtkObject);
00089   void PrintSelf(ostream& os, vtkIndent indent);
00090 
00092   vtkSetObjectMacro(DataSet,vtkDataSet);
00093   vtkGetObjectMacro(DataSet,vtkDataSet);
00094 
00097   vtkSetClampMacro(MaxLevel,int,0,VTK_LARGE_INTEGER);
00098   vtkGetMacro(MaxLevel,int);
00099 
00103   vtkGetMacro(Level,int);
00104 
00109   vtkSetMacro(Automatic,int);
00110   vtkGetMacro(Automatic,int);
00111   vtkBooleanMacro(Automatic,int);
00112 
00115   vtkSetClampMacro(Tolerance,float,0.0,VTK_LARGE_FLOAT);
00116   vtkGetMacro(Tolerance,float);
00117 
00122   vtkSetMacro(RetainCellLists,int);
00123   vtkGetMacro(RetainCellLists,int);
00124   vtkBooleanMacro(RetainCellLists,int);
00125 
00128   virtual void Update();
00129 
00131   virtual void Initialize();
00132 
00134   virtual void BuildLocator() = 0;
00135 
00137   virtual void FreeSearchStructure() = 0;
00138 
00143   virtual void GenerateRepresentation(int level, vtkPolyData *pd) = 0;
00144 
00146   vtkGetMacro(BuildTime, unsigned long);
00147 
00148 protected:
00149   vtkLocator();
00150   ~vtkLocator();
00151   vtkLocator(const vtkLocator&) {};
00152   void operator=(const vtkLocator&) {};
00153 
00154   vtkDataSet *DataSet;
00155   int Automatic; // boolean controls automatic subdivision (or uses user spec.)
00156   float Tolerance; // for performing merging
00157   int MaxLevel;
00158   int Level;
00159   int RetainCellLists;
00160 
00161   vtkTimeStamp BuildTime;  // time at which locator was built
00162 
00163 };
00164 
00165 #endif
00166 
00167