Integration of OCCT 6.5.0 from SVN
[occt.git] / src / StdPrs / StdPrs_WFDeflectionRestrictedFace.cdl
1 -- File:        StdPrs_WFDeflectionRestrictedFace.cdl
2 -- Created:     Mon Aug  7 10:18:39 1995
3 -- Author:      Modelistation
4 --              <model@metrox>
5 ---Copyright:    Matra Datavision 1995
6
7
8 class WFDeflectionRestrictedFace from StdPrs
9           
10 inherits Root from Prs3d
11          
12
13         ---Purpose: A framework to provide display of U and V
14         -- isoparameters of faces, while allowing you to impose
15         -- a deflection on them.
16
17 uses
18     HSurface             from BRepAdaptor,
19     Presentation         from Prs3d,
20     Drawer               from Prs3d,
21     Length               from Quantity, 
22     NListOfSequenceOfPnt from Prs3d
23
24     
25 is
26     Add(myclass; aPresentation: Presentation from Prs3d; 
27                  aFace        : HSurface     from BRepAdaptor;
28                  aDrawer      : Drawer       from Prs3d);
29         ---Purpose: Defines a display featuring U and V isoparameters.
30         -- Adds the surface aFace to the
31         -- StdPrs_WFRestrictedFace algorithm. This face is
32         -- found in a shape in the presentation object
33         -- aPresentation, and its display attributes - in
34         -- particular, the number of U and V isoparameters - are
35         -- set in the attribute manager aDrawer.
36         -- aFace is BRepAdaptor_HSurface surface created
37         -- from a face in a topological shape.   which is passed
38         -- as an argument through the
39         -- BRepAdaptor_HSurface surface created from it.
40         -- This is what allows the topological face to be treated
41         -- as a geometric surface.       
42     
43     AddUIso(myclass; aPresentation: Presentation from Prs3d; 
44                      aFace        : HSurface     from BRepAdaptor;
45                      aDrawer      : Drawer       from Prs3d);
46         ---Purpose:     Defines a display featuring U isoparameters
47         -- respectively. Add the surface aFace to the
48         -- StdPrs_WFRestrictedFace algorithm. This face
49         -- is found in a shape in the presentation object
50         -- aPresentation, and its display attributes - in
51         -- particular, the number of U isoparameters -
52         -- are set in the attribute manager aDrawer.
53         -- aFace is BRepAdaptor_HSurface surface
54         -- created from a face in a topological shape.   which
55         -- is passed to the function as an argument through
56         -- the BRepAdaptor_HSurface surface created from
57         -- it. This is what allows the topological face to be
58         -- treated as a geometric surface.
59         
60     AddVIso(myclass; aPresentation: Presentation from Prs3d; 
61                      aFace        : HSurface     from BRepAdaptor;
62                      aDrawer      : Drawer       from Prs3d);
63         ---Purpose:     Defines a display featuring V isoparameters
64         -- respectively. Add the surface aFace to the
65         -- StdPrs_WFRestrictedFace algorithm. This face
66         -- is found in a shape in the presentation object
67         -- aPresentation, and its display attributes - in
68         -- particular, the number of V isoparameters -
69         -- are set in the attribute manager aDrawer.
70         -- aFace is BRepAdaptor_HSurface surface
71         -- created from a face in a topological shape.   which
72         -- is passed to the function as an argument through
73         -- the BRepAdaptor_HSurface surface created from
74         -- it. This is what allows the topological face to be
75         -- treated as a geometric surface.
76     
77     Add(myclass;  aPresentation: Presentation from Prs3d; 
78                   aFace        : HSurface     from BRepAdaptor;
79                   DrawUIso, DrawVIso: Boolean from Standard;
80                   Deflection   : Length       from Quantity;
81                   NBUiso,NBViso: Integer      from Standard;
82                   aDrawer      : Drawer       from Prs3d; 
83                   Curves       : out NListOfSequenceOfPnt from Prs3d);
84         ---Purpose: Defines a display of a delection-specified face. The
85         -- display will feature U and V isoparameters.
86         -- Adds the topology aShape to the
87         -- StdPrs_WFRestrictedFace algorithm. This shape is
88         -- found in the presentation object aPresentation, and
89         -- its display attributes - except the number of U and V
90         -- isoparameters - are set in the attribute manager aDrawer.
91         -- The function sets the number of U and V
92         -- isoparameters, NBUiso and NBViso, in the shape. To
93         -- do this, the arguments DrawUIso and DrawVIso must be true.
94         -- aFace is BRepAdaptor_HSurface surface created
95         -- from a face in a topological shape.   which is passed
96         -- as an argument through the
97         -- BRepAdaptor_HSurface surface created from it.
98         -- This is what allows the topological face to be treated
99         -- as a geometric surface.  
100         -- Curves give a sequence of face curves, it is used if the PrimitiveArray  
101         -- visualization approach is activated (it is activated by default).
102         
103     Match(myclass; X,Y,Z    : Length   from Quantity;
104                    aDistance: Length   from Quantity;
105                    aFace    : HSurface from BRepAdaptor;
106                    aDrawer  : Drawer   from Prs3d)
107     returns Boolean from Standard;
108                  
109     MatchUIso(myclass; X,Y,Z    : Length   from Quantity;
110                        aDistance: Length   from Quantity;
111                        aFace    : HSurface from BRepAdaptor;
112                        aDrawer  : Drawer   from Prs3d)
113     returns Boolean from Standard;
114                  
115     MatchVIso(myclass; X,Y,Z    : Length   from Quantity;
116                        aDistance: Length   from Quantity;
117                        aFace    : HSurface from BRepAdaptor;
118                        aDrawer  : Drawer   from Prs3d)
119     returns Boolean from Standard;
120                  
121
122     Match(myclass;X,Y,Z        : Length       from Quantity;
123                   aDistance    : Length       from Quantity;
124                   aFace        : HSurface     from BRepAdaptor; 
125                   aDrawer      : Drawer       from Prs3d;
126                   DrawUIso, DrawVIso: Boolean from Standard;
127                   aDeflection  : Length       from Quantity;
128                   NBUiso,NBViso: Integer      from Standard)
129
130     returns Boolean from Standard;        
131                    
132 end WFDeflectionRestrictedFace;
133