Common/vtkExtentTranslator.h Source File

00001 /*=========================================================================
00002 
00003   Program:   Visualization Toolkit
00004   Module:    $RCSfile: vtkExtentTranslator.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 =========================================================================*/
00055 #ifndef __vtkExtentTranslator_h
00056 #define __vtkExtentTranslator_h
00057 
00058 #include "vtkObject.h"
00059 
00060 
00061 class VTK_COMMON_EXPORT vtkExtentTranslator : public vtkObject
00062 {
00063 public:
00064   static vtkExtentTranslator *New();
00065 
00066   vtkTypeMacro(vtkExtentTranslator,vtkObject);
00067   void PrintSelf(ostream& os, vtkIndent indent);
00068 
00070 
00072   vtkSetVector6Macro(WholeExtent, int);
00073   vtkGetVector6Macro(WholeExtent, int);
00074   vtkSetVector6Macro(Extent, int);
00075   vtkGetVector6Macro(Extent, int);
00076   vtkSetMacro(Piece,int);
00077   vtkGetMacro(Piece,int);
00078   vtkSetMacro(NumberOfPieces,int);
00079   vtkGetMacro(NumberOfPieces,int);
00080   vtkSetMacro(GhostLevel, int);
00081   vtkGetMacro(GhostLevel, int);
00083 
00085 
00090   virtual int PieceToExtent();
00091   virtual int PieceToExtentByPoints();
00092   virtual int PieceToExtentThreadSafe(int piece, int numPieces, 
00093                                       int ghostLevel, int *wholeExtent, 
00094                                       int *resultExtent, int splitMode, 
00095                                       int byPoints);
00097   
00098   
00099   
00101 
00105   void SetSplitModeToBlock()
00106     {this->SplitMode = vtkExtentTranslator::BLOCK_MODE;}
00107   void SetSplitModeToXSlab()
00108     {this->SplitMode = vtkExtentTranslator::X_SLAB_MODE;}
00109  void SetSplitModeToYSlab()
00110     {this->SplitMode = vtkExtentTranslator::Y_SLAB_MODE;}
00111  void SetSplitModeToZSlab()
00112     {this->SplitMode = vtkExtentTranslator::Z_SLAB_MODE;}
00113   vtkGetMacro(SplitMode,int);
00115   
00116 protected:
00117   vtkExtentTranslator();
00118   ~vtkExtentTranslator();
00119 
00121 
00123   int SplitExtent(int piece, int numPieces, int *extent, int splitMode);  
00124   int SplitExtentByPoints(int piece, int numPieces, int *extent, 
00125                           int splitMode);  
00127 
00128   int Piece;
00129   int NumberOfPieces;
00130   int GhostLevel;
00131   int Extent[6];
00132   int WholeExtent[6];
00133   int SplitMode;
00134 
00135 //BTX
00136   // Don't change the numbers here - they are used in the code
00137   // to indicate array indices.
00138   enum Modes {
00139     X_SLAB_MODE=0,
00140     Y_SLAB_MODE=1,
00141     Z_SLAB_MODE=2,
00142     BLOCK_MODE= 3
00143   };
00144 //ETX
00145 
00146 private:
00147   vtkExtentTranslator(const vtkExtentTranslator&);  // Not implemented.
00148   void operator=(const vtkExtentTranslator&);  // Not implemented.
00149 };
00150 
00151 #endif
00152