VTK
vtkLinearTransform.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkLinearTransform.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 =========================================================================*/
25 #ifndef vtkLinearTransform_h
26 #define vtkLinearTransform_h
27 
28 #include "vtkCommonTransformsModule.h" // For export macro
30 
31 class VTKCOMMONTRANSFORMS_EXPORT vtkLinearTransform : public vtkHomogeneousTransform
32 {
33 public:
34 
36  void PrintSelf(ostream& os, vtkIndent indent) override;
37 
42  void TransformNormal(const float in[3], float out[3]) {
43  this->Update(); this->InternalTransformNormal(in,out); };
44 
49  void TransformNormal(const double in[3], double out[3]) {
50  this->Update(); this->InternalTransformNormal(in,out); };
51 
56  double *TransformNormal(double x, double y, double z) VTK_SIZEHINT(3) {
57  return this->TransformDoubleNormal(x,y,z); }
58  double *TransformNormal(const double normal[3]) VTK_SIZEHINT(3) {
59  return this->TransformDoubleNormal(normal[0],normal[1],normal[2]); };
60 
62 
66  float *TransformFloatNormal(float x, float y, float z) VTK_SIZEHINT(3) {
67  this->InternalFloatPoint[0] = x;
68  this->InternalFloatPoint[1] = y;
69  this->InternalFloatPoint[2] = z;
70  this->TransformNormal(this->InternalFloatPoint,this->InternalFloatPoint);
71  return this->InternalFloatPoint; };
72  float *TransformFloatNormal(const float normal[3]) VTK_SIZEHINT(3) {
73  return this->TransformFloatNormal(normal[0],normal[1],normal[2]); };
75 
77 
81  double *TransformDoubleNormal(double x, double y, double z) VTK_SIZEHINT(3) {
82  this->InternalDoublePoint[0] = x;
83  this->InternalDoublePoint[1] = y;
84  this->InternalDoublePoint[2] = z;
85  this->TransformNormal(this->InternalDoublePoint,this->InternalDoublePoint);
86  return this->InternalDoublePoint; };
87  double *TransformDoubleNormal(const double normal[3]) VTK_SIZEHINT(3) {
88  return this->TransformDoubleNormal(normal[0],normal[1],normal[2]); };
90 
95  double *TransformVector(double x, double y, double z) VTK_SIZEHINT(3) {
96  return this->TransformDoubleVector(x,y,z); }
97  double *TransformVector(const double normal[3]) VTK_SIZEHINT(3) {
98  return this->TransformDoubleVector(normal[0],normal[1],normal[2]); };
99 
104  void TransformVector(const float in[3], float out[3]) {
105  this->Update(); this->InternalTransformVector(in,out); };
106 
111  void TransformVector(const double in[3], double out[3]) {
112  this->Update(); this->InternalTransformVector(in,out); };
113 
115 
119  float *TransformFloatVector(float x, float y, float z) VTK_SIZEHINT(3) {
120  this->InternalFloatPoint[0] = x;
121  this->InternalFloatPoint[1] = y;
122  this->InternalFloatPoint[2] = z;
123  this->TransformVector(this->InternalFloatPoint,this->InternalFloatPoint);
124  return this->InternalFloatPoint; };
125  float *TransformFloatVector(const float vec[3]) VTK_SIZEHINT(3) {
126  return this->TransformFloatVector(vec[0],vec[1],vec[2]); };
128 
130 
134  double *TransformDoubleVector(double x, double y, double z) VTK_SIZEHINT(3) {
135  this->InternalDoublePoint[0] = x;
136  this->InternalDoublePoint[1] = y;
137  this->InternalDoublePoint[2] = z;
138  this->TransformVector(this->InternalDoublePoint,this->InternalDoublePoint);
139  return this->InternalDoublePoint; };
140  double *TransformDoubleVector(const double vec[3]) VTK_SIZEHINT(3) {
141  return this->TransformDoubleVector(vec[0],vec[1],vec[2]); };
143 
148  void TransformPoints(vtkPoints *inPts, vtkPoints *outPts) override;
149 
154  virtual void TransformNormals(vtkDataArray *inNms, vtkDataArray *outNms);
155 
160  virtual void TransformVectors(vtkDataArray *inVrs, vtkDataArray *outVrs);
161 
167  vtkPoints *outPts,
168  vtkDataArray *inNms,
169  vtkDataArray *outNms,
170  vtkDataArray *inVrs,
171  vtkDataArray *outVrs,
172  int nOptionalVectors = 0,
173  vtkDataArray** inVrsArr = nullptr,
174  vtkDataArray** outVrsArr = nullptr) override;
175 
181  {
182  return static_cast<vtkLinearTransform *>(this->GetInverse());
183  }
184 
186 
190  void InternalTransformPoint(const float in[3], float out[3]) override;
191  void InternalTransformPoint(const double in[3], double out[3]) override;
193 
195 
199  virtual void InternalTransformNormal(const float in[3], float out[3]);
200  virtual void InternalTransformNormal(const double in[3], double out[3]);
202 
204 
208  virtual void InternalTransformVector(const float in[3], float out[3]);
209  virtual void InternalTransformVector(const double in[3], double out[3]);
211 
213 
218  void InternalTransformDerivative(const float in[3], float out[3],
219  float derivative[3][3]) override;
220  void InternalTransformDerivative(const double in[3], double out[3],
221  double derivative[3][3]) override;
223 
224 protected:
226  ~vtkLinearTransform() override {}
227 private:
228  vtkLinearTransform(const vtkLinearTransform&) = delete;
229  void operator=(const vtkLinearTransform&) = delete;
230 };
231 
232 #endif
233 
234 
235 
236 
237 
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:33
vtkHomogeneousTransform
superclass for homogeneous transformations
Definition: vtkHomogeneousTransform.h:34
vtkLinearTransform::TransformDoubleNormal
double * TransformDoubleNormal(const double normal[3])
Definition: vtkLinearTransform.h:87
vtkLinearTransform::TransformNormal
double * TransformNormal(const double normal[3])
Definition: vtkLinearTransform.h:58
vtkLinearTransform::GetLinearInverse
vtkLinearTransform * GetLinearInverse()
Just like GetInverse, but it includes a typecast to vtkLinearTransform.
Definition: vtkLinearTransform.h:180
vtkLinearTransform::TransformNormal
void TransformNormal(const double in[3], double out[3])
Apply the transformation to a double-precision normal.
Definition: vtkLinearTransform.h:49
vtkLinearTransform::TransformVector
double * TransformVector(double x, double y, double z)
Synonymous with TransformDoubleVector(x,y,z).
Definition: vtkLinearTransform.h:95
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:48
vtkAbstractTransform::Update
void Update()
Update the transform to account for any changes which have been made.
vtkAbstractTransform::GetInverse
vtkAbstractTransform * GetInverse()
Get the inverse of this transform.
vtkLinearTransform
abstract superclass for linear transformations
Definition: vtkLinearTransform.h:31
vtkLinearTransform::vtkLinearTransform
vtkLinearTransform()
Definition: vtkLinearTransform.h:225
VTK_SIZEHINT
#define VTK_SIZEHINT(...)
Definition: vtkWrappingHints.h:42
vtkLinearTransform::~vtkLinearTransform
~vtkLinearTransform() override
Definition: vtkLinearTransform.h:226
vtkHomogeneousTransform::TransformPoints
void TransformPoints(vtkPoints *inPts, vtkPoints *outPts) override
Apply the transformation to a series of points, and append the results to outPts.
vtkLinearTransform::TransformVector
void TransformVector(const float in[3], float out[3])
Apply the transformation to a vector.
Definition: vtkLinearTransform.h:104
vtkHomogeneousTransform.h
vtkLinearTransform::TransformDoubleVector
double * TransformDoubleVector(const double vec[3])
Definition: vtkLinearTransform.h:140
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkHomogeneousTransform::InternalTransformPoint
void InternalTransformPoint(const float in[3], float out[3]) override
This will calculate the transformation without calling Update.
vtkHomogeneousTransform::TransformPointsNormalsVectors
void TransformPointsNormalsVectors(vtkPoints *inPts, vtkPoints *outPts, vtkDataArray *inNms, vtkDataArray *outNms, vtkDataArray *inVrs, vtkDataArray *outVrs, int nOptionalVectors=0, vtkDataArray **inVrsArr=nullptr, vtkDataArray **outVrsArr=nullptr) override
Apply the transformation to a combination of points, normals and vectors.
vtkAbstractTransform::InternalDoublePoint
double InternalDoublePoint[3]
Definition: vtkAbstractTransform.h:345
vtkLinearTransform::TransformDoubleVector
double * TransformDoubleVector(double x, double y, double z)
Apply the transformation to a double-precision (x,y,z) vector.
Definition: vtkLinearTransform.h:134
vtkLinearTransform::TransformFloatNormal
float * TransformFloatNormal(const float normal[3])
Definition: vtkLinearTransform.h:72
vtkLinearTransform::TransformFloatVector
float * TransformFloatVector(float x, float y, float z)
Apply the transformation to an (x,y,z) vector.
Definition: vtkLinearTransform.h:119
vtkLinearTransform::TransformDoubleNormal
double * TransformDoubleNormal(double x, double y, double z)
Apply the transformation to a double-precision (x,y,z) normal.
Definition: vtkLinearTransform.h:81
vtkLinearTransform::TransformFloatVector
float * TransformFloatVector(const float vec[3])
Definition: vtkLinearTransform.h:125
vtkLinearTransform::TransformNormal
double * TransformNormal(double x, double y, double z)
Synonymous with TransformDoubleNormal(x,y,z).
Definition: vtkLinearTransform.h:56
vtkLinearTransform::TransformVector
double * TransformVector(const double normal[3])
Definition: vtkLinearTransform.h:97
vtkLinearTransform::TransformVector
void TransformVector(const double in[3], double out[3])
Apply the transformation to a double-precision vector.
Definition: vtkLinearTransform.h:111
vtkHomogeneousTransform::InternalTransformDerivative
void InternalTransformDerivative(const float in[3], float out[3], float derivative[3][3]) override
This will calculate the transformation as well as its derivative without calling Update.
vtkHomogeneousTransform::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkAbstractTransform::InternalFloatPoint
float InternalFloatPoint[3]
Definition: vtkAbstractTransform.h:344
vtkLinearTransform::TransformNormal
void TransformNormal(const float in[3], float out[3])
Apply the transformation to a normal.
Definition: vtkLinearTransform.h:42
vtkLinearTransform::TransformFloatNormal
float * TransformFloatNormal(float x, float y, float z)
Apply the transformation to an (x,y,z) normal.
Definition: vtkLinearTransform.h:66