dox/Common/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 "vtkSystemIncludes.h"
#include "vtkArrayRange.h"
#include <vtksys/stl/vector> // STL Header

class vtkArrayCoordinates;

class VTK_COMMON_EXPORT vtkArrayExtents
{
public:
  vtkArrayExtents();
  

  explicit vtkArrayExtents(const vtkIdType i);
  // Description:
  // Create one-dimensional extents. 
  explicit vtkArrayExtents(const vtkArrayRange& i);
  

  vtkArrayExtents(const vtkIdType i, const vtkIdType j);
  // Description:
  // Create two-dimensional extents.
  vtkArrayExtents(const vtkArrayRange& i, const vtkArrayRange& j);
  

  vtkArrayExtents(const vtkIdType i, const vtkIdType j, const vtkIdType k);
  // Description:
  // Create two-dimensional extents.
  vtkArrayExtents(const vtkArrayRange& i, const vtkArrayRange& j, const vtkArrayRange& k);
  
  static const vtkArrayExtents Uniform(vtkIdType n, vtkIdType m);

  void Append(const vtkArrayRange& extent);

  vtkIdType GetDimensions() const;
  
  vtkIdType GetSize() const;

  void SetDimensions(vtkIdType dimensions);
  
  vtkArrayRange& operator[](vtkIdType i);
  
  const vtkArrayRange& operator[](vtkIdType i) const;
  
  bool operator==(const vtkArrayExtents& rhs) const;
  
  bool operator!=(const vtkArrayExtents& rhs) const;

  bool ZeroBased() const;

  bool SameShape(const vtkArrayExtents& rhs) const;


  void GetLeftToRightCoordinatesN(vtkIdType n, vtkArrayCoordinates& coordinates) const;
  // Description:
  // Returns coordinates that reference the n-th value in the extents, where
  // n is in the range [0, GetSize()).  The returned coordinates will be ordered
  // so that the right-most indices vary fastest.  The is equivalent to row-major
  // ordering for matrices, and corresponds to the order in which consecutive array
  // values would be stored in languages including C and C++.
  void GetRightToLeftCoordinatesN(vtkIdType n, vtkArrayCoordinates& coordinates) const;

  bool Contains(const vtkArrayExtents& extents) const;

  bool Contains(const vtkArrayCoordinates& coordinates) const;

  VTK_COMMON_EXPORT friend ostream& operator<<(
    ostream& stream, const vtkArrayExtents& rhs);
  
private:
  vtksys_stl::vector<vtkArrayRange> Storage;
};

#endif

---