You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
117 lines
2.9 KiB
C++
117 lines
2.9 KiB
C++
/*=========================================================================
|
|
|
|
Program: Visualization Toolkit
|
|
Module: vtkArrayRange.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.
|
|
|
|
=========================================================================*/
|
|
|
|
/**
|
|
* @class vtkArrayRange
|
|
* @brief Stores a half-open range of array coordinates.
|
|
*
|
|
*
|
|
* vtkArrayRange stores a half-open range of array coordinates along a
|
|
* single dimension of a vtkArraySlice object.
|
|
*
|
|
* @sa
|
|
* vtkArray, vtkArrayRange
|
|
*
|
|
* @par Thanks:
|
|
* Developed by Timothy M. Shead (tshead@sandia.gov) at Sandia National
|
|
* Laboratories.
|
|
*/
|
|
|
|
#ifndef vtkArrayRange_h
|
|
#define vtkArrayRange_h
|
|
|
|
#include "vtkArrayCoordinates.h"
|
|
#include "vtkCommonCoreModule.h" // For export macro
|
|
#include "vtkSystemIncludes.h"
|
|
|
|
class VTKCOMMONCORE_EXPORT vtkArrayRange
|
|
{
|
|
public:
|
|
typedef vtkArrayCoordinates::CoordinateT CoordinateT;
|
|
|
|
/**
|
|
* Creates an empty range.
|
|
*/
|
|
vtkArrayRange();
|
|
|
|
/**
|
|
* Creates a half-open range [begin, end).
|
|
* Note that begin must be <= end,
|
|
* if not, creates the empty range [begin, begin).
|
|
*/
|
|
vtkArrayRange(CoordinateT begin, CoordinateT end);
|
|
|
|
/**
|
|
* Returns the beginning of the range
|
|
*/
|
|
CoordinateT GetBegin() const;
|
|
|
|
/**
|
|
* Returns one-past-the-end of the range
|
|
*/
|
|
CoordinateT GetEnd() const;
|
|
|
|
/**
|
|
* Returns the size of the range (the distance End - Begin).
|
|
*/
|
|
CoordinateT GetSize() const;
|
|
|
|
/**
|
|
* Returns true iff the given range is a non-overlapping subset of this
|
|
* range.
|
|
*/
|
|
bool Contains(const vtkArrayRange& range) const;
|
|
|
|
/**
|
|
* Returns true iff the given coordinate falls within this range.
|
|
*/
|
|
bool Contains(const CoordinateT coordinate) const;
|
|
|
|
//@{
|
|
/**
|
|
* Equality comparisons.
|
|
*/
|
|
VTKCOMMONCORE_EXPORT friend bool operator==(const vtkArrayRange& lhs, const vtkArrayRange& rhs);
|
|
VTKCOMMONCORE_EXPORT friend bool operator!=(const vtkArrayRange& lhs, const vtkArrayRange& rhs);
|
|
//@}
|
|
|
|
/**
|
|
* Serialization.
|
|
*/
|
|
VTKCOMMONCORE_EXPORT friend ostream& operator<<(ostream& stream, const vtkArrayRange& rhs);
|
|
|
|
private:
|
|
/**
|
|
* Stores the beginning of the range.
|
|
*/
|
|
CoordinateT Begin;
|
|
|
|
//@{
|
|
/**
|
|
* Stores one-past-the-end of the range.
|
|
*/
|
|
CoordinateT End;
|
|
//@}
|
|
};
|
|
|
|
#endif
|
|
// VTK-HeaderTest-Exclude: vtkArrayRange.h
|