0032137: Coding Rules - merge redundant .lxx files into header files within Package gp
[occt.git] / src / PrsDim / PrsDim_FixRelation.hxx
1 // Created on: 1996-12-05
2 // Created by: Flore Lantheaume/Odile Olivier
3 // Copyright (c) 1996-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 _PrsDim_FixRelation_HeaderFile
18 #define _PrsDim_FixRelation_HeaderFile
19
20 #include <gp_Lin.hxx>
21 #include <gp_Circ.hxx>
22 #include <TopoDS_Wire.hxx>
23 #include <PrsDim_Relation.hxx>
24
25 class Geom_Plane;
26
27 DEFINE_STANDARD_HANDLE(PrsDim_FixRelation, PrsDim_Relation)
28
29 //! Constructs and manages a constraint by a fixed
30 //! relation between two or more interactive datums. This
31 //! constraint is represented by a wire from a shape -
32 //! point, vertex, or edge - in the first datum and a
33 //! corresponding shape in the second.
34 //! Warning: This relation is not bound with any kind of parametric
35 //! constraint : it represents the "status" of an parametric
36 //! object.
37 class PrsDim_FixRelation : public PrsDim_Relation
38 {
39   DEFINE_STANDARD_RTTIEXT(PrsDim_FixRelation, PrsDim_Relation)
40 public:
41   
42   //! initializes the vertex aShape, the
43   //! plane aPlane and the wire aWire, which connects
44   //! the two vertices in a fixed relation.
45   Standard_EXPORT PrsDim_FixRelation(const TopoDS_Shape& aShape, const Handle(Geom_Plane)& aPlane, const TopoDS_Wire& aWire);
46   
47   //! initializes the vertex aShape, the
48   //! plane aPlane and the wire aWire, the position
49   //! aPosition, the arrow size anArrowSize and the
50   //! wire aWire, which connects the two vertices in a fixed relation.
51   Standard_EXPORT PrsDim_FixRelation(const TopoDS_Shape& aShape, const Handle(Geom_Plane)& aPlane, const TopoDS_Wire& aWire, const gp_Pnt& aPosition, const Standard_Real anArrowSize = 0.01);
52   
53   //! initializes the edge aShape and the plane aPlane.
54   Standard_EXPORT PrsDim_FixRelation(const TopoDS_Shape& aShape, const Handle(Geom_Plane)& aPlane);
55   
56   //! initializes the edge aShape, the
57   //! plane aPlane, the position aPosition and the arrow
58   //! size anArrowSize.
59   Standard_EXPORT PrsDim_FixRelation(const TopoDS_Shape& aShape, const Handle(Geom_Plane)& aPlane, const gp_Pnt& aPosition, const Standard_Real anArrowSize = 0.01);
60   
61   //! Returns the wire which connects vertices in a fixed relation.
62   const TopoDS_Wire& Wire() { return myWire; }
63   
64   //! Constructs the wire aWire. This connects vertices
65   //! which are in a fixed relation.
66   void SetWire (const TopoDS_Wire& aWire) { myWire = aWire; }
67   
68   //! Returns true if the Interactive Objects in the relation
69   //! are movable.
70   virtual Standard_Boolean IsMovable() const Standard_OVERRIDE { return Standard_True; }
71
72 private:
73
74   Standard_EXPORT virtual void Compute (const Handle(PrsMgr_PresentationManager)& thePrsMgr,
75                                         const Handle(Prs3d_Presentation)& thePrs,
76                                         const Standard_Integer theMode) Standard_OVERRIDE;
77
78   Standard_EXPORT virtual void ComputeSelection (const Handle(SelectMgr_Selection)& theSel,
79                                                  const Standard_Integer theMode) Standard_OVERRIDE;
80
81   //! computes the presentation for <myFixShape> if it's a vertex.
82   Standard_EXPORT void ComputeVertex (const TopoDS_Vertex& FixVertex, gp_Pnt& curpos);
83   
84   Standard_EXPORT gp_Pnt ComputePosition (const Handle(Geom_Curve)& curv1, const Handle(Geom_Curve)& curv2, const gp_Pnt& firstp1, const gp_Pnt& lastp1, const gp_Pnt& firstp2, const gp_Pnt& lastp2) const;
85   
86   Standard_EXPORT gp_Pnt ComputePosition (const Handle(Geom_Curve)& curv, const gp_Pnt& firstp, const gp_Pnt& lastp) const;
87   
88   //! computes the presentation for <myFixShape> if it's a
89   //! edge.
90   Standard_EXPORT void ComputeEdge (const TopoDS_Edge& FixEdge, gp_Pnt& curpos);
91   
92   Standard_EXPORT void ComputeLinePosition (const gp_Lin& glin, gp_Pnt& pos, Standard_Real& pfirst, Standard_Real& plast);
93   
94   Standard_EXPORT void ComputeCirclePosition (const gp_Circ& gcirc, gp_Pnt& pos, Standard_Real& pfirst, Standard_Real& plast);
95   
96   Standard_EXPORT static Standard_Boolean ConnectedEdges (const TopoDS_Wire& aWire, const TopoDS_Vertex& aVertex, TopoDS_Edge& Edge1, TopoDS_Edge& Edge2);
97
98 private:
99
100   TopoDS_Wire myWire;
101   gp_Pnt myPntAttach;
102
103 };
104
105 #endif // _PrsDim_FixRelation_HeaderFile