1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
/*=========================================================================
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 "vtkCommonCoreModule.h" // For export macro
#include "vtkSystemIncludes.h"
#include "vtkArrayCoordinates.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
|
