VTK
vtkPoints.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkPoints.h
5
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13
14=========================================================================*/
29#ifndef vtkPoints_h
30#define vtkPoints_h
31
32#include "vtkCommonCoreModule.h" // For export macro
33#include "vtkObject.h"
34
35#include "vtkDataArray.h" // Needed for inline methods
36
37class vtkIdList;
38
39class VTKCOMMONCORE_EXPORT vtkPoints : public vtkObject
40{
41public:
42
43 static vtkPoints *New(int dataType);
44
45 static vtkPoints *New();
46
47 vtkTypeMacro(vtkPoints,vtkObject);
48 void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
49
53 virtual int Allocate(const vtkIdType sz, const vtkIdType ext = 1000);
54
58 virtual void Initialize();
59
68 virtual void SetData(vtkDataArray *);
69 vtkDataArray *GetData() { return this->Data; }
70
75 virtual int GetDataType();
76
80 virtual void SetDataType(int dataType);
81 void SetDataTypeToBit() { this->SetDataType(VTK_BIT); }
82 void SetDataTypeToChar() { this->SetDataType(VTK_CHAR); }
83 void SetDataTypeToUnsignedChar() { this->SetDataType(VTK_UNSIGNED_CHAR); }
84 void SetDataTypeToShort() { this->SetDataType(VTK_SHORT); }
85 void SetDataTypeToUnsignedShort() { this->SetDataType(VTK_UNSIGNED_SHORT); }
86 void SetDataTypeToInt() { this->SetDataType(VTK_INT); }
87 void SetDataTypeToUnsignedInt() { this->SetDataType(VTK_UNSIGNED_INT); }
88 void SetDataTypeToLong() { this->SetDataType(VTK_LONG); }
89 void SetDataTypeToUnsignedLong() { this->SetDataType(VTK_UNSIGNED_LONG); }
90 void SetDataTypeToFloat() { this->SetDataType(VTK_FLOAT); }
91 void SetDataTypeToDouble() { this->SetDataType(VTK_DOUBLE); }
92
97 void *GetVoidPointer(const int id) { return this->Data->GetVoidPointer(id); }
98
102 virtual void Squeeze() { this->Data->Squeeze(); }
103
107 virtual void Reset();
108
110
115 virtual void DeepCopy(vtkPoints *ad);
116 virtual void ShallowCopy(vtkPoints *ad);
118
127 unsigned long GetActualMemorySize();
128
132 vtkIdType GetNumberOfPoints() { return this->Data->GetNumberOfTuples(); }
133
140 double *GetPoint(vtkIdType id) { return this->Data->GetTuple(id); }
141
146 void GetPoint(vtkIdType id, double x[3]) { this->Data->GetTuple(id,x); }
147
153 void SetPoint(vtkIdType id, const float x[3]) { this->Data->SetTuple(id,x); }
154 void SetPoint(vtkIdType id, const double x[3]) { this->Data->SetTuple(id,x); }
155 void SetPoint(vtkIdType id, double x, double y, double z);
156
158
162 void InsertPoint(vtkIdType id, const float x[3])
163 { this->Data->InsertTuple(id,x);};
164 void InsertPoint(vtkIdType id, const double x[3])
165 {this->Data->InsertTuple(id,x);};
166 void InsertPoint(vtkIdType id, double x, double y, double z);
168
175 { this->Data->InsertTuples(dstIds, srcIds, source->Data); }
176
182 void InsertPoints(vtkIdType dstStart, vtkIdType n, vtkIdType srcStart,
184 { this->Data->InsertTuples(dstStart, n, srcStart, source->Data); }
185
189 vtkIdType InsertNextPoint(const float x[3])
190 { return this->Data->InsertNextTuple(x); }
191 vtkIdType InsertNextPoint(const double x[3])
192 { return this->Data->InsertNextTuple(x); }
193 vtkIdType InsertNextPoint(double x, double y, double z);
194
200 void SetNumberOfPoints(vtkIdType numPoints);
201
206 int Resize(vtkIdType numPoints);
207
211 void GetPoints(vtkIdList *ptId, vtkPoints *fp);
212
216 virtual void ComputeBounds();
217
221 double *GetBounds();
222
226 void GetBounds(double bounds[6]);
227
231 vtkMTimeType GetMTime() VTK_OVERRIDE;
232
233protected:
234 vtkPoints(int dataType = VTK_FLOAT);
235 ~vtkPoints() VTK_OVERRIDE;
236
237 double Bounds[6];
238 vtkTimeStamp ComputeTime; // Time at which bounds computed
239 vtkDataArray *Data; // Array which represents data
240
241private:
242 vtkPoints(const vtkPoints&) VTK_DELETE_FUNCTION;
243 void operator=(const vtkPoints&) VTK_DELETE_FUNCTION;
244};
245
246inline void vtkPoints::Reset()
247{
248 this->Data->Reset();
249 this->Modified();
250}
251
253{
254 this->Data->SetNumberOfComponents(3);
255 this->Data->SetNumberOfTuples(numPoints);
256 this->Modified();
257}
258
259inline int vtkPoints::Resize(vtkIdType numPoints)
260{
261 this->Data->SetNumberOfComponents(3);
262 this->Modified();
263 return this->Data->Resize(numPoints);
264}
265
266inline void vtkPoints::SetPoint(vtkIdType id, double x, double y, double z)
267{
268 double p[3] = { x, y, z };
269 this->Data->SetTuple(id, p);
270}
271
272inline void vtkPoints::InsertPoint(vtkIdType id, double x, double y, double z)
273{
274 double p[3] = { x, y, z };
275 this->Data->InsertTuple(id, p);
276}
277
278inline vtkIdType vtkPoints::InsertNextPoint(double x, double y, double z)
279{
280 double p[3] = { x, y, z };
281 return this->Data->InsertNextTuple(p);
282}
283
284#endif
285
void Reset()
Reset to an empty state, without freeing any memory.
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:55
list of point or cell ids
Definition: vtkIdList.h:37
a simple class to control print indentation
Definition: vtkIndent.h:40
abstract base class for most VTK objects
Definition: vtkObject.h:60
virtual void Modified()
Update the modification time for this object.
represent and manipulate 3D points
Definition: vtkPoints.h:40
void SetPoint(vtkIdType id, const double x[3])
Definition: vtkPoints.h:154
void SetDataTypeToUnsignedShort()
Definition: vtkPoints.h:85
void SetPoint(vtkIdType id, const float x[3])
Insert point into object.
Definition: vtkPoints.h:153
void SetDataTypeToChar()
Definition: vtkPoints.h:82
vtkMTimeType GetMTime() override
The modified time of the points.
void InsertPoint(vtkIdType id, const double x[3])
Definition: vtkPoints.h:164
void SetDataTypeToInt()
Definition: vtkPoints.h:86
virtual void ComputeBounds()
Determine (xmin,xmax, ymin,ymax, zmin,zmax) bounds of points.
void SetDataTypeToLong()
Definition: vtkPoints.h:88
void InsertPoints(vtkIdList *dstIds, vtkIdList *srcIds, vtkPoints *source)
Copy the points indexed in srcIds from the source array to the tuple locations indexed by dstIds in t...
Definition: vtkPoints.h:174
vtkIdType GetNumberOfPoints()
Return number of points in array.
Definition: vtkPoints.h:132
double * GetBounds()
Return the bounds of the points.
virtual void Initialize()
Return object to instantiated state.
virtual void Squeeze()
Reclaim any extra memory.
Definition: vtkPoints.h:102
virtual int GetDataType()
Return the underlying data type.
void GetPoints(vtkIdList *ptId, vtkPoints *fp)
Given a list of pt ids, return an array of points.
void SetDataTypeToUnsignedLong()
Definition: vtkPoints.h:89
void SetDataTypeToUnsignedChar()
Definition: vtkPoints.h:83
static vtkPoints * New(int dataType)
void GetBounds(double bounds[6])
Return the bounds of the points.
vtkDataArray * GetData()
Definition: vtkPoints.h:69
virtual void SetData(vtkDataArray *)
Set/Get the underlying data array.
double * GetPoint(vtkIdType id)
Return a pointer to a double point x[3] for a specific id.
Definition: vtkPoints.h:140
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void SetDataTypeToUnsignedInt()
Definition: vtkPoints.h:87
void * GetVoidPointer(const int id)
Return a void pointer.
Definition: vtkPoints.h:97
void GetPoint(vtkIdType id, double x[3])
Copy point components into user provided array v[3] for specified id.
Definition: vtkPoints.h:146
void SetDataTypeToShort()
Definition: vtkPoints.h:84
void SetDataTypeToDouble()
Definition: vtkPoints.h:91
virtual void DeepCopy(vtkPoints *ad)
Different ways to copy data.
void SetNumberOfPoints(vtkIdType numPoints)
Specify the number of points for this object to hold.
Definition: vtkPoints.h:252
void InsertPoint(vtkIdType id, const float x[3])
Insert point into object.
Definition: vtkPoints.h:162
void SetDataTypeToBit()
Definition: vtkPoints.h:81
static vtkPoints * New()
virtual int Allocate(const vtkIdType sz, const vtkIdType ext=1000)
Allocate initial memory size.
int Resize(vtkIdType numPoints)
Resize the internal array while conserving the data.
Definition: vtkPoints.h:259
unsigned long GetActualMemorySize()
Return the memory in kibibytes (1024 bytes) consumed by this attribute data.
virtual void ShallowCopy(vtkPoints *ad)
vtkIdType InsertNextPoint(const float x[3])
Insert point into next available slot.
Definition: vtkPoints.h:189
void InsertPoints(vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkPoints *source)
Copy n consecutive points starting at srcStart from the source array to this array,...
Definition: vtkPoints.h:182
virtual void SetDataType(int dataType)
Specify the underlying data type of the object.
void SetDataTypeToFloat()
Definition: vtkPoints.h:90
vtkIdType InsertNextPoint(const double x[3])
Definition: vtkPoints.h:191
record modification and/or execution time
Definition: vtkTimeStamp.h:36
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
#define VTK_SHORT
Definition: vtkType.h:52
int vtkIdType
Definition: vtkType.h:287
vtkTypeUInt64 vtkMTimeType
Definition: vtkType.h:248
#define VTK_UNSIGNED_INT
Definition: vtkType.h:55
#define VTK_DOUBLE
Definition: vtkType.h:59
#define VTK_UNSIGNED_CHAR
Definition: vtkType.h:51
#define VTK_UNSIGNED_SHORT
Definition: vtkType.h:53
#define VTK_INT
Definition: vtkType.h:54
#define VTK_FLOAT
Definition: vtkType.h:58
#define VTK_CHAR
Definition: vtkType.h:49
#define VTK_UNSIGNED_LONG
Definition: vtkType.h:57
#define VTK_BIT
Definition: vtkType.h:48
#define VTK_LONG
Definition: vtkType.h:56