summaryrefslogtreecommitdiff
path: root/inc/gp_XYZ.hxx
blob: a4dd6d8aa142b585dec257eae96a225d00a7a76a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _gp_XYZ_HeaderFile
#define _gp_XYZ_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_Macro_HeaderFile
#include <Standard_Macro.hxx>
#endif

#ifndef _Standard_Real_HeaderFile
#include <Standard_Real.hxx>
#endif
#ifndef _Standard_Storable_HeaderFile
#include <Standard_Storable.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _Standard_PrimitiveTypes_HeaderFile
#include <Standard_PrimitiveTypes.hxx>
#endif
class Standard_ConstructionError;
class Standard_OutOfRange;
class gp_Mat;


Standard_EXPORT const Handle(Standard_Type)& STANDARD_TYPE(gp_XYZ);


//!  This class describes a cartesian coordinate entity in <br>
//!  3D space {X,Y,Z}. This entity is used for algebraic <br>
//!  calculation. This entity can be transformed <br>
//!  with a "Trsf" or a  "GTrsf" from package "gp". <br>
//! It is used in vectorial computations or for holding this type <br>
//! of information in data structures. <br>
class gp_XYZ  {

public:
  void* operator new(size_t,void* anAddress) 
  {
    return anAddress;
  }
  void* operator new(size_t size) 
  {
    return Standard::Allocate(size); 
  }
  void  operator delete(void *anAddress) 
  {
    if (anAddress) Standard::Free((Standard_Address&)anAddress); 
  }

  //! Creates an XYZ object with zero co-ordinates (0,0,0) <br>
      gp_XYZ();
  //! creates an XYZ with given coordinates <br>
      gp_XYZ(const Standard_Real X,const Standard_Real Y,const Standard_Real Z);
  //! For this XYZ object, assigns <br>
//!   the values X, Y and Z to its three coordinates <br>
        void SetCoord(const Standard_Real X,const Standard_Real Y,const Standard_Real Z) ;
  
//!  modifies the coordinate of range Index <br>
//!  Index = 1 => X is modified <br>
//!  Index = 2 => Y is modified <br>
//!  Index = 3 => Z is modified <br>
//!  Raises OutOfRange if Index != {1, 2, 3}. <br>
        void SetCoord(const Standard_Integer Index,const Standard_Real Xi) ;
  //! Assigns the given value to the X coordinate <br>
        void SetX(const Standard_Real X) ;
  //! Assigns the given value to the Y coordinate <br>
        void SetY(const Standard_Real Y) ;
  //! Assigns the given value to the Z coordinate <br>
        void SetZ(const Standard_Real Z) ;
  
//!  returns the coordinate of range Index : <br>
//!  Index = 1 => X is returned <br>
//!  Index = 2 => Y is returned <br>
//!  Index = 3 => Z is returned <br>
//! <br>
//! Raises OutOfRange if Index != {1, 2, 3}. <br>
        Standard_Real Coord(const Standard_Integer Index) const;
  
