VTK
vtkPistonDataObject.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPistonDataObject.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 =========================================================================*/
31 #ifndef vtkPistonDataObject_h
32 #define vtkPistonDataObject_h
33 
34 #include "vtkAcceleratorsPistonModule.h" // For export macro
35 #include "vtkDataObject.h"
36 
37 class vtkInformation;
39 class vtkPistonReference;
40 class vtkTimeStamp;
41 
42 class VTKACCELERATORSPISTON_EXPORT vtkPistonDataObject : public vtkDataObject
43 {
44 public:
47  void PrintSelf(ostream &os, vtkIndent indent);
48 
53 
58 
62  void * GetReferredData();
63 
67  vtkPistonReference *GetReference() { return this->Reference; };
68 
70 
73  virtual void ShallowCopy(vtkDataObject* src);
74  virtual void DeepCopy(vtkDataObject* src);
76 
80  virtual void ComputeBounds();
81 
83 
87  double *GetBounds();
88  void GetBounds(double bounds[6]);
89  void SetBounds(const double bounds[6]);
91 
93  double *GetOrigin();
94  void GetOrigin(double origin[3]);
95  void SetOrigin(const double origin[3]);
97 
99  double *GetSpacing();
100  void GetSpacing(double spacing[3]);
101  void SetSpacing(double spacing[3]);
103 
105 
108  vtkGetStringMacro(ScalarsArrayName);
109  // Set scalars array name
110  vtkSetStringMacro(ScalarsArrayName);
112 
114 
118  double* GetScalarsRange();
119  void GetScalarsRange(double range[2]);
121 
124  void SetScalarsRange(double range[2]);
125 
127 
133 
134 protected:
137 
140  double Bounds[6];
141  double Origin[3];
142  double Spacing[3];
143 
145  double ScalarsRange[2];
146  vtkTimeStamp ComputeTime; // Time at which bounds, center, etc. computed
147 
148 private:
149  vtkPistonDataObject(const vtkPistonDataObject&) VTK_DELETE_FUNCTION;
150  void operator=(const vtkPistonDataObject&) VTK_DELETE_FUNCTION;
151 };
152 
153 #endif
vtkPistonDataObject::DeepCopy
virtual void DeepCopy(vtkDataObject *src)
vtkPistonDataObject::GetReferredType
int GetReferredType()
A convenience handle to get type of what is stored in the reference.
vtkPistonDataObject::GetBounds
double * GetBounds()
Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,...
vtkPistonDataObject
A GPU resident data set.
Definition: vtkPistonDataObject.h:43
vtkPistonDataObject::GetData
static vtkPistonDataObject * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
vtkPistonDataObject::~vtkPistonDataObject
~vtkPistonDataObject()
vtkPistonDataObject::ComputeTime
vtkTimeStamp ComputeTime
Definition: vtkPistonDataObject.h:146
vtkPistonDataObject::GetScalarsRange
void GetScalarsRange(double range[2])
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:42
vtkPistonDataObject::Reference
vtkPistonReference * Reference
Definition: vtkPistonDataObject.h:138
vtkPistonDataObject::SetScalarsRange
void SetScalarsRange(double range[2])
Set scalars range.
vtkTimeStamp
record modification and/or execution time
Definition: vtkTimeStamp.h:36
vtkX3D::range
@ range
Definition: vtkX3D.h:238
vtkPistonDataObject::SetSpacing
void SetSpacing(double spacing[3])
vtkPistonDataObject::ShallowCopy
virtual void ShallowCopy(vtkDataObject *src)
Shallow/deep copy the data from src into this object.
vtkPistonDataObject::GetOrigin
void GetOrigin(double origin[3])
vtkPistonDataObject::ComputeBounds
virtual void ComputeBounds()
Compute the data bounding box.
vtkPistonDataObject::SetOrigin
void SetOrigin(const double origin[3])
vtkPistonDataObject::GetOrigin
double * GetOrigin()
vtkPistonDataObject::GetScalarsRange
double * GetScalarsRange()
Get scalars range \NOTE: For now only one scalar is supported in Piston.
vtkPistonReference
Lower level handle on GPU resident data.
Definition: vtkPistonReference.h:39
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkGetStringMacro
vtkGetStringMacro(ExtensionsString)
Returns a string listing all available extensions.
vtkPistonDataObject::OwnReference
bool OwnReference
Definition: vtkPistonDataObject.h:139
vtkPistonDataObject::SetBounds
void SetBounds(const double bounds[6])
vtkPistonDataObject::GetDataObjectType
int GetDataObjectType()
From vtkType.h, a handle on what type of vtkDataObject this is.
Definition: vtkPistonDataObject.h:52
vtkX3D::spacing
@ spacing
Definition: vtkX3D.h:481
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkX3D::info
@ info
Definition: vtkX3D.h:376
vtkPistonDataObject::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
vtkPistonDataObject::GetReferredData
void * GetReferredData()
A convenience handle to get whatever is actually stored in the reference.
vtkPistonDataObject::ScalarsArrayName
char * ScalarsArrayName
Definition: vtkPistonDataObject.h:144
vtkDataObject.h
vtkPistonDataObject::GetSpacing
void GetSpacing(double spacing[3])
vtkPistonDataObject::GetSpacing
double * GetSpacing()
vtkPistonDataObject::GetData
static vtkPistonDataObject * GetData(vtkInformationVector *v, int i=0)
vtkPistonDataObject::vtkPistonDataObject
vtkPistonDataObject()
VTK_PISTON_DATA_OBJECT
#define VTK_PISTON_DATA_OBJECT
Definition: vtkType.h:121
vtkPistonDataObject::New
static vtkPistonDataObject * New()
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:65
vtkPistonDataObject::GetBounds
void GetBounds(double bounds[6])
vtkPistonDataObject::GetReference
vtkPistonReference * GetReference()
GPU level representation and storage this manages.
Definition: vtkPistonDataObject.h:67