dox/Common/Core/vtkArrayCoordinates.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkArrayCoordinates.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 __vtkArrayCoordinates_h
#define __vtkArrayCoordinates_h

#include "vtkCommonCoreModule.h" // For export macro
#include "vtkSystemIncludes.h"
#include <vector>

class VTKCOMMONCORE_EXPORT vtkArrayCoordinates
{
public:
  typedef vtkIdType CoordinateT;
  typedef vtkIdType DimensionT;

  vtkArrayCoordinates();

  explicit vtkArrayCoordinates(CoordinateT i);

  vtkArrayCoordinates(CoordinateT i, CoordinateT j);

  vtkArrayCoordinates(CoordinateT i, CoordinateT j, CoordinateT k);

  DimensionT GetDimensions() const;

  void SetDimensions(DimensionT dimensions);

  CoordinateT& operator[](DimensionT i);

  const CoordinateT& operator[](DimensionT i) const;

  CoordinateT GetCoordinate(DimensionT i) const;

  void SetCoordinate(DimensionT i, const CoordinateT&);

  bool operator==(const vtkArrayCoordinates& rhs) const;


  bool operator!=(const vtkArrayCoordinates& rhs) const;
  VTKCOMMONCORE_EXPORT friend ostream& operator<<(
    ostream& stream, const vtkArrayCoordinates& rhs);

private:
  //BTX
  std::vector<CoordinateT> Storage;
  //ETX
};

#endif

// VTK-HeaderTest-Exclude: vtkArrayCoordinates.h