0030675: Visualization - remove redundant proxy classes in hierarchy of PrsMgr_Presen...
[occt.git] / src / StdPrs / StdPrs_Curve.hxx
1 // Created on: 1995-08-04
2 // Created by: Modelistation
3 // Copyright (c) 1995-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 _StdPrs_Curve_HeaderFile
18 #define _StdPrs_Curve_HeaderFile
19
20 #include <Prs3d_Root.hxx>
21 #include <Prs3d_Drawer.hxx>
22 #include <TColgp_SequenceOfPnt.hxx>
23
24 class Adaptor3d_Curve;
25
26 //! A framework to define display of lines, arcs of circles
27 //! and conic sections.
28 //! This is done with a fixed number of points, which can be modified.
29 class StdPrs_Curve  : public Prs3d_Root
30 {
31 public:
32
33   DEFINE_STANDARD_ALLOC
34
35   
36   //! Adds to the presentation aPresentation the drawing of the curve aCurve.
37   //! The aspect is defined by LineAspect in aDrawer.
38   //! If drawCurve equals Standard_False the curve will not be displayed,
39   //! it is used if the curve is a part of some shape and PrimitiveArray
40   //! visualization approach is activated (it is activated by default).
41   Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& aPresentation, const Adaptor3d_Curve& aCurve, const Handle(Prs3d_Drawer)& aDrawer, const Standard_Boolean drawCurve = Standard_True);
42   
43   //! Adds to the presentation aPresentation the drawing of the curve aCurve.
44   //! The aspect is defined by LineAspect in aDrawer.
45   //! The drawing will be limited between the points of parameter U1 and U2.
46   //! If drawCurve equals Standard_False the curve will not be displayed,
47   //! it is used if the curve is a part of some shape and PrimitiveArray
48   //! visualization approach is activated (it is activated by default).
49   Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& aPresentation, const Adaptor3d_Curve& aCurve, const Standard_Real U1, const Standard_Real U2, const Handle(Prs3d_Drawer)& aDrawer, const Standard_Boolean drawCurve = Standard_True);
50   
51   //! adds to the presentation aPresentation the drawing of the curve aCurve.
52   //! The aspect is the current aspect.
53   //! aDeflection is used in the circle case.
54   //! Points give a sequence of curve points.
55   //! If drawCurve equals Standard_False the curve will not be displayed,
56   //! it is used if the curve is a part of some shape and PrimitiveArray
57   //! visualization approach is activated (it is activated by default).
58   Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& aPresentation, const Adaptor3d_Curve& aCurve, const Handle(Prs3d_Drawer)& aDrawer, TColgp_SequenceOfPnt& Points, const Standard_Boolean drawCurve = Standard_True);
59   
60   //! adds to the presentation aPresentation the drawing of the curve
61   //! aCurve.
62   //! The aspect is the current aspect.
63   //! The drawing will be limited between the points of parameter
64   //! U1 and U2.
65   //! aDeflection is used in the circle case.
66   //! Points give a sequence of curve points.
67   //! If drawCurve equals Standard_False the curve will not be displayed,
68   //! it is used if the curve is a part of some shape and PrimitiveArray
69   //! visualization approach is activated (it is activated by default).
70   Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& aPresentation, const Adaptor3d_Curve& aCurve, const Standard_Real U1, const Standard_Real U2, TColgp_SequenceOfPnt& Points, const Standard_Integer aNbPoints = 30, const Standard_Boolean drawCurve = Standard_True);
71   
72   //! returns true if the distance between the point (X,Y,Z) and the
73   //! drawing of the curve is less than aDistance.
74   Standard_EXPORT static Standard_Boolean Match (const Standard_Real X, const Standard_Real Y, const Standard_Real Z, const Standard_Real aDistance, const Adaptor3d_Curve& aCurve, const Handle(Prs3d_Drawer)& aDrawer);
75   
76   //! returns true if the distance between the point (X,Y,Z) and the
77   //! drawing of the curve is less than aDistance.
78   Standard_EXPORT static Standard_Boolean Match (const Standard_Real X, const Standard_Real Y, const Standard_Real Z, const Standard_Real aDistance, const Adaptor3d_Curve& aCurve, const Standard_Real aDeflection, const Standard_Real aLimit, const Standard_Integer aNbPoints);
79   
80   //! returns true if the distance between the point (X,Y,Z) and the
81   //! drawing of the curve aCurve is less than aDistance.
82   //! The drawing is considered between the points
83   //! of parameter U1 and U2;
84   Standard_EXPORT static Standard_Boolean Match (const Standard_Real X, const Standard_Real Y, const Standard_Real Z, const Standard_Real aDistance, const Adaptor3d_Curve& aCurve, const Standard_Real U1, const Standard_Real U2, const Handle(Prs3d_Drawer)& aDrawer);
85   
86   //! returns true if the distance between the point (X,Y,Z) and the
87   //! drawing of the curve aCurve is less than aDistance.
88   //! The drawing is considered between the points
89   //! of parameter U1 and U2;
90   Standard_EXPORT static Standard_Boolean Match (const Standard_Real X, const Standard_Real Y, const Standard_Real Z, const Standard_Real aDistance, const Adaptor3d_Curve& aCurve, const Standard_Real U1, const Standard_Real U2, const Standard_Real aDeflection, const Standard_Integer aNbPoints);
91
92 };
93
94 #endif // _StdPrs_Curve_HeaderFile