0031939: Coding - correction of spelling errors in comments
[occt.git] / src / gce / gce_MakeRotation2d.hxx
CommitLineData
42cf5bc1 1// Created on: 1992-08-26
2// Created by: Remi GILET
3// Copyright (c) 1992-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 _gce_MakeRotation2d_HeaderFile
18#define _gce_MakeRotation2d_HeaderFile
19
20#include <Standard.hxx>
21#include <Standard_DefineAlloc.hxx>
22#include <Standard_Handle.hxx>
23
24#include <gp_Trsf2d.hxx>
25#include <Standard_Real.hxx>
26class gp_Pnt2d;
27class gp_Trsf2d;
28
29
30//! Implements an elementary construction algorithm for
31//! a rotation in 2D space. The result is a gp_Trsf2d transformation.
32//! A MakeRotation2d object provides a framework for:
33//! - defining the construction of the transformation,
34//! - implementing the construction algorithm, and
35//! - consulting the result.
36class gce_MakeRotation2d
37{
38public:
39
40 DEFINE_STANDARD_ALLOC
41
42
43 //! Constructs a rotation through angle Angle about the center Point.
44 Standard_EXPORT gce_MakeRotation2d(const gp_Pnt2d& Point, const Standard_Real Angle);
45
46 //! Returns the constructed transformation.
47 Standard_EXPORT const gp_Trsf2d& Value() const;
48
49 Standard_EXPORT const gp_Trsf2d& Operator() const;
50Standard_EXPORT operator gp_Trsf2d() const;
51
52
53
54
55protected:
56
57
58
59
60
61private:
62
63
64
65 gp_Trsf2d TheRotation2d;
66
67
68};
69
70
71
72
73
74
75
76#endif // _gce_MakeRotation2d_HeaderFile