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-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
   9 -- under the terms of the GNU Lesser General Public 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 class WFDeflectionRestrictedFace from StdPrs
  18
  19 inherits Root from Prs3d
  20
  21
  22         ---Purpose: A framework to provide display of U and V
  23         -- isoparameters of faces, while allowing you to impose
  24         -- a deflection on them.
  25
  26 uses
  27     HSurface             from BRepAdaptor,
  28     Presentation         from Prs3d,
  29     Drawer               from Prs3d,
  30     Length               from Quantity,
  31     NListOfSequenceOfPnt from Prs3d
  32
  33
  34 is
  35     Add(myclass; aPresentation: Presentation from Prs3d;
  36                  aFace        : HSurface     from BRepAdaptor;
  37                  aDrawer      : Drawer       from Prs3d);
  38         ---Purpose: Defines a display featuring U and V isoparameters.
  39         -- Adds the surface aFace to the
  40         -- StdPrs_WFRestrictedFace algorithm. This face is
  41         -- found in a shape in the presentation object
  42         -- aPresentation, and its display attributes - in
  43         -- particular, the number of U and V isoparameters - are
  44         -- set in the attribute manager aDrawer.
  45         -- aFace is BRepAdaptor_HSurface surface created
  46         -- from a face in a topological shape.   which is passed
  47         -- as an argument through the
  48         -- BRepAdaptor_HSurface surface created from it.
  49         -- This is what allows the topological face to be treated
  50         -- as a geometric surface.
  51
  52     AddUIso(myclass; aPresentation: Presentation from Prs3d;
  53                      aFace        : HSurface     from BRepAdaptor;
  54                      aDrawer      : Drawer       from Prs3d);
  55         ---Purpose:     Defines a display featuring U isoparameters
  56         -- respectively. Add the surface aFace to the
  57         -- StdPrs_WFRestrictedFace algorithm. This face
  58         -- is found in a shape in the presentation object
  59         -- aPresentation, and its display attributes - in
  60         -- particular, the number of U isoparameters -
  61         -- are set in the attribute manager aDrawer.
  62         -- aFace is BRepAdaptor_HSurface surface
  63         -- created from a face in a topological shape.   which
  64         -- is passed to the function as an argument through
  65         -- the BRepAdaptor_HSurface surface created from
  66         -- it. This is what allows the topological face to be
  67         -- treated as a geometric surface.
  68
  69     AddVIso(myclass; aPresentation: Presentation from Prs3d;
  70                      aFace        : HSurface     from BRepAdaptor;
  71                      aDrawer      : Drawer       from Prs3d);
  72         ---Purpose:     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
  86     Add(myclass;  aPresentation: Presentation from Prs3d;
  87                   aFace        : HSurface     from BRepAdaptor;
  88                   DrawUIso, DrawVIso: Boolean from Standard;
  89                   Deflection   : Length       from Quantity;
  90                   NBUiso,NBViso: Integer      from Standard;
  91                   aDrawer      : Drawer       from Prs3d;
  92                   Curves       : out NListOfSequenceOfPnt from Prs3d);
  93         ---Purpose: Defines a display of a delection-specified face. The
  94         -- display will feature U and V isoparameters.
  95         -- Adds the topology aShape to the
  96         -- StdPrs_WFRestrictedFace algorithm. This shape is
  97         -- found in the presentation object aPresentation, and
  98         -- its display attributes - except the number of U and V
  99         -- isoparameters - are set in the attribute manager aDrawer.
 100         -- The function sets the number of U and V
 101         -- isoparameters, NBUiso and NBViso, in the shape. To
 102         -- do this, the arguments DrawUIso and DrawVIso must be true.
 103         -- aFace is BRepAdaptor_HSurface surface created
 104         -- from a face in a topological shape.   which is passed
 105         -- as an argument through the
 106         -- BRepAdaptor_HSurface surface created from it.
 107         -- This is what allows the topological face to be treated
 108         -- as a geometric surface.
 109         -- Curves give a sequence of face curves, it is used if the PrimitiveArray
 110         -- visualization approach is activated (it is activated by default).
 111
 112     Match(myclass; X,Y,Z    : Length   from Quantity;
 113                    aDistance: Length   from Quantity;
 114                    aFace    : HSurface from BRepAdaptor;
 115                    aDrawer  : Drawer   from Prs3d)
 116     returns Boolean from Standard;
 117
 118     MatchUIso(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     MatchVIso(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
 131     Match(myclass;X,Y,Z        : Length       from Quantity;
 132                   aDistance    : Length       from Quantity;
 133                   aFace        : HSurface     from BRepAdaptor;
 134                   aDrawer      : Drawer       from Prs3d;
 135                   DrawUIso, DrawVIso: Boolean from Standard;
 136                   aDeflection  : Length       from Quantity;
 137                   NBUiso,NBViso: Integer      from Standard)
 138
 139     returns Boolean from Standard;
 140
 141 end WFDeflectionRestrictedFace;
 142