src/BOPDS/BOPDS_Point.cdl

   1 -- Created by: Peter KURNEV
   2 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
   3 --
   4 -- This file is part of Open CASCADE Technology software library.
   5 --
   6 -- This library is free software; you can redistribute it and/or modify it under
   7 -- the terms of the GNU Lesser General Public License version 2.1 as published
   8 -- by the Free Software Foundation, with special exception defined in the file
   9 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  10 -- distribution for complete text of the license and disclaimer of any warranty.
  11 --
  12 -- Alternatively, this file may be used under the terms of Open CASCADE
  13 -- commercial license or contractual agreement.
  14
  15 class Point from BOPDS
  16
  17         ---Purpose:
  18         -- The class BOPDS_Point is to store
  19         -- the information about intersection point
  20 uses
  21     Pnt from gp,
  22     Pnt2d from gp
  23
  24 --raises
  25
  26 is
  27     Create
  28         returns Point from BOPDS;
  29     ---C++: alias "virtual ~BOPDS_Point();"
  30     ---C++: inline
  31         ---Purpose:
  32         --- Empty contructor
  33         ---
  34
  35     SetPnt(me:out;
  36             thePnt:Pnt from gp);
  37     ---C++: inline
  38         ---Purpose:
  39         --- Modifier
  40         --- Sets 3D point <thePnt>
  41
  42     Pnt(me)
  43         returns Pnt from gp;
  44     ---C++: return const &
  45     ---C++: inline
  46         ---Purpose:
  47         --- Selector
  48         --- Returns 3D point
  49
  50     SetPnt2D1(me:out;
  51             thePnt:Pnt2d from gp);
  52     ---C++: inline
  53         ---Purpose:
  54         --- Modifier
  55         --- Sets 2D point on the first face <thePnt>
  56
  57     Pnt2D1(me)
  58         returns Pnt2d from gp;
  59     ---C++: return const &
  60     ---C++: inline
  61         ---Purpose:
  62         --- Selector
  63         --- Returns 2D point on the first face <thePnt>
  64     SetPnt2D2(me:out;
  65             thePnt:Pnt2d from gp);
  66     ---C++: inline
  67         ---Purpose:
  68         --- Modifier
  69         --- Sets 2D point on the second face <thePnt>
  70
  71     Pnt2D2(me)
  72         returns Pnt2d from gp;
  73     ---C++: return const &
  74     ---C++: inline
  75         ---Purpose:
  76         --- Selector
  77         --- Returns 2D point on the second face <thePnt>
  78
  79     SetIndex(me:out;
  80             theIndex: Integer from Standard);
  81     ---C++: inline
  82         ---Purpose:
  83         --- Modifier
  84         --- Sets the index of the vertex <theIndex>
  85     Index(me)
  86         returns Integer from Standard;
  87     ---C++: inline
  88         ---Purpose:
  89         --- Selector
  90         --- Returns index of the vertex
  91
  92 fields
  93     myPnt :Pnt from gp is protected;
  94     myPnt2D1:Pnt2d from gp is protected;
  95     myPnt2D2:Pnt2d from gp is protected;
  96     myIndex : Integer from Standard is protected;
  97
  98 end Point;