0030675: Visualization - remove redundant proxy classes in hierarchy of PrsMgr_Presen...
[occt.git] / src / AIS / AIS.hxx
1 // Created on: 1996-12-11
2 // Created by: Robert COUBLANC
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_HeaderFile
18 #define _AIS_HeaderFile
19
20 #include <AIS_KindOfSurface.hxx>
21 #include <Aspect_TypeOfLine.hxx>
22 #include <Aspect_TypeOfMarker.hxx>
23 #include <gp_Dir.hxx>
24 #include <gp_Pnt.hxx>
25 #include <Quantity_NameOfColor.hxx>
26 #include <Prs3d_Drawer.hxx>
27 #include <Prs3d_Presentation.hxx>
28 #include <Standard.hxx>
29 #include <Standard_DefineAlloc.hxx>
30 #include <Standard_Handle.hxx>
31
32 class Bnd_Box;
33 class Geom_Curve;
34 class Geom_Plane;
35 class Geom_Surface;
36 class TopoDS_Edge;
37 class TopoDS_Face;
38 class TopoDS_Shape;
39 class TopoDS_Vertex;
40
41 //! Application Interactive Services provide the means to create links between an application GUI viewer and
42 //! the packages which are used to manage selection and presentation.
43 //! The tools AIS defined in order to do this include different sorts of entities:
44 //! both the selectable viewable objects themselves and the context and attribute managers to define their selection and display.
45 //! To orient the user as he works in a modeling environment, views and selections must be comprehensible.
46 //! There must be several different sorts of selectable and viewable object defined.
47 //! These must also be interactive, that is, connecting graphic representation and the underlying reference geometry.
48 //! These entities are called Interactive Objects, and are divided into four types:
49 //! -   the Datum
50 //! -   the Relation
51 //! -   the Object
52 //! -   None.
53 //! The Datum groups together the construction elements such as lines, circles, points, trihedra, plane trihedra, planes and axes.
54 //! The Relation is made up of constraints on one or more interactive shapes and the corresponding reference geometry.
55 //! For example, you might want to constrain two edges in a parallel relation.
56 //! This contraint is considered as an object in its own right, and is shown as a sensitive primitive.
57 //! This takes the graphic form of a perpendicular arrow marked with the || symbol and lying between the two edges.
58 //! The Object type includes topological shapes, and connections between shapes.
59 //! None, in order not to eliminate the object, tells the application to look further until it finds an object definition in its generation which is accepted.
60 //! Inside these categories, you have the possibility of an additional characterization by means of a signature.
61 //! The signature provides an index to the further characterization.
62 //! By default, the Interactive Object has a None type and a signature of 0 (equivalent to None.)
63 //! If you want to give a particular type and signature to your interactive object, you must redefine the two virtual methods: Type and Signature.
64 //! In the C++ inheritance structure of the package, each class representing a specific Interactive Object inherits AIS_InteractiveObject.
65 //! Among these inheriting classes, AIS_Relation functions as the abstract mother class for tinheriting classes defining display of specific relational constraints and types of dimension.
66 //! Some of these include:
67 //! -   display of constraints based on relations of symmetry, tangency, parallelism and concentricity
68 //! -   display of dimensions for angles, offsets, diameters, radii and chamfers.
69 //! No viewer can show everything at once with any coherence or clarity.
70 //! Views must be managed carefully both sequentially and at any given instant.
71 //! Another function of the view is that of a context to carry out design in.
72 //! The design changes are applied to the objects in the view and then extended to the underlying reference geometry by a solver.
73 //! To make sense of this complicated visual data, several display and selection tools are required.
74 //! To facilitate management, each object and each construction element has a selection priority.
75 //! There are also means to modify the default priority.
76 //! To define an environment of dynamic detection, you can use standard filter classes or create your own.
77 //! A filter questions the owner of the sensitive primitive to determine if it has the the desired qualities.
78 //! If it answers positively, it is kept. If not, it is rejected.
79 //! The standard filters supplied in AIS include:
80 //! - AIS_AttributeFilter
81 //! - AIS_SignatureFilter
82 //! - AIS_TypeFilter.
83 //! A set of functions allows you to choose the interactive objects which you want to act on, the selection modes which you want to activate.
84 //! An interactive object can have a certain number of graphic attributes which are specific to it, such as visualization mode, color, and material.
85 //! By the same token, the interactive context has a set of graphic attributes, the Drawer which is valid by default for the objects it controls.
86 //! When an interactive object is visualized, the required graphic attributes are first taken from the object's own Drawer if one exists, or from the context drawer for the others.
87 class AIS 
88 {
89 public:
90
91   DEFINE_STANDARD_ALLOC
92
93   
94
95   //! Returns the nearest point in a shape. This is used by
96   //! several classes in calculation of dimensions.
97   Standard_EXPORT static gp_Pnt Nearest (const TopoDS_Shape& aShape, const gp_Pnt& aPoint);
98   
99
100   //! @return the nearest point on the line.
101   Standard_EXPORT static gp_Pnt Nearest (const gp_Lin& theLine, const gp_Pnt& thePoint);
102   
103
104   //! For the given point finds nearest point on the curve,
105   //! @return TRUE if found point is belongs to the curve
106   //! and FALSE otherwise.
107   Standard_EXPORT static Standard_Boolean Nearest (const Handle(Geom_Curve)& theCurve, const gp_Pnt& thePoint, const gp_Pnt& theFirstPoint, const gp_Pnt& theLastPoint, gp_Pnt& theNearestPoint);
108   
109   Standard_EXPORT static gp_Pnt Farest (const TopoDS_Shape& aShape, const gp_Pnt& aPoint);
110   
111   //! Used by 2d Relation only
112   //! Computes the 3d geometry of <anEdge> in the current WorkingPlane
113   //! and the extremities if any
114   //! Return TRUE if ok.
115   Standard_EXPORT static Standard_Boolean ComputeGeometry (const TopoDS_Edge& theEdge, Handle(Geom_Curve)& theCurve, gp_Pnt& theFirstPnt, gp_Pnt& theLastPnt);
116   
117   //! Used by dimensions only.
118   //! Computes the 3d geometry of <anEdge>.
119   //! Return TRUE if ok.
120   Standard_EXPORT static Standard_Boolean ComputeGeometry (const TopoDS_Edge& theEdge, Handle(Geom_Curve)& theCurve, gp_Pnt& theFirstPnt, gp_Pnt& theLastPnt, Standard_Boolean& theIsInfinite);
121   
122   //! Used by 2d Relation only
123   //! Computes the 3d geometry of <anEdge> in the current WorkingPlane
124   //! and the extremities if any.
125   //! If <aCurve> is not in the current plane, <extCurve> contains
126   //! the not projected curve associated to <anEdge>.
127   //! If <anEdge> is infinite, <isinfinite> = true and the 2
128   //! parameters <FirstPnt> and <LastPnt> have no signification.
129   //! Return TRUE if ok.
130   Standard_EXPORT static Standard_Boolean ComputeGeometry (const TopoDS_Edge& theEdge, Handle(Geom_Curve)& theCurve, gp_Pnt& theFirstPnt, gp_Pnt& theLastPnt, Handle(Geom_Curve)& theExtCurve, Standard_Boolean& theIsInfinite, Standard_Boolean& theIsOnPlane, const Handle(Geom_Plane)& thePlane);
131   
132   //! Used by 2d Relation only
133   //! Computes the 3d geometry of <anEdge> in the current WorkingPlane
134   //! and the extremities if any
135   //! Return TRUE if ok.
136   Standard_EXPORT static Standard_Boolean ComputeGeometry (const TopoDS_Edge& theFirstEdge, const TopoDS_Edge& theSecondEdge, Handle(Geom_Curve)& theFirstCurve, Handle(Geom_Curve)& theSecondCurve, gp_Pnt& theFirstPnt1, gp_Pnt& theLastPnt1, gp_Pnt& theFirstPnt2, gp_Pnt& theLastPnt2, const Handle(Geom_Plane)& thePlane);
137   
138   //! Used  by  dimensions  only.Computes  the  3d geometry
139   //! of<anEdge1> and <anEdge2> and checks if they are infinite.
140   Standard_EXPORT static Standard_Boolean ComputeGeometry (const TopoDS_Edge& theFirstEdge, const TopoDS_Edge& theSecondEdge, Handle(Geom_Curve)& theFirstCurve, Handle(Geom_Curve)& theSecondCurve, gp_Pnt& theFirstPnt1, gp_Pnt& theLastPnt1, gp_Pnt& theFirstPnt2, gp_Pnt& theLastPnt2, Standard_Boolean& theIsinfinite1, Standard_Boolean& theIsinfinite2);
141   
142   //! Used  by  2d Relation  only Computes  the  3d geometry
143   //! of<anEdge1> and <anEdge2> in the current Plane and the
144   //! extremities if any.   Return in ExtCurve  the 3d curve
145   //! (not projected  in the  plane)  of the  first edge  if
146   //! <indexExt> =1 or of the 2nd edge if <indexExt> = 2. If
147   //! <indexExt> = 0, ExtCurve is Null.  if there is an edge
148   //! external to the  plane,  <isinfinite> is true if  this
149   //! edge is infinite.  So, the extremities of it are not
150   //! significant.  Return TRUE if ok
151   Standard_EXPORT static Standard_Boolean ComputeGeometry (const TopoDS_Edge& theFirstEdge, const TopoDS_Edge& theSecondEdge, Standard_Integer& theExtIndex, Handle(Geom_Curve)& theFirstCurve, Handle(Geom_Curve)& theSecondCurve, gp_Pnt& theFirstPnt1, gp_Pnt& theLastPnt1, gp_Pnt& theFirstPnt2, gp_Pnt& theLastPnt2, Handle(Geom_Curve)& theExtCurve, Standard_Boolean& theIsinfinite1, Standard_Boolean& theIsinfinite2, const Handle(Geom_Plane)& thePlane);
152   
153   //! Checks if aCurve belongs to aPlane; if not, projects aCurve in aPlane
154   //! and returns aCurve;
155   //! Return TRUE if ok
156   Standard_EXPORT static Standard_Boolean ComputeGeomCurve (Handle(Geom_Curve)& aCurve, const Standard_Real first1, const Standard_Real last1, gp_Pnt& FirstPnt1, gp_Pnt& LastPnt1, const Handle(Geom_Plane)& aPlane, Standard_Boolean& isOnPlane);
157   
158   Standard_EXPORT static Standard_Boolean ComputeGeometry (const TopoDS_Vertex& aVertex, gp_Pnt& point, const Handle(Geom_Plane)& aPlane, Standard_Boolean& isOnPlane);
159   
160   //! Tryes to get Plane from Face.  Returns Surface of Face
161   //! in aSurf.  Returns Standard_True  and Plane of Face in
162   //! aPlane in following  cases:
163   //! Face is Plane, Offset of Plane,
164   //! Extrusion of Line  and Offset of  Extrusion of Line
165   //! Returns pure type of Surface which can be:
166   //! Plane, Cylinder, Cone, Sphere, Torus,
167   //! SurfaceOfRevolution, SurfaceOfExtrusion
168   Standard_EXPORT static Standard_Boolean GetPlaneFromFace (const TopoDS_Face& aFace, gp_Pln& aPlane, Handle(Geom_Surface)& aSurf, AIS_KindOfSurface& aSurfType, Standard_Real& Offset);
169   
170   Standard_EXPORT static void InitFaceLength (const TopoDS_Face& aFace, gp_Pln& aPlane, Handle(Geom_Surface)& aSurface, AIS_KindOfSurface& aSurfaceType, Standard_Real& anOffset);
171   
172   //! Finds attachment points on two curvilinear faces for length dimension.
173   //! @param thePlaneDir [in] the direction on the dimension plane to
174   //! compute the plane automatically. It will not be taken into account if
175   //! plane is defined by user.
176   Standard_EXPORT static void InitLengthBetweenCurvilinearFaces (const TopoDS_Face& theFirstFace, const TopoDS_Face& theSecondFace, Handle(Geom_Surface)& theFirstSurf, Handle(Geom_Surface)& theSecondSurf, gp_Pnt& theFirstAttach, gp_Pnt& theSecondAttach, gp_Dir& theDirOnPlane);
177   
178   //! Finds three points for the angle dimension between
179   //! two planes.
180   Standard_EXPORT static Standard_Boolean InitAngleBetweenPlanarFaces (const TopoDS_Face& theFirstFace, const TopoDS_Face& theSecondFace, gp_Pnt& theCenter, gp_Pnt& theFirstAttach, gp_Pnt& theSecondAttach, const Standard_Boolean theIsFirstPointSet = Standard_False);
181   
182   //! Finds three points for the angle dimension between
183   //! two curvilinear surfaces.
184   Standard_EXPORT static Standard_Boolean InitAngleBetweenCurvilinearFaces (const TopoDS_Face& theFirstFace, const TopoDS_Face& theSecondFace, const AIS_KindOfSurface theFirstSurfType, const AIS_KindOfSurface theSecondSurfType, gp_Pnt& theCenter, gp_Pnt& theFirstAttach, gp_Pnt& theSecondAttach, const Standard_Boolean theIsFirstPointSet = Standard_False);
185   
186   Standard_EXPORT static gp_Pnt ProjectPointOnPlane (const gp_Pnt& aPoint, const gp_Pln& aPlane);
187   
188   Standard_EXPORT static gp_Pnt ProjectPointOnLine (const gp_Pnt& aPoint, const gp_Lin& aLine);
189   
190   Standard_EXPORT static gp_Pnt TranslatePointToBound (const gp_Pnt& aPoint, const gp_Dir& aDir, const Bnd_Box& aBndBox);
191   
192   //! returns  True  if  point  with anAttachPar  is
193   //! in  domain  of  arc
194   Standard_EXPORT static Standard_Boolean InDomain (const Standard_Real aFirstPar, const Standard_Real aLastPar, const Standard_Real anAttachPar);
195   
196   //! computes  nearest  to  ellipse  arc  apex
197   Standard_EXPORT static gp_Pnt NearestApex (const gp_Elips& elips, const gp_Pnt& pApex, const gp_Pnt& nApex, const Standard_Real fpara, const Standard_Real lpara, Standard_Boolean& IsInDomain);
198   
199   //! computes  length  of  ellipse  arc  in  parametric  units
200   Standard_EXPORT static Standard_Real DistanceFromApex (const gp_Elips& elips, const gp_Pnt& Apex, const Standard_Real par);
201   
202   Standard_EXPORT static void ComputeProjEdgePresentation (const Handle(Prs3d_Presentation)& aPres, const Handle(Prs3d_Drawer)& aDrawer, const TopoDS_Edge& anEdge, const Handle(Geom_Curve)& ProjCurve, const gp_Pnt& FirstP, const gp_Pnt& LastP, const Quantity_NameOfColor aColor = Quantity_NOC_PURPLE, const Standard_Real aWidth = 2, const Aspect_TypeOfLine aProjTOL = Aspect_TOL_DASH, const Aspect_TypeOfLine aCallTOL = Aspect_TOL_DOT);
203   
204   Standard_EXPORT static void ComputeProjVertexPresentation (const Handle(Prs3d_Presentation)& aPres, const Handle(Prs3d_Drawer)& aDrawer, const TopoDS_Vertex& aVertex, const gp_Pnt& ProjPoint, const Quantity_NameOfColor aColor = Quantity_NOC_PURPLE, const Standard_Real aWidth = 2, const Aspect_TypeOfMarker aProjTOM = Aspect_TOM_PLUS, const Aspect_TypeOfLine aCallTOL = Aspect_TOL_DOT);
205
206 };
207
208 #endif // _AIS_HeaderFile