0030675: Visualization - remove redundant proxy classes in hierarchy of PrsMgr_Presen...
[occt.git] / src / StdPrs / StdPrs_WFDeflectionRestrictedFace.hxx
1 // Created on: 1995-08-07
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_WFDeflectionRestrictedFace_HeaderFile
18 #define _StdPrs_WFDeflectionRestrictedFace_HeaderFile
19
20 #include <Prs3d_Root.hxx>
21 #include <Prs3d_Drawer.hxx>
22 #include <Prs3d_NListOfSequenceOfPnt.hxx>
23
24 class BRepAdaptor_HSurface;
25 class Bnd_Box;
26
27 //! A framework to provide display of U and V
28 //! isoparameters of faces, while allowing you to impose
29 //! a deflection on them.
30 //! Computes the wireframe presentation of faces with
31 //! restrictions by displaying a given number of U and/or
32 //! V isoparametric curves. The isoparametric curves are
33 //! drawn with respect to a maximal chordial deviation.
34 //! The presentation includes the restriction curves.
35 class StdPrs_WFDeflectionRestrictedFace  : public Prs3d_Root
36 {
37 public:
38
39   DEFINE_STANDARD_ALLOC
40
41   
42   //! Defines a display featuring U and V isoparameters.
43   //! Adds the surface aFace to the
44   //! StdPrs_WFRestrictedFace algorithm. This face is
45   //! found in a shape in the presentation object
46   //! aPresentation, and its display attributes - in
47   //! particular, the number of U and V isoparameters - are
48   //! set in the attribute manager aDrawer.
49   //! aFace is BRepAdaptor_HSurface surface created
50   //! from a face in a topological shape.   which is passed
51   //! as an argument through the
52   //! BRepAdaptor_HSurface surface created from it.
53   //! This is what allows the topological face to be treated
54   //! as a geometric surface.
55   Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& aPresentation, const Handle(BRepAdaptor_HSurface)& aFace, const Handle(Prs3d_Drawer)& aDrawer);
56   
57   //! Defines a display featuring U isoparameters
58   //! respectively. Add the surface aFace to the
59   //! StdPrs_WFRestrictedFace algorithm. This face
60   //! is found in a shape in the presentation object
61   //! aPresentation, and its display attributes - in
62   //! particular, the number of U isoparameters -
63   //! are set in the attribute manager aDrawer.
64   //! aFace is BRepAdaptor_HSurface surface
65   //! created from a face in a topological shape.   which
66   //! is passed to the function as an argument through
67   //! the BRepAdaptor_HSurface surface created from
68   //! it. This is what allows the topological face to be
69   //! treated as a geometric surface.
70   Standard_EXPORT static void AddUIso (const Handle(Prs3d_Presentation)& aPresentation, const Handle(BRepAdaptor_HSurface)& aFace, const Handle(Prs3d_Drawer)& aDrawer);
71   
72   //! Defines a display featuring V isoparameters
73   //! respectively. Add the surface aFace to the
74   //! StdPrs_WFRestrictedFace algorithm. This face
75   //! is found in a shape in the presentation object
76   //! aPresentation, and its display attributes - in
77   //! particular, the number of V isoparameters -
78   //! are set in the attribute manager aDrawer.
79   //! aFace is BRepAdaptor_HSurface surface
80   //! created from a face in a topological shape.   which
81   //! is passed to the function as an argument through
82   //! the BRepAdaptor_HSurface surface created from
83   //! it. This is what allows the topological face to be
84   //! treated as a geometric surface.
85   Standard_EXPORT static void AddVIso (const Handle(Prs3d_Presentation)& aPresentation, const Handle(BRepAdaptor_HSurface)& aFace, const Handle(Prs3d_Drawer)& aDrawer);
86   
87   //! Defines a display of a delection-specified face. The
88   //! display will feature U and V isoparameters.
89   //! Adds the topology aShape to the
90   //! StdPrs_WFRestrictedFace algorithm. This shape is
91   //! found in the presentation object aPresentation, and
92   //! its display attributes - except the number of U and V
93   //! isoparameters - are set in the attribute manager aDrawer.
94   //! The function sets the number of U and V
95   //! isoparameters, NBUiso and NBViso, in the shape. To
96   //! do this, the arguments DrawUIso and DrawVIso must be true.
97   //! aFace is BRepAdaptor_HSurface surface created
98   //! from a face in a topological shape.   which is passed
99   //! as an argument through the
100   //! BRepAdaptor_HSurface surface created from it.
101   //! This is what allows the topological face to be treated
102   //! as a geometric surface.
103   //! Curves give a sequence of face curves, it is used if the PrimitiveArray
104   //! visualization approach is activated (it is activated by default).
105   Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& aPresentation, const Handle(BRepAdaptor_HSurface)& aFace, const Standard_Boolean DrawUIso, const Standard_Boolean DrawVIso, const Standard_Real Deflection, const Standard_Integer NBUiso, const Standard_Integer NBViso, const Handle(Prs3d_Drawer)& aDrawer, Prs3d_NListOfSequenceOfPnt& Curves);
106   
107   Standard_EXPORT static Standard_Boolean Match (const Standard_Real X, const Standard_Real Y, const Standard_Real Z, const Standard_Real aDistance, const Handle(BRepAdaptor_HSurface)& aFace, const Handle(Prs3d_Drawer)& aDrawer);
108   
109   Standard_EXPORT static Standard_Boolean MatchUIso (const Standard_Real X, const Standard_Real Y, const Standard_Real Z, const Standard_Real aDistance, const Handle(BRepAdaptor_HSurface)& aFace, const Handle(Prs3d_Drawer)& aDrawer);
110   
111   Standard_EXPORT static Standard_Boolean MatchVIso (const Standard_Real X, const Standard_Real Y, const Standard_Real Z, const Standard_Real aDistance, const Handle(BRepAdaptor_HSurface)& aFace, const Handle(Prs3d_Drawer)& aDrawer);
112   
113   Standard_EXPORT static Standard_Boolean Match (const Standard_Real X, const Standard_Real Y, const Standard_Real Z, const Standard_Real aDistance, const Handle(BRepAdaptor_HSurface)& aFace, const Handle(Prs3d_Drawer)& aDrawer, const Standard_Boolean DrawUIso, const Standard_Boolean DrawVIso, const Standard_Real aDeflection, const Standard_Integer NBUiso, const Standard_Integer NBViso);
114
115 };
116
117 #endif // _StdPrs_WFDeflectionRestrictedFace_HeaderFile