VTK  9.1.0
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=========================================================================*/
42#ifndef vtkLinearTransform_h
43#define vtkLinearTransform_h
44
45#include "vtkCommonTransformsModule.h" // For export macro
47
48class VTKCOMMONTRANSFORMS_EXPORT vtkLinearTransform : public vtkHomogeneousTransform
49{
50public:
52 void PrintSelf(ostream& os, vtkIndent indent) override;
53
58 void TransformNormal(const float in[3], float out[3])
59 {
60 this->Update();
61 this->InternalTransformNormal(in, out);
62 }
63
68 void TransformNormal(const double in[3], double out[3])
69 {
70 this->Update();
71 this->InternalTransformNormal(in, out);
72 }
73
78 double* TransformNormal(double x, double y, double z) VTK_SIZEHINT(3)
79 {
80 return this->TransformDoubleNormal(x, y, z);
81 }
82 double* TransformNormal(const double normal[3]) VTK_SIZEHINT(3)
83 {
84 return this->TransformDoubleNormal(normal[0], normal[1], normal[2]);
85 }
86
88
92 float* TransformFloatNormal(float x, float y, float z) VTK_SIZEHINT(3)
93 {
94 this->InternalFloatPoint[0] = x;
95 this->InternalFloatPoint[1] = y;
96 this->InternalFloatPoint[2] = z;
97 this->TransformNormal(this->InternalFloatPoint, this->InternalFloatPoint);
98 return this->InternalFloatPoint;
99 }
100 float* TransformFloatNormal(const float normal[3]) VTK_SIZEHINT(3)
101 {
102 return this->TransformFloatNormal(normal[0], normal[1], normal[2]);
103 }
105
107
111 double* TransformDoubleNormal(double x, double y, double z) VTK_SIZEHINT(3)
112 {
113 this->InternalDoublePoint[0] = x;
114 this->InternalDoublePoint[1] = y;
115 this->InternalDoublePoint[2] = z;
116 this->TransformNormal(this->InternalDoublePoint, this->InternalDoublePoint);
117 return this->InternalDoublePoint;
118 }
119 double* TransformDoubleNormal(const double normal[3]) VTK_SIZEHINT(3)
120 {
121 return this->TransformDoubleNormal(normal[0], normal[1], normal[2]);
122 }
124
129 double* TransformVector(double x, double y, double z) VTK_SIZEHINT(3)
130 {
131 return this->TransformDoubleVector(x, y, z);
132 }
133 double* TransformVector(const double normal[3]) VTK_SIZEHINT(3)
134 {
135 return this->TransformDoubleVector(normal[0], normal[1], normal[2]);
136 }
137
142 void TransformVector(const float in[3], float out[3])
143 {
144 this->Update();
145 this->InternalTransformVector(in, out);
146 }
147
152 void TransformVector(const double in[3], double out[3])
153 {
154 this->Update();
155 this->InternalTransformVector(in, out);
156 }
157
159
163 float* TransformFloatVector(float x, float y, float z) VTK_SIZEHINT(3)
164 {
165 this->InternalFloatPoint[0] = x;
166 this->InternalFloatPoint[1] = y;
167 this->InternalFloatPoint[2] = z;
168 this->TransformVector(this->InternalFloatPoint, this->InternalFloatPoint);
169 return this->InternalFloatPoint;
170 }
171 float* TransformFloatVector(const float vec[3]) VTK_SIZEHINT(3)
172 {
173 return this->TransformFloatVector(vec[0], vec[1], vec[2]);
174 }
176
178
182 double* TransformDoubleVector(double x, double y, double z) VTK_SIZEHINT(3)
183 {
184 this->InternalDoublePoint[0] = x;
185 this->InternalDoublePoint[1] = y;
186 this->InternalDoublePoint[2] = z;
187 this->TransformVector(this->InternalDoublePoint, this->InternalDoublePoint);
188 return this->InternalDoublePoint;
189 }
190 double* TransformDoubleVector(const double vec[3]) VTK_SIZEHINT(3)
191 {
192 return this->TransformDoubleVector(vec[0], vec[1], vec[2]);
193 }
195
200 void TransformPoints(vtkPoints* inPts, vtkPoints* outPts) override;
201
206 virtual void TransformNormals(vtkDataArray* inNms, vtkDataArray* outNms);
207
212 virtual void TransformVectors(vtkDataArray* inVrs, vtkDataArray* outVrs);
213
219 vtkDataArray* outNms, vtkDataArray* inVrs, vtkDataArray* outVrs, int nOptionalVectors = 0,
220 vtkDataArray** inVrsArr = nullptr, vtkDataArray** outVrsArr = nullptr) override;
221
227 {
228 return static_cast<vtkLinearTransform*>(this->GetInverse());
229 }
230
232
236 void InternalTransformPoint(const float in[3], float out[3]) override;
237 void InternalTransformPoint(const double in[3], double out[3]) override;
239
241
245 virtual void InternalTransformNormal(const float in[3], float out[3]);
246 virtual void InternalTransformNormal(const double in[3], double out[3]);
248
250
254 virtual void InternalTransformVector(const float in[3], float out[3]);
255 virtual void InternalTransformVector(const double in[3], double out[3]);
257
259
265 const float in[3], float out[3], float derivative[3][3]) override;
267 const double in[3], double out[3], double derivative[3][3]) override;
269
270protected:
272 ~vtkLinearTransform() override = default;
273
274private:
275 vtkLinearTransform(const vtkLinearTransform&) = delete;
276 void operator=(const vtkLinearTransform&) = delete;
277};
278
279#endif
void Update()
Update the transform to account for any changes which have been made.
vtkAbstractTransform * GetInverse()
Get the inverse of this transform.
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:59
superclass for homogeneous transformations
a simple class to control print indentation
Definition: vtkIndent.h:43
abstract superclass for linear transformations
double * TransformNormal(const double normal[3])
virtual void TransformVectors(vtkDataArray *inVrs, vtkDataArray *outVrs)
Apply the transformation to a series of vectors, and append the results to outVrs.
virtual void TransformNormals(vtkDataArray *inNms, vtkDataArray *outNms)
Apply the transformation to a series of normals, and append the results to outNms.
virtual void InternalTransformVector(const float in[3], float out[3])
This will calculate the transformation without calling Update.
void InternalTransformPoint(const float in[3], float out[3]) override
This will calculate the transformation without calling Update.
float * TransformFloatVector(float x, float y, float z)
Apply the transformation to an (x,y,z) vector.
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.
double * TransformVector(const double normal[3])
void TransformPoints(vtkPoints *inPts, vtkPoints *outPts) override
Apply the transformation to a series of points, and append the results to outPts.
double * TransformDoubleNormal(double x, double y, double z)
Apply the transformation to a double-precision (x,y,z) normal.
void InternalTransformPoint(const double in[3], double out[3]) override
This will calculate the transformation without calling Update.
virtual void InternalTransformNormal(const float in[3], float out[3])
This will calculate the transformation without calling Update.
double * TransformDoubleVector(double x, double y, double z)
Apply the transformation to a double-precision (x,y,z) vector.
virtual void InternalTransformVector(const double in[3], double out[3])
This will calculate the transformation without calling Update.
vtkLinearTransform()=default
virtual void InternalTransformNormal(const double in[3], double out[3])
This will calculate the transformation without calling Update.
double * TransformDoubleNormal(const double normal[3])
Apply the transformation to a double-precision (x,y,z) normal.
~vtkLinearTransform() override=default
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.
float * TransformFloatNormal(float x, float y, float z)
Apply the transformation to an (x,y,z) normal.
double * TransformNormal(double x, double y, double z)
Synonymous with TransformDoubleNormal(x,y,z).
void TransformVector(const float in[3], float out[3])
Apply the transformation to a vector.
vtkLinearTransform * GetLinearInverse()
Just like GetInverse, but it includes a typecast to vtkLinearTransform.
void TransformNormal(const float in[3], float out[3])
Apply the transformation to a normal.
float * TransformFloatVector(const float vec[3])
Apply the transformation to an (x,y,z) vector.
void TransformVector(const double in[3], double out[3])
Apply the transformation to a double-precision vector.
double * TransformVector(double x, double y, double z)
Synonymous with TransformDoubleVector(x,y,z).
float * TransformFloatNormal(const float normal[3])
Apply the transformation to an (x,y,z) normal.
void InternalTransformDerivative(const double in[3], double out[3], double derivative[3][3]) override
This will calculate the transformation as well as its derivative without calling Update.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void TransformNormal(const double in[3], double out[3])
Apply the transformation to a double-precision normal.
double * TransformDoubleVector(const double vec[3])
Apply the transformation to a double-precision (x,y,z) vector.
represent and manipulate 3D points
Definition: vtkPoints.h:43
#define VTK_SIZEHINT(...)