src/IntTools/IntTools_PntOnFace.cdl

   1 -- Created on: 2001-12-13
   2 -- Created by: Peter KURNEV
   3 -- Copyright (c) 2001-2014 OPEN CASCADE SAS
   4 --
   5 -- This file is part of Open CASCADE Technology software library.
   6 --
   7 -- This library is free software; you can redistribute it and/or modify it under
   8 -- the terms of the GNU Lesser General Public License version 2.1 as published
   9 -- by the Free Software Foundation, with special exception defined in the file
  10 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 -- distribution for complete text of the license and disclaimer of any warranty.
  12 --
  13 -- Alternatively, this file may be used under the terms of Open CASCADE
  14 -- commercial license or contractual agreement.
  15
  16 class PntOnFace from IntTools
  17
  18         ---Purpose: Contains a Face, a 3d point, corresponded UV parameters and a flag
  19
  20 uses
  21     Face from TopoDS,
  22     Pnt  from  gp
  23 --raises
  24
  25 is
  26     Create
  27         returns PntOnFace from IntTools;
  28         ---Purpose:
  29         --- Empty constructor
  30         ---
  31
  32     Init(me:out;
  33          aF: Face from TopoDS;
  34          aP: Pnt  from  gp;
  35          U : Real from  Standard;
  36          V : Real from  Standard);
  37         ---Purpose:
  38         --- Initializes me by aFace, a 3d point
  39         --- and it's UV parameters on face
  40         ---
  41
  42     SetFace(me:out;
  43             aF:Face from TopoDS);
  44         ---Purpose:
  45         --- Modifier
  46         ---
  47
  48     SetPnt (me:out;
  49             aP:Pnt  from  gp);
  50         ---Purpose:
  51         --- Modifier
  52         ---
  53
  54     SetParameters (me:out;
  55                    U : Real from  Standard;
  56                    V : Real from  Standard);
  57         ---Purpose:
  58         --- Modifier
  59         ---
  60
  61     SetValid(me:out;
  62              bF : Boolean from Standard);
  63         ---Purpose:
  64         --- Modifier
  65         ---
  66
  67     Valid(me)
  68         returns Boolean from Standard;
  69         ---Purpose:
  70         --- Selector
  71         ---
  72
  73     Face(me)
  74         returns Face from TopoDS;
  75         ---C++:  return const &
  76         ---Purpose:
  77         --- Selector
  78         ---
  79
  80     Pnt (me)
  81         returns Pnt  from gp;
  82         ---C++:  return const &
  83         ---Purpose:
  84         --- Selector
  85         ---
  86
  87     Parameters (me;
  88                 U :out Real from Standard;
  89                 V :out Real from Standard);
  90         ---Purpose:
  91         --- Selector
  92         ---
  93
  94     IsValid(me)
  95         returns Boolean from Standard;
  96         ---Purpose:
  97         --- Selector
  98
  99 fields
 100
 101     myIsValid : Boolean from Standard;
 102     myPnt : Pnt  from  gp;
 103     myU   : Real from  Standard;
 104     myV   : Real from  Standard;
 105     myFace: Face from TopoDS;
 106 end PntOnFace;