        void Coord(Standard_Real& X,Standard_Real& Y,Standard_Real& Z) const;
  //! Returns the X coordinate <br>
        Standard_Real X() const;
  //! Returns the Y coordinate <br>
        Standard_Real Y() const;
  //! Returns the Z coordinate <br>
        Standard_Real Z() const;
  //! computes Sqrt (X*X + Y*Y + Z*Z) where X, Y and Z are the three coordinates of this XYZ object. <br>
        Standard_Real Modulus() const;
  //! Computes X*X + Y*Y + Z*Z where X, Y and Z are the three coordinates of this XYZ object. <br>
        Standard_Real SquareModulus() const;
  
//!  Returns True if he coordinates of this XYZ object are <br>
//! equal to the respective coordinates Other, <br>
//! within the specified tolerance Tolerance. I.e.: <br>
//!  abs(<me>.X() - Other.X()) <= Tolerance and <br>
//!  abs(<me>.Y() - Other.Y()) <= Tolerance and <br>
//!  abs(<me>.Z() - Other.Z()) <= Tolerance. <br>
  Standard_EXPORT     Standard_Boolean IsEqual(const gp_XYZ& Other,const Standard_Real Tolerance) const;
  
//! <me>.X() = <me>.X() + Other.X() <br>
//! <me>.Y() = <me>.Y() + Other.Y() <br>
//! <me>.Z() = <me>.Z() + Other.Z() <br>
        void Add(const gp_XYZ& Other) ;
      void operator +=(const gp_XYZ& Other) 
{
  Add(Other);
}
  
//! new.X() = <me>.X() + Other.X() <br>
//! new.Y() = <me>.Y() + Other.Y() <br>
//! new.Z() = <me>.Z() + Other.Z() <br>
        gp_XYZ Added(const gp_XYZ& Other) const;
      gp_XYZ operator +(const gp_XYZ& Other) const
{
  return Added(Other);
}
  
//! <me>.X() = <me>.Y() * Other.Z() - <me>.Z() * Other.Y() <br>
//! <me>.Y() = <me>.Z() * Other.X() - <me>.X() * Other.Z() <br>
//! <me>.Z() = <me>.X() * Other.Y() - <me>.Y() * Other.X() <br>
        void Cross(const gp_XYZ& Right) ;
      void operator ^=(const gp_XYZ& Right) 
{
  Cross(Right);
}
  
//! new.X() = <me>.Y() * Other.Z() - <me>.Z() * Other.Y() <br>
//! new.Y() = <me>.Z() * Other.X() - <me>.X() * Other.Z() <br>
//! new.Z() = <me>.X() * Other.Y() - <me>.Y() * Other.X() <br>
        gp_XYZ Crossed(const gp_XYZ& Right) const;
      gp_XYZ operator ^(const gp_XYZ& Right) const
{
  return Crossed(Right);
}
  
//!  Computes the magnitude of the cross product between <me> and <br>
//!  Right. Returns || <me> ^ Right || <br>
        Standard_Real CrossMagnitude(const gp_XYZ& Right) const;
  
//!  Computes the square magnitude of the cross product between <me> and <br>
//!  Right. Returns || <me> ^ Right ||**2 <br>
        Standard_Real CrossSquareMagnitude(const gp_XYZ& Right) const;
  //! Triple vector product <br>
//!  Computes <me> = <me>.Cross(Coord1.Cross(Coord2)) <br>
        void CrossCross(const gp_XYZ& Coord1,const gp_XYZ& Coord2) ;
  //! Triple vector product <br>
//!  computes New = <me>.Cross(Coord1.Cross(Coord2)) <br>
        gp_XYZ CrossCrossed(const gp_XYZ& Coord1,const gp_XYZ& Coord2) const;
  //! divides <me> by a real. <br>
        void Divide(const Standard_Real Scalar) ;
      void operator /=(const Standard_Real Scalar) 
{
  Divide(Scalar);
}
  //! divides <me> by a real. <br>
        gp_XYZ Divided(const Standard_Real Scalar) const;
      gp_XYZ operator /(const Standard_Real Scalar) const
{
  return Divided(Scalar);
}
  //! computes the scalar product between <me> and Other <br>
        Standard_Real Dot(const gp_XYZ& Other) const;
      Standard_Real operator *(const gp_XYZ& Other) const
{
  return Dot(Other);
}
  //! computes the triple scalar product <br>
        Standard_Real DotCross(const gp_XYZ& Coord1,const gp_XYZ& Coord2) const;
  
//!  <me>.X() = <me>.X() * Scalar; <br>
//!  <me>.Y() = <me>.Y() * Scalar; <br>
//!  <me>.Z() = <me>.Z() * Scalar; <br>
        void Multiply(const Standard_Real Scalar) ;
      void operator *=(const Standard_Real Scalar) 
{
  Multiply(Scalar);
}
  
//!  <me>.X() = <me>.X() * Other.X(); <br>
//!  <me>.Y() = <me>.Y() * Other.Y(); <br>
//!  <me>.Z() = <me>.Z() * Other.Z(); <br>
        void Multiply(const gp_XYZ& Other) ;
      void operator *=(const gp_XYZ& Other) 
{
  Multiply(Other);
}
  //! <me> = Matrix * <me> <br>
        void Multiply(const gp_Mat& Matrix) ;
      void operator *=(const gp_Mat& Matrix) 
{
  Multiply(Matrix);
}
  
//!  New.X() = <me>.X() * Scalar; <br>
//!  New.Y() = <me>.Y() * Scalar; <br>
//!  New.Z() = <me>.Z() * Scalar; <br>
        gp_XYZ Multiplied(const Standard_Real Scalar) const;
      gp_XYZ operator *(const Standard_Real Scalar) const
{
  return Multiplied(Scalar);
}
  
//!  new.X() = <me>.X() * Other.X(); <br>
//!  new.Y() = <me>.Y() * Other.Y(); <br>
//!  new.Z() = <me>.Z() * Other.Z(); <br>
        gp_XYZ Multiplied(const gp_XYZ& Other) const;
  //!  New = Matrix * <me> <br>
        gp_XYZ Multiplied(const gp_Mat& Matrix) const;
      gp_XYZ operator *(const gp_Mat& Matrix) const
{
  return Multiplied(Matrix);
}
  
//!  <me>.X() = <me>.X()/ <me>.Modulus() <br>
//!  <me>.Y() = <me>.Y()/ <me>.Modulus() <br>
//!  <me>.Z() = <me>.Z()/ <me>.Modulus() <br>//! Raised if <me>.Modulus() <= Resolution from gp <br>
        void Normalize() ;
  
//!  New.X() = <me>.X()/ <me>.Modulus() <br>
//!  New.Y() = <me>.Y()/ <me>.Modulus() <br>
//!  New.Z() = <me>.Z()/ <me>.Modulus() <br>//! Raised if <me>.Modulus() <= Resolution from gp <br>
        gp_XYZ Normalized() const;
  
//!  <me>.X() = -<me>.X() <br>
//!  <me>.Y() = -<me>.Y() <br>
//!  <me>.Z() = -<me>.Z() <br>
        void Reverse() ;
  
//!  New.X() = -<me>.X() <br>
//!  New.Y() = -<me>.Y() <br>
//!  New.Z() = -<me>.Z() <br>
        gp_XYZ Reversed() const;
  
//!  <me>.X() = <me>.X() - Other.X() <br>
//!  <me>.Y() = <me>.Y() - Other.Y() <br>
//!  <me>.Z() = <me>.Z() - Other.Z() <br>
        void Subtract(const gp_XYZ& Right) ;
      void operator -=(const gp_XYZ& Right) 
{
  Subtract(Right);
}
  
//!  new.X() = <me>.X() - Other.X() <br>
//!  new.Y() = <me>.Y() - Other.Y() <br>
//!  new.Z() = <me>.Z() - Other.Z() <br>
        gp_XYZ Subtracted(const gp_XYZ& Right) const;
      gp_XYZ operator -(const gp_XYZ& Right) const
{
  return Subtracted(Right);
}
  
//!  <me> is set to the following linear form : <br>
//!  A1 * XYZ1 + A2 * XYZ2 + A3 * XYZ3 + XYZ4 <br>
        void SetLinearForm(const Standard_Real A1,const gp_XYZ& XYZ1,const Standard_Real A2,const gp_XYZ& XYZ2,const Standard_Real A3,const gp_XYZ& XYZ3,const gp_XYZ& XYZ4) ;
  
//!  <me> is set to the following linear form : <br>
//!  A1 * XYZ1 + A2 * XYZ2 + A3 * XYZ3 <br>
        void SetLinearForm(const Standard_Real A1,const gp_XYZ& XYZ1,const Standard_Real A2,const gp_XYZ& XYZ2,const Standard_Real A3,const gp_XYZ& XYZ3) ;
  
//!  <me> is set to the following linear form : <br>
//!  A1 * XYZ1 + A2 * XYZ2 + XYZ3 <br>
        void SetLinearForm(const Standard_Real A1,const gp_XYZ& XYZ1,const Standard_Real A2,const gp_XYZ& XYZ2,const gp_XYZ& XYZ3) ;
  
//!  <me> is set to the following linear form : <br>
//!  A1 * XYZ1 + A2 * XYZ2 <br>
        void SetLinearForm(const Standard_Real A1,const gp_XYZ& XYZ1,const Standard_Real A2,const gp_XYZ& XYZ2) ;
  
//!  <me> is set to the following linear form : <br>
//!  A1 * XYZ1 + XYZ2 <br>
        void SetLinearForm(const Standard_Real A1,const gp_XYZ& XYZ1,const gp_XYZ& XYZ2) ;
  
//!  <me> is set to the following linear form : <br>
//!  XYZ1 + XYZ2 <br>
        void SetLinearForm(const gp_XYZ& XYZ1,const gp_XYZ& XYZ2) ;
    Standard_Real _CSFDB_Getgp_XYZx() const { return x; }
    void _CSFDB_Setgp_XYZx(const Standard_Real p) { x = p; }
    Standard_Real _CSFDB_Getgp_XYZy() const { return y; }
    void _CSFDB_Setgp_XYZy(const Standard_Real p) { y = p; }
    Standard_Real _CSFDB_Getgp_XYZz() const { return z; }
    void _CSFDB_Setgp_XYZz(const Standard_Real p) { z = p; }



protected:




private: 


Standard_Real x;
Standard_Real y;
Standard_Real z;


};


#include <gp_XYZ.lxx>



// other Inline functions and methods (like "C++: function call" methods)


#endif