vtkArrayExtents.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkArrayExtents.h
 
-------------------------------------------------------------------------
  Copyright 2008 Sandia Corporation.
  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
  the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------
 
  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 vtkArrayExtents_h
#define vtkArrayExtents_h
 
#include "vtkArrayRange.h"
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkSystemIncludes.h"
#include <vector> // STL Header
 
class VTKCOMMONCORE_EXPORT vtkArrayExtents
{
public:
  typedef vtkArrayCoordinates::DimensionT DimensionT;
  typedef vtkArrayCoordinates::CoordinateT CoordinateT;
  typedef vtkTypeUInt64 SizeT;
 
  vtkArrayExtents();
 
  explicit vtkArrayExtents(const CoordinateT i);
  explicit vtkArrayExtents(const vtkArrayRange& i);
 
  vtkArrayExtents(const CoordinateT i, const CoordinateT j);
  vtkArrayExtents(const vtkArrayRange& i, const vtkArrayRange& j);
 
  vtkArrayExtents(const CoordinateT i, const CoordinateT j, const CoordinateT k);
  vtkArrayExtents(const vtkArrayRange& i, const vtkArrayRange& j, const vtkArrayRange& k);
 
  static vtkArrayExtents Uniform(DimensionT n, CoordinateT m);
 
  void Append(const vtkArrayRange& extent);
 
  DimensionT GetDimensions() const;
 
  SizeT GetSize() const;
 
  void SetDimensions(DimensionT dimensions);
 
  vtkArrayRange& operator[](DimensionT i);
 
  const vtkArrayRange& operator[](DimensionT i) const;
 
  vtkArrayRange GetExtent(DimensionT i) const;
 
  void SetExtent(DimensionT i, const vtkArrayRange&);
 
  bool operator==(const vtkArrayExtents& rhs) const;
 
  bool operator!=(const vtkArrayExtents& rhs) const;
 
  bool ZeroBased() const;
 
  bool SameShape(const vtkArrayExtents& rhs) const;
 
  void GetLeftToRightCoordinatesN(SizeT n, vtkArrayCoordinates& coordinates) const;
 
  void GetRightToLeftCoordinatesN(SizeT n, vtkArrayCoordinates& coordinates) const;
 
  bool Contains(const vtkArrayExtents& extents) const;
 
  bool Contains(const vtkArrayCoordinates& coordinates) const;
 
  VTKCOMMONCORE_EXPORT friend ostream& operator<<(ostream& stream, const vtkArrayExtents& rhs);
 
private:
  std::vector<vtkArrayRange> Storage;
};
 
#endif
// VTK-HeaderTest-Exclude: vtkArrayExtents.h