VTK
vtkPeriodicDataArray.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkPeriodicDataArray.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=========================================================================*/
15
29#ifndef vtkPeriodicDataArray_h
30#define vtkPeriodicDataArray_h
31
32#include "vtkGenericDataArray.h" // Parent
33#include "vtkAOSDataArrayTemplate.h" // Template
34
35template <class Scalar>
37 public vtkGenericDataArray<vtkPeriodicDataArray<Scalar>, Scalar>
38{
40public:
42 typedef typename Superclass::ValueType ValueType;
43
44 void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
45
50
54 void Initialize() VTK_OVERRIDE;
55
59 void GetTuples(vtkIdList *ptIds, vtkAbstractArray *output) VTK_OVERRIDE;
60
64 void GetTuples(vtkIdType p1, vtkIdType p2, vtkAbstractArray *output) VTK_OVERRIDE;
65
69 void Squeeze() VTK_OVERRIDE;
70
75
80
84 void LookupValue(vtkVariant value, vtkIdList *ids) VTK_OVERRIDE;
85
90
94 void ClearLookup() VTK_OVERRIDE;
95
100 double* GetTuple(vtkIdType i) VTK_OVERRIDE;
101
105 void GetTuple(vtkIdType i, double *tuple) VTK_OVERRIDE;
106
110 vtkIdType LookupTypedValue(Scalar value) VTK_OVERRIDE;
111
115 void LookupTypedValue(Scalar value, vtkIdList *ids) VTK_OVERRIDE;
116
123
130
134 void GetTypedTuple(vtkIdType idx, Scalar *t) const;
135
141 ValueType GetTypedComponent(vtkIdType tupleIdx, int compIdx) const;
142
146 unsigned long GetActualMemorySize() VTK_OVERRIDE;
147
151 int Allocate(vtkIdType sz, vtkIdType ext) VTK_OVERRIDE;
152
156 int Resize(vtkIdType numTuples) VTK_OVERRIDE;
157
161 void SetNumberOfTuples(vtkIdType number) VTK_OVERRIDE;
162
167
171 void SetTuple(vtkIdType i, const float *source) VTK_OVERRIDE;
172
176 void SetTuple(vtkIdType i, const double *source) VTK_OVERRIDE;
177
182
186 void InsertTuple(vtkIdType i, const float *source) VTK_OVERRIDE;
187
191 void InsertTuple(vtkIdType i, const double *source) VTK_OVERRIDE;
192
196 void InsertTuples(vtkIdList *dstIds, vtkIdList *srcIds,
197 vtkAbstractArray *source) VTK_OVERRIDE;
198
202 void InsertTuples(vtkIdType dstStart, vtkIdType n, vtkIdType srcStart,
203 vtkAbstractArray* source) VTK_OVERRIDE;
204
209
213 vtkIdType InsertNextTuple(const float *source) VTK_OVERRIDE;
214
218 vtkIdType InsertNextTuple(const double *source) VTK_OVERRIDE;
219
223 void DeepCopy(vtkAbstractArray *aa) VTK_OVERRIDE;
224
228 void DeepCopy(vtkDataArray *da) VTK_OVERRIDE;
229
234 vtkAbstractArray* source, double* weights) VTK_OVERRIDE;
235
240 vtkIdType id2, vtkAbstractArray *source2, double t) VTK_OVERRIDE;
241
245 void SetVariantValue(vtkIdType idx, vtkVariant value) VTK_OVERRIDE;
246
251
255 void RemoveTuple(vtkIdType id) VTK_OVERRIDE;
256
260 void RemoveFirstTuple() VTK_OVERRIDE;
261
265 void RemoveLastTuple() VTK_OVERRIDE;
266
270 void SetTypedTuple(vtkIdType i, const Scalar *t);
271
275 void SetTypedComponent(vtkIdType t, int c, Scalar v);
276
280 void InsertTypedTuple(vtkIdType i, const Scalar *t);
281
286
290 void SetValue(vtkIdType idx, Scalar value);
291
296
300 void InsertValue(vtkIdType idx, Scalar v);
301
303
307 vtkGetMacro(Normalize, bool);
309
310protected:
313
315
318 bool AllocateTuples(vtkIdType numTuples);
321
325 virtual void Transform(Scalar* tuple) const = 0;
326
330 bool ComputeScalarRange(double* range) VTK_OVERRIDE;
331
335 bool ComputeVectorRange(double range[2]) VTK_OVERRIDE;
336
340 virtual void ComputePeriodicRange();
341
346
347 bool Normalize; // If transformed vector must be normalized
348
349private:
350 vtkPeriodicDataArray(const vtkPeriodicDataArray &) VTK_DELETE_FUNCTION;
351 void operator=(const vtkPeriodicDataArray &) VTK_DELETE_FUNCTION;
352
353 friend class vtkGenericDataArray<vtkPeriodicDataArray<Scalar>, Scalar>;
354
355 Scalar* TempScalarArray; // Temporary array used by GetTypedTuple methods
356 double* TempDoubleArray; // Temporary array used by GetTuple vethods
357 vtkIdType TempTupleIdx; // Location of currently stored Temp Tuple to use as cache
358 vtkAOSDataArrayTemplate<Scalar>* Data; // Original data
359
360 bool InvalidRange;
361 double PeriodicRange[6]; // Transformed periodic range
362};
363
364#include "vtkPeriodicDataArray.txx"
365
366#endif //vtkPeriodicDataArray_h
367// VTK-HeaderTest-Exclude: vtkPeriodicDataArray.h
Abstract superclass for all arrays.
Abstract superclass to iterate over elements in an vtkAbstractArray.
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:55
Base interface for all typed vtkDataArray subclasses.
vtkTemplateTypeMacro(SelfType, vtkDataArray) enum
Compile time access to the VTK type identifier.
list of point or cell ids
Definition: vtkIdList.h:37
a simple class to control print indentation
Definition: vtkIndent.h:40
Map native an Array into an angulat periodic array.
void InsertTypedTuple(vtkIdType i, const Scalar *t)
Read only container, not supported.
void GetTuples(vtkIdList *ptIds, vtkAbstractArray *output) override
Copy tuples values, selected by ptIds into provided array.
virtual void ComputePeriodicRange()
Update the transformed periodic range.
int Resize(vtkIdType numTuples) override
Read only container, not supported.
bool AllocateTuples(vtkIdType numTuples)
Read only container, not supported.
void ClearLookup() override
Not implemented.
int Allocate(vtkIdType sz, vtkIdType ext) override
Read only container, not supported.
vtkIdType LookupTypedValue(Scalar value) override
Not implemented.
VTK_NEWINSTANCE vtkArrayIterator * NewIterator() override
Not implemented.
void SetNumberOfTuples(vtkIdType number) override
Read only container, not supported.
bool ComputeScalarRange(double *range) override
Get the transformed range by components.
vtkIdType InsertNextTuple(vtkIdType j, vtkAbstractArray *source) override
Read only container, error.
void RemoveTuple(vtkIdType id) override
Read only container, not supported.
void SetValue(vtkIdType idx, Scalar value)
Read only container, not supported.
void DeepCopy(vtkAbstractArray *aa) override
Read only container, not supported.
void InsertVariantValue(vtkIdType idx, vtkVariant value) override
Read only container, not supported.
ValueType & GetValueReference(vtkIdType idx)
Get value at index idx as reference.
vtkIdType InsertNextTypedTuple(const Scalar *t)
Read only container, not supported.
void SetTuple(vtkIdType i, vtkIdType j, vtkAbstractArray *source) override
Read only container, not supported.
vtkTemplateTypeMacro(vtkPeriodicDataArray< Scalar >, GenericBase) typedef typename Superclass void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void InsertTuple(vtkIdType i, vtkIdType j, vtkAbstractArray *source) override
Read only container, not supported.
void GetTypedTuple(vtkIdType idx, Scalar *t) const
Copy tuple value at location idx into provided array.
void SetTypedComponent(vtkIdType t, int c, Scalar v)
Read only container, not supported.
bool ReallocateTuples(vtkIdType numTuples)
vtkVariant GetVariantValue(vtkIdType idx) override
Not implemented.
virtual void Transform(Scalar *tuple) const =0
Transform the provided tuple.
void InitializeArray(vtkAOSDataArrayTemplate< Scalar > *inputData)
Initialize the mapped array with the original input data array.
unsigned long GetActualMemorySize() override
Return the memory in kilobytes consumed by this data array.
ValueType GetTypedComponent(vtkIdType tupleIdx, int compIdx) const
Return the requested component of the specified tuple.
void RemoveLastTuple() override
Read only container, not supported.
void SetVariantValue(vtkIdType idx, vtkVariant value) override
Read only container, not supported.
void Squeeze() override
No effect.
bool ComputeVectorRange(double range[2]) override
Get the transformed range on all components.
vtkIdType InsertNextValue(Scalar v)
Read only container, not supported.
void InvalidateRange()
Set the invalid range flag to false.
void RemoveFirstTuple() override
Read only container, not supported.
void InsertTuples(vtkIdList *dstIds, vtkIdList *srcIds, vtkAbstractArray *source) override
Read only container, not supported.
void InterpolateTuple(vtkIdType i, vtkIdList *ptIndices, vtkAbstractArray *source, double *weights) override
Read only container, not supported.
ValueType GetValue(vtkIdType idx) const
Get value at index idx.
void Initialize() override
Initialize array with zero values.
void SetTypedTuple(vtkIdType i, const Scalar *t)
Read only container, not supported.
void InsertValue(vtkIdType idx, Scalar v)
Read only container, not supported.
vtkIdType LookupValue(vtkVariant value) override
Not implemented.
double * GetTuple(vtkIdType i) override
Return tuple at location i.
A atomic type representing the union of many types.
Definition: vtkVariant.h:76
@ value
Definition: vtkX3D.h:220
@ range
Definition: vtkX3D.h:238
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
vtkSetMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
int vtkIdType
Definition: vtkType.h:287
#define VTK_NEWINSTANCE