src/IntTools/IntTools_PntOnFace.cdl

   1 -- Created on: 2001-12-13
   2 -- Created by: Peter KURNEV
   3 -- Copyright (c) 2001-2012 OPEN CASCADE SAS
   4 --
   5 -- The content of this file is subject to the Open CASCADE Technology Public
   6 -- License Version 6.5 (the "License"). You may not use the content of this file
   7 -- except in compliance with the License. Please obtain a copy of the License
   8 -- at http://www.opencascade.org and read it completely before using this file.
   9 --
  10 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  11 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  12 --
  13 -- The Original Code and all software distributed under the License is
  14 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  15 -- Initial Developer hereby disclaims all such warranties, including without
  16 -- limitation, any warranties of merchantability, fitness for a particular
  17 -- purpose or non-infringement. Please see the License for the specific terms
  18 -- and conditions governing the rights and limitations under the License.
  19
  20
  21
  22 class PntOnFace from IntTools
  23
  24         ---Purpose: Contains a Face, a 3d point, corresponded UV parameters and a flag
  25
  26 uses
  27     Face from TopoDS,
  28     Pnt  from  gp
  29 --raises
  30
  31 is
  32     Create
  33         returns PntOnFace from IntTools;
  34         ---Purpose:
  35         --- Empty constructor
  36         ---
  37
  38     Init(me:out;
  39          aF: Face from TopoDS;
  40          aP: Pnt  from  gp;
  41          U : Real from  Standard;
  42          V : Real from  Standard);
  43         ---Purpose:
  44         --- Initializes me by aFace, a 3d point
  45         --- and it's UV parameters on face
  46         ---
  47
  48     SetFace(me:out;
  49             aF:Face from TopoDS);
  50         ---Purpose:
  51         --- Modifier
  52         ---
  53
  54     SetPnt (me:out;
  55             aP:Pnt  from  gp);
  56         ---Purpose:
  57         --- Modifier
  58         ---
  59
  60     SetParameters (me:out;
  61                    U : Real from  Standard;
  62                    V : Real from  Standard);
  63         ---Purpose:
  64         --- Modifier
  65         ---
  66
  67     SetValid(me:out;
  68              bF : Boolean from Standard);
  69         ---Purpose:
  70         --- Modifier
  71         ---
  72
  73     Valid(me)
  74         returns Boolean from Standard;
  75         ---Purpose:
  76         --- Selector
  77         ---
  78
  79     Face(me)
  80         returns Face from TopoDS;
  81         ---C++:  return const &
  82         ---Purpose:
  83         --- Selector
  84         ---
  85
  86     Pnt (me)
  87         returns Pnt  from gp;
  88         ---C++:  return const &
  89         ---Purpose:
  90         --- Selector
  91         ---
  92
  93     Parameters (me;
  94                 U :out Real from Standard;
  95                 V :out Real from Standard);
  96         ---Purpose:
  97         --- Selector
  98         ---
  99
 100     IsValid(me)
 101         returns Boolean from Standard;
 102         ---Purpose:
 103         --- Selector
 104
 105 fields
 106
 107     myIsValid : Boolean from Standard;
 108     myPnt : Pnt  from  gp;
 109     myU   : Real from  Standard;
 110     myV   : Real from  Standard;
 111     myFace: Face from TopoDS;
 112 end PntOnFace;