0024002: Overall code and build procedure refactoring -- automatic
[occt.git] / src / AIS / AIS_TangentRelation.hxx
1 // Created on: 1996-12-05
2 // Created by: Jean-Pierre COMBE/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 _AIS_TangentRelation_HeaderFile
18 #define _AIS_TangentRelation_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <gp_Pnt.hxx>
24 #include <gp_Dir.hxx>
25 #include <Standard_Real.hxx>
26 #include <Standard_Integer.hxx>
27 #include <AIS_Relation.hxx>
28 #include <PrsMgr_PresentationManager3d.hxx>
29 #include <SelectMgr_Selection.hxx>
30 class TopoDS_Shape;
31 class Geom_Plane;
32 class Prs3d_Presentation;
33 class Prs3d_Projector;
34 class Geom_Transformation;
35
36
37 class AIS_TangentRelation;
38 DEFINE_STANDARD_HANDLE(AIS_TangentRelation, AIS_Relation)
39
40 //! A framework to display tangency constraints between
41 //! two or more Interactive Objects of the datum type.
42 //! The datums are normally faces or edges.
43 class AIS_TangentRelation : public AIS_Relation
44 {
45
46 public:
47
48   
49   //! TwoFacesTangent or TwoEdgesTangent relation
50   //! Constructs an object to display tangency constraints.
51   //! This object is defined by the first shape aFShape, the
52   //! second shape aSShape, the plane aPlane and the index anExternRef.
53   //! aPlane serves as an optional axis.
54   //! anExternRef set to 0 indicates that there is no relation.
55   Standard_EXPORT AIS_TangentRelation(const TopoDS_Shape& aFShape, const TopoDS_Shape& aSShape, const Handle(Geom_Plane)& aPlane, const Standard_Integer anExternRef = 0);
56   
57   //! Returns the external reference for tangency.
58   //! The values are as follows:
59   //! -   0 - there is no connection;
60   //! -   1 - there is a connection to the first shape;
61   //! -   2 - there is a connection to the second shape.
62   //! This reference is defined at construction time.
63   Standard_EXPORT Standard_Integer ExternRef();
64   
65   //! Sets the external reference for tangency, aRef.
66   //! The values are as follows:
67   //! -   0 - there is no connection;
68   //! -   1 - there is a connection to the first shape;
69   //! -   2 - there is a connection to the second shape.
70   //! This reference is initially defined at construction time.
71   Standard_EXPORT void SetExternRef (const Standard_Integer aRef);
72   
73   //! computes the presentation according to a point of view
74   //! given by <aProjector>.
75   //! To be Used when the associated degenerated Presentations
76   //! have been transformed by <aTrsf> which is not a Pure
77   //! Translation. The HLR Prs can't be deducted automatically
78   //! WARNING :<aTrsf> must be applied
79   //! to the object to display before computation  !!!
80   Standard_EXPORT virtual void Compute (const Handle(Prs3d_Projector)& aProjector, const Handle(Geom_Transformation)& aTrsf, const Handle(Prs3d_Presentation)& aPresentation) Standard_OVERRIDE;
81
82
83
84
85   DEFINE_STANDARD_RTTI(AIS_TangentRelation,AIS_Relation)
86
87 protected:
88
89
90
91
92 private:
93
94   
95   Standard_EXPORT void Compute (const Handle(PrsMgr_PresentationManager3d)& aPresentationManager, const Handle(Prs3d_Presentation)& aPresentation, const Standard_Integer aMode = 0) Standard_OVERRIDE;
96   
97   Standard_EXPORT void Compute (const Handle(Prs3d_Projector)& aProjector, const Handle(Prs3d_Presentation)& aPresentation) Standard_OVERRIDE;
98   
99   Standard_EXPORT void ComputeSelection (const Handle(SelectMgr_Selection)& aSelection, const Standard_Integer aMode);
100   
101   Standard_EXPORT void ComputeTwoFacesTangent (const Handle(Prs3d_Presentation)& aPresentation);
102   
103   Standard_EXPORT void ComputeTwoEdgesTangent (const Handle(Prs3d_Presentation)& aPresentation);
104
105   gp_Pnt myAttach;
106   gp_Dir myDir;
107   Standard_Real myLength;
108   Standard_Integer myExternRef;
109
110
111 };
112
113
114
115
116
117
118
119 #endif // _AIS_TangentRelation_HeaderFile