1 // Created on: 1993-03-24
2 // Created by: JCV
3 // Copyright (c) 1993-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _Geom2d_Direction_HeaderFile
18 #define _Geom2d_Direction_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Geom2d_Vector.hxx>
24 #include <Standard_Real.hxx>
25 class gp_Dir2d;
26 class gp_Trsf2d;
27 class Geom2d_Geometry;
28
29
30 class Geom2d_Direction;
31 DEFINE_STANDARD_HANDLE(Geom2d_Direction, Geom2d_Vector)
32
33
34 //! The class Direction specifies a vector that is never null.
35 //! It is a unit vector.
36 class Geom2d_Direction : public Geom2d_Vector
37 {
38
39 public:
40
41
42 //! Creates a unit vector with it 2 cartesian coordinates.
43 //!
44 //! Raised if Sqrt( X*X + Y*Y) <= Resolution from gp.
45 Standard_EXPORT Geom2d_Direction(const Standard_Real X, const Standard_Real Y);
46
47 //! Creates a persistent copy of <me>.
48 Standard_EXPORT Geom2d_Direction(const gp_Dir2d& V);
49
50 //! Assigns the coordinates X and Y to this unit vector,
51 //! then normalizes it.
52 //! Exceptions
53 //! Standard_ConstructionError if Sqrt(X*X +
54 //! Y*Y) is less than or equal to gp::Resolution().
55 Standard_EXPORT void SetCoord (const Standard_Real X, const Standard_Real Y);
56
57 //! Converts the gp_Dir2d unit vector V into this unit vector.
58 Standard_EXPORT void SetDir2d (const gp_Dir2d& V);
59
60
61 //! Assigns a value to the X coordinate of this unit vector, then normalizes it.
62 //! Exceptions
63 //! Standard_ConstructionError if the value assigned
64 //! causes the magnitude of the vector to become less
65 //! than or equal to gp::Resolution().
66 Standard_EXPORT void SetX (const Standard_Real X);
67
68 //! Assigns a value to the Y coordinate of this unit vector, then normalizes it.
69 //! Exceptions
70 //! Standard_ConstructionError if the value assigned
71 //! causes the magnitude of the vector to become less
72 //! than or equal to gp::Resolution().
73 Standard_EXPORT void SetY (const Standard_Real Y);
74
75 //! Converts this unit vector into a gp_Dir2d unit vector.
76 Standard_EXPORT gp_Dir2d Dir2d() const;
77
78 //! returns 1.0
79 Standard_EXPORT Standard_Real Magnitude() const Standard_OVERRIDE;
80
81 //! returns 1.0
82 Standard_EXPORT Standard_Real SquareMagnitude() const Standard_OVERRIDE;
83
84 //! Computes the cross product between <me> and <Other>.
85 Standard_EXPORT Standard_Real Crossed (const Handle(Geom2d_Vector)& Other) const Standard_OVERRIDE;
operator ^(const Handle (Geom2d_Vector)& Other) const86 Standard_Real operator ^ (const Handle(Geom2d_Vector)& Other) const
87 {
88 return Crossed(Other);
89 }
90
91 //! Applies the transformation T to this unit vector, then normalizes it.
92 Standard_EXPORT void Transform (const gp_Trsf2d& T) Standard_OVERRIDE;
93
94 //! Creates a new object which is a copy of this unit vector.
95 Standard_EXPORT Handle(Geom2d_Geometry) Copy() const Standard_OVERRIDE;
96
97
98
99
100 DEFINE_STANDARD_RTTIEXT(Geom2d_Direction,Geom2d_Vector)
101
102 protected:
103
104
105
106
107 private:
108
109
110
111
112 };
113
114
115
116
117
118
119
120 #endif // _Geom2d_Direction_HeaderFile
121