src/StdPrs/StdPrs_WFDeflectionRestrictedFace.cdl

   1 -- Created on: 1995-08-07
   2 -- Created by: Modelistation
   3 -- Copyright (c) 1995-1999 Matra Datavision
   4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
   5 --
   6 -- The content of this file is subject to the Open CASCADE Technology Public
   7 -- License Version 6.5 (the "License"). You may not use the content of this file
   8 -- except in compliance with the License. Please obtain a copy of the License
   9 -- at http://www.opencascade.org and read it completely before using this file.
  10 --
  11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  13 --
  14 -- The Original Code and all software distributed under the License is
  15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  16 -- Initial Developer hereby disclaims all such warranties, including without
  17 -- limitation, any warranties of merchantability, fitness for a particular
  18 -- purpose or non-infringement. Please see the License for the specific terms
  19 -- and conditions governing the rights and limitations under the License.
  20
  21
  22
  23 class WFDeflectionRestrictedFace from StdPrs
  24
  25 inherits Root from Prs3d
  26
  27
  28         ---Purpose: A framework to provide display of U and V
  29         -- isoparameters of faces, while allowing you to impose
  30         -- a deflection on them.
  31
  32 uses
  33     HSurface             from BRepAdaptor,
  34     Presentation         from Prs3d,
  35     Drawer               from Prs3d,
  36     Length               from Quantity,
  37     NListOfSequenceOfPnt from Prs3d
  38
  39
  40 is
  41     Add(myclass; aPresentation: Presentation from Prs3d;
  42                  aFace        : HSurface     from BRepAdaptor;
  43                  aDrawer      : Drawer       from Prs3d);
  44         ---Purpose: Defines a display featuring U and V isoparameters.
  45         -- Adds the surface aFace to the
  46         -- StdPrs_WFRestrictedFace algorithm. This face is
  47         -- found in a shape in the presentation object
  48         -- aPresentation, and its display attributes - in
  49         -- particular, the number of U and V isoparameters - are
  50         -- set in the attribute manager aDrawer.
  51         -- aFace is BRepAdaptor_HSurface surface created
  52         -- from a face in a topological shape.   which is passed
  53         -- as an argument through the
  54         -- BRepAdaptor_HSurface surface created from it.
  55         -- This is what allows the topological face to be treated
  56         -- as a geometric surface.
  57
  58     AddUIso(myclass; aPresentation: Presentation from Prs3d;
  59                      aFace        : HSurface     from BRepAdaptor;
  60                      aDrawer      : Drawer       from Prs3d);
  61         ---Purpose:     Defines a display featuring U isoparameters
  62         -- respectively. Add the surface aFace to the
  63         -- StdPrs_WFRestrictedFace algorithm. This face
  64         -- is found in a shape in the presentation object
  65         -- aPresentation, and its display attributes - in
  66         -- particular, the number of U isoparameters -
  67         -- are set in the attribute manager aDrawer.
  68         -- aFace is BRepAdaptor_HSurface surface
  69         -- created from a face in a topological shape.   which
  70         -- is passed to the function as an argument through
  71         -- the BRepAdaptor_HSurface surface created from
  72         -- it. This is what allows the topological face to be
  73         -- treated as a geometric surface.
  74
  75     AddVIso(myclass; aPresentation: Presentation from Prs3d;
  76                      aFace        : HSurface     from BRepAdaptor;
  77                      aDrawer      : Drawer       from Prs3d);
  78         ---Purpose:     Defines a display featuring V isoparameters
  79         -- respectively. Add the surface aFace to the
  80         -- StdPrs_WFRestrictedFace algorithm. This face
  81         -- is found in a shape in the presentation object
  82         -- aPresentation, and its display attributes - in
  83         -- particular, the number of V isoparameters -
  84         -- are set in the attribute manager aDrawer.
  85         -- aFace is BRepAdaptor_HSurface surface
  86         -- created from a face in a topological shape.   which
  87         -- is passed to the function as an argument through
  88         -- the BRepAdaptor_HSurface surface created from
  89         -- it. This is what allows the topological face to be
  90         -- treated as a geometric surface.
  91
  92     Add(myclass;  aPresentation: Presentation from Prs3d;
  93                   aFace        : HSurface     from BRepAdaptor;
  94                   DrawUIso, DrawVIso: Boolean from Standard;
  95                   Deflection   : Length       from Quantity;
  96                   NBUiso,NBViso: Integer      from Standard;
  97                   aDrawer      : Drawer       from Prs3d;
  98                   Curves       : out NListOfSequenceOfPnt from Prs3d);
  99         ---Purpose: Defines a display of a delection-specified face. The
 100         -- display will feature U and V isoparameters.
 101         -- Adds the topology aShape to the
 102         -- StdPrs_WFRestrictedFace algorithm. This shape is
 103         -- found in the presentation object aPresentation, and
 104         -- its display attributes - except the number of U and V
 105         -- isoparameters - are set in the attribute manager aDrawer.
 106         -- The function sets the number of U and V
 107         -- isoparameters, NBUiso and NBViso, in the shape. To
 108         -- do this, the arguments DrawUIso and DrawVIso must be true.
 109         -- aFace is BRepAdaptor_HSurface surface created
 110         -- from a face in a topological shape.   which is passed
 111         -- as an argument through the
 112         -- BRepAdaptor_HSurface surface created from it.
 113         -- This is what allows the topological face to be treated
 114         -- as a geometric surface.
 115         -- Curves give a sequence of face curves, it is used if the PrimitiveArray
 116         -- visualization approach is activated (it is activated by default).
 117
 118     Match(myclass; X,Y,Z    : Length   from Quantity;
 119                    aDistance: Length   from Quantity;
 120                    aFace    : HSurface from BRepAdaptor;
 121                    aDrawer  : Drawer   from Prs3d)
 122     returns Boolean from Standard;
 123
 124     MatchUIso(myclass; X,Y,Z    : Length   from Quantity;
 125                        aDistance: Length   from Quantity;
 126                        aFace    : HSurface from BRepAdaptor;
 127                        aDrawer  : Drawer   from Prs3d)
 128     returns Boolean from Standard;
 129
 130     MatchVIso(myclass; X,Y,Z    : Length   from Quantity;
 131                        aDistance: Length   from Quantity;
 132                        aFace    : HSurface from BRepAdaptor;
 133                        aDrawer  : Drawer   from Prs3d)
 134     returns Boolean from Standard;
 135
 136
 137     Match(myclass;X,Y,Z        : Length       from Quantity;
 138                   aDistance    : Length       from Quantity;
 139                   aFace        : HSurface     from BRepAdaptor;
 140                   aDrawer      : Drawer       from Prs3d;
 141                   DrawUIso, DrawVIso: Boolean from Standard;
 142                   aDeflection  : Length       from Quantity;
 143                   NBUiso,NBViso: Integer      from Standard)
 144
 145     returns Boolean from Standard;
 146
 147 end WFDeflectionRestrictedFace;
 148