0027111: Add generalized copy constructor in handle class for old compilers
[occt.git] / src / GC / GC_MakePlane.hxx
CommitLineData
42cf5bc1 1// Created on: 1992-09-28
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 _GC_MakePlane_HeaderFile
18#define _GC_MakePlane_HeaderFile
19
20#include <Standard.hxx>
21#include <Standard_DefineAlloc.hxx>
22#include <Standard_Handle.hxx>
23
24#include <GC_Root.hxx>
d1a67b9d 25#include <Geom_Plane.hxx>
26
42cf5bc1 27class StdFail_NotDone;
28class gp_Ax2;
29class gp_Pln;
30class gp_Pnt;
31class gp_Dir;
32class gp_Ax1;
33
34
35//! This class implements the following algorithms used
36//! to create a Plane from gp.
37//! * Create a Plane parallel to another and passing
38//! through a point.
39//! * Create a Plane passing through 3 points.
40//! * Create a Plane by its normal
41//! A MakePlane object provides a framework for:
42//! - defining the construction of the plane,
43//! - implementing the construction algorithm, and
44//! - consulting the results. In particular, the Value
45//! function returns the constructed plane.
46class GC_MakePlane : public GC_Root
47{
48public:
49
50 DEFINE_STANDARD_ALLOC
51
52
53
54 //! Creates a plane located in 3D space with an axis placement
55 //! two axis. The "ZDirection" of "A2" is the direction normal
56 //! to the plane. The "Location" point of "A2" is the origin of
57 //! the plane. The "XDirection" and "YDirection" of "A2" define
58 //! the directions of the U isoparametric and V isoparametric
59 //! curves.
60 Standard_EXPORT GC_MakePlane(const gp_Ax2& A2);
61
62
63 //! Creates a plane from a non persistent plane from package gp.
64 Standard_EXPORT GC_MakePlane(const gp_Pln& Pl);
65
66
67 //! P is the "Location" point or origin of the plane.
68 //! V is the direction normal to the plane.
69 Standard_EXPORT GC_MakePlane(const gp_Pnt& P, const gp_Dir& V);
70
71
72 //! Creates a plane from its cartesian equation :
73 //! Ax + By + Cz + D = 0.0
74 //! Status is "BadEquation" if Sqrt (A*A + B*B + C*C)
75 //! <= Resolution from gp
76 Standard_EXPORT GC_MakePlane(const Standard_Real A, const Standard_Real B, const Standard_Real C, const Standard_Real D);
77
78 //! Make a Plane from Geom <ThePlane> parallel to another
79 //! Pln <Pln> and passing through a Pnt <Point>.
80 Standard_EXPORT GC_MakePlane(const gp_Pln& Pln, const gp_Pnt& Point);
81
82 //! Make a Plane from Geom <ThePlane> parallel to another
83 //! Pln <Pln> at the distance <Dist> which can be greater
84 //! or lower than zero.
85 //! In the first case the result is at the distance
86 //! <Dist> to the plane <Pln> in the direction of the
87 //! normal to <Pln>.
88 //! Otherwize it is in the oposite direction.
89 Standard_EXPORT GC_MakePlane(const gp_Pln& Pln, const Standard_Real Dist);
90
91 //! Make a Plane from Geom <ThePlane> passing through 3
92 //! Pnt <P1>,<P2>,<P3>.
93 //! It returns false if <P1> <P2> <P3> are confused.
94 Standard_EXPORT GC_MakePlane(const gp_Pnt& P1, const gp_Pnt& P2, const gp_Pnt& P3);
95
96 //! Make a Plane passing through the location of <Axis>and
97 //! normal to the Direction of <Axis>.
98 Standard_EXPORT GC_MakePlane(const gp_Ax1& Axis);
99
100 //! Returns the constructed plane.
101 //! Exceptions StdFail_NotDone if no plane is constructed.
102 Standard_EXPORT const Handle(Geom_Plane)& Value() const;
42cf5bc1 103
d1a67b9d 104 operator const Handle(Geom_Plane)& () const { return Value(); }
42cf5bc1 105
106private:
42cf5bc1 107 Handle(Geom_Plane) ThePlane;
42cf5bc1 108};
109
42cf5bc1 110#endif // _GC_MakePlane_HeaderFile