0030675: Visualization - remove redundant proxy classes in hierarchy of PrsMgr_Presen...
[occt.git] / src / DsgPrs / DsgPrs_LengthPresentation.hxx
1 // Created on: 1993-06-03
2 // Created by: Jean-Louis FRENKEL
3 // Copyright (c) 1993-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 _DsgPrs_LengthPresentation_HeaderFile
18 #define _DsgPrs_LengthPresentation_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Prs3d_Drawer.hxx>
25 #include <DsgPrs_ArrowSide.hxx>
26 #include <Prs3d_Presentation.hxx>
27
28 class TCollection_ExtendedString;
29 class gp_Pnt;
30 class gp_Dir;
31 class gp_Pln;
32 class Geom_Surface;
33
34 //! Framework for displaying lengths.
35 //! The length displayed is indicated by line segments
36 //! and text alone or by a combination of line segment,
37 //! text and   arrows at either or both of its ends.
38 class DsgPrs_LengthPresentation 
39 {
40 public:
41
42   DEFINE_STANDARD_ALLOC
43
44   
45   //! Draws a line segment representing a length in the
46   //! display aPresentation.
47   //! This segment joins the points AttachmentPoint1 and
48   //! AttachmentPoint2, along the direction aDirection.
49   //! The text aText will be displayed at the offset point OffsetPoint.
50   //! The line and text attributes are specified by the
51   //! attribute manager aDrawer.
52   Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& aPresentation, const Handle(Prs3d_Drawer)& aDrawer, const TCollection_ExtendedString& aText, const gp_Pnt& AttachmentPoint1, const gp_Pnt& AttachmentPoint2, const gp_Dir& aDirection, const gp_Pnt& OffsetPoint);
53   
54   //! Draws a line segment representing a length in the
55   //! display aPresentation.
56   //! This segment joins the points AttachmentPoint1 and
57   //! AttachmentPoint2, along the direction aDirection.
58   //! The text aText will be displayed at the offset point
59   //! OffsetPoint. The value of the enumeration ArrowSide
60   //! controls whether arrows will be displayed at either or
61   //! both ends of the length.
62   //! The line, text and arrow attributes are specified by the
63   //! attribute manager aDrawer.
64   Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& aPresentation, const Handle(Prs3d_Drawer)& aDrawer, const TCollection_ExtendedString& aText, const gp_Pnt& AttachmentPoint1, const gp_Pnt& AttachmentPoint2, const gp_Dir& aDirection, const gp_Pnt& OffsetPoint, const DsgPrs_ArrowSide ArrowSide);
65   
66   //! Draws a line segment representing a length in the
67   //! display aPresentation.
68   //! This segment joins the points AttachmentPoint1 and
69   //! AttachmentPoint2, along the direction aDirection.
70   //! The text aText will be displayed at the offset point
71   //! OffsetPoint. The value of the enumeration ArrowSide
72   //! controls whether arrows will be displayed at either or
73   //! both ends of the length.
74   //! The plane PlaneOfFaces is used if length is null.
75   //! The line, text and arrow attributes are specified by the
76   //! attribute manager aDrawer.
77   Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& aPresentation, const Handle(Prs3d_Drawer)& aDrawer, const TCollection_ExtendedString& aText, const gp_Pnt& AttachmentPoint1, const gp_Pnt& AttachmentPoint2, const gp_Pln& PlaneOfFaces, const gp_Dir& aDirection, const gp_Pnt& OffsetPoint, const DsgPrs_ArrowSide ArrowSide);
78   
79   //! Draws a line segment representing a length in the
80   //! display aPresentation.
81   //! This segment joins the points AttachmentPoint1 and
82   //! AttachmentPoint2, along the direction
83   //! aDirection.   AttachmentPoint2 lies on the curvilinear
84   //! faces SecondSurf. The text aText will be displayed at
85   //! the offset point OffsetPoint. The value of the
86   //! enumeration ArrowSide controls whether arrows will
87   //! be displayed at either or both ends of the length.
88   //! The line, text and arrow attributes are specified by the
89   //! attribute manager aDrawer.
90   Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& aPresentation, const Handle(Prs3d_Drawer)& aDrawer, const TCollection_ExtendedString& aText, const Handle(Geom_Surface)& SecondSurf, const gp_Pnt& AttachmentPoint1, const gp_Pnt& AttachmentPoint2, const gp_Dir& aDirection, const gp_Pnt& OffsetPoint, const DsgPrs_ArrowSide ArrowSide);
91   
92   //! Draws a line segment representing a length in the
93   //! display aPresentation.
94   //! This segment joins the points AttachmentPoint1 and
95   //! AttachmentPoint2, along the direction aDirection.
96   //! The value of the enumeration ArrowSide controls
97   //! whether arrows will be displayed at either or both ends of the length.
98   //! The line and arrow attributes are specified by the attribute manager aDrawer.
99   Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& aPresentation, const Handle(Prs3d_Drawer)& aDrawer, const gp_Pnt& Pt1, const gp_Pnt& Pt2, const DsgPrs_ArrowSide ArrowSide);
100
101
102
103
104 protected:
105
106
107
108
109
110 private:
111
112
113
114
115
116 };
117
118
119
120
121
122
123
124 #endif // _DsgPrs_LengthPresentation_HeaderFile