1 // Created on: 1993-03-24
3 // Copyright (c) 1993-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
6 // This file is part of Open CASCADE Technology software library.
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.
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
17 #ifndef _Geom2d_Direction_HeaderFile
18 #define _Geom2d_Direction_HeaderFile
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
23 #include <Geom2d_Vector.hxx>
24 #include <Standard_Real.hxx>
25 class Standard_ConstructionError;
29 class Geom2d_Geometry;
32 class Geom2d_Direction;
33 DEFINE_STANDARD_HANDLE(Geom2d_Direction, Geom2d_Vector)
36 //! The class Direction specifies a vector that is never null.
37 //! It is a unit vector.
38 class Geom2d_Direction : public Geom2d_Vector
44 //! Creates a unit vector with it 2 cartesian coordinates.
46 //! Raised if Sqrt( X*X + Y*Y) <= Resolution from gp.
47 Standard_EXPORT Geom2d_Direction(const Standard_Real X, const Standard_Real Y);
49 //! Creates a persistent copy of <me>.
50 Standard_EXPORT Geom2d_Direction(const gp_Dir2d& V);
52 //! Assigns the coordinates X and Y to this unit vector,
53 //! then normalizes it.
55 //! Standard_ConstructionError if Sqrt(X*X +
56 //! Y*Y) is less than or equal to gp::Resolution().
57 Standard_EXPORT void SetCoord (const Standard_Real X, const Standard_Real Y);
59 //! Converts the gp_Dir2d unit vector V into this unit vector.
60 Standard_EXPORT void SetDir2d (const gp_Dir2d& V);
63 //! Assigns a value to the X coordinate of this unit vector, then normalizes it.
65 //! Standard_ConstructionError if the value assigned
66 //! causes the magnitude of the vector to become less
67 //! than or equal to gp::Resolution().
68 Standard_EXPORT void SetX (const Standard_Real X);
70 //! Assigns a value to the Y coordinate of this unit vector, then normalizes it.
72 //! Standard_ConstructionError if the value assigned
73 //! causes the magnitude of the vector to become less
74 //! than or equal to gp::Resolution().
75 Standard_EXPORT void SetY (const Standard_Real Y);
77 //! Converts this unit vector into a gp_Dir2d unit vector.
78 Standard_EXPORT gp_Dir2d Dir2d() const;
81 Standard_EXPORT Standard_Real Magnitude() const Standard_OVERRIDE;
84 Standard_EXPORT Standard_Real SquareMagnitude() const Standard_OVERRIDE;
86 //! Computes the cross product between <me> and <Other>.
87 Standard_EXPORT Standard_Real Crossed (const Handle(Geom2d_Vector)& Other) const Standard_OVERRIDE;
88 Standard_Real operator ^ (const Handle(Geom2d_Vector)& Other) const
90 return Crossed(Other);
93 //! Applies the transformation T to this unit vector, then normalizes it.
94 Standard_EXPORT void Transform (const gp_Trsf2d& T) Standard_OVERRIDE;
96 //! Creates a new object which is a copy of this unit vector.
97 Standard_EXPORT Handle(Geom2d_Geometry) Copy() const Standard_OVERRIDE;
102 DEFINE_STANDARD_RTTIEXT(Geom2d_Direction,Geom2d_Vector)
122 #endif // _Geom2d_Direction_HeaderFile