summaryrefslogtreecommitdiff
path: root/inc/Graphic3d_Vector.hxx
blob: bf06e47076345c19a9de84707bcdd7cd746d3797 (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
// 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 _Graphic3d_Vector_HeaderFile
#define _Graphic3d_Vector_HeaderFile

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

#ifndef _Standard_ShortReal_HeaderFile
#include <Standard_ShortReal.hxx>
#endif
#ifndef _Standard_Real_HeaderFile
#include <Standard_Real.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
class Graphic3d_VectorError;
class Graphic3d_Vertex;


//! This class allows the creation and update <br>
//!	    of a 3D vector. <br>
class Graphic3d_Vector  {
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 a vector with 1.0, 0.0, 0.0 coordinates. <br>
  Standard_EXPORT   Graphic3d_Vector();
  //! Creates a vector with <AX>, <AY>, <AZ> coordinates. <br>
  Standard_EXPORT   Graphic3d_Vector(const Standard_Real AX,const Standard_Real AY,const Standard_Real AZ);
  //! Creates a vector from 2 points <APoint1> and <APoint2>. <br>
  Standard_EXPORT   Graphic3d_Vector(const Graphic3d_Vertex& APoint1,const Graphic3d_Vertex& APoint2);
  //! Normalises <me>. <br>
//!  Category: Methods to modify the class definition <br>
//!  Warning: Raises VectorError if <me> is null. <br>
  Standard_EXPORT     void Normalize() ;
  //! Modifies the coordinates of the vector <me>. <br>
  Standard_EXPORT     void SetCoord(const Standard_Real Xnew,const Standard_Real Ynew,const Standard_Real Znew) ;
  //! Modifies the X coordinate of the vector <me>. <br>
  Standard_EXPORT     void SetXCoord(const Standard_Real Xnew) ;
  //! Modifies the Y coordinate of the vector <me>. <br>
  Standard_EXPORT     void SetYCoord(const Standard_Real Ynew) ;
  //! Modifies the Z coordinate of the vector <me>. <br>
  Standard_EXPORT     void SetZCoord(const Standard_Real Znew) ;
  //! Returns the coordinates of the vector <me>. <br>
  Standard_EXPORT     void Coord(Standard_Real& AX,Standard_Real& AY,Standard_Real& AZ) const;
  //! Returns Standard_True if <me> has length 1. <br>
  Standard_EXPORT     Standard_Boolean IsNormalized() const;
  //! Returns Standard_True if <me> has length zero. <br>
  Standard_EXPORT     Standard_Boolean LengthZero() const;
  //! Returns the X coordinates of the vector <me>. <br>
  Standard_EXPORT     Standard_Real X() const;
  //! Returns the Y coordinate of the vector <me>. <br>
  Standard_EXPORT     Standard_Real Y() const;
  //! Returns the Z coordinate of the vector <me>. <br>
  Standard_EXPORT     Standard_Real Z() const;
  //! Returns Standard_True if the vector <AV1> and <br>
//!	    <AV2> are parallel. <br>
  Standard_EXPORT   static  Standard_Boolean IsParallel(const Graphic3d_Vector& AV1,const Graphic3d_Vector& AV2) ;
  //! Returns the norm of the vector <AX>, <AY>, <AZ>. <br>
  Standard_EXPORT   static  Standard_Real NormeOf(const Standard_Real AX,const Standard_Real AY,const Standard_Real AZ) ;
  //! Returns the norm of the vector <AVector>. <br>
  Standard_EXPORT   static  Standard_Real NormeOf(const Graphic3d_Vector& AVector) ;





protected:





private:



Standard_ShortReal MyX;
Standard_ShortReal MyY;
Standard_ShortReal MyZ;
Standard_ShortReal MyNorme;


};





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


#endif