src/Extrema/Extrema_POnSurfParams.cdl

   1 -- Created on: 2012-12-06
   2 -- Created by: Sergey KHROMOV
   3 -- Copyright (c) 2004-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
   8 -- under the terms of the GNU Lesser General Public 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 POnSurfParams from Extrema inherits POnSurf from Extrema
  17     ---Purpose: Data container for point on surface parameters. These parameters
  18     --          are required to compute an initial approximation for extrema
  19     --          computation.
  20
  21 uses
  22
  23     POnSurf     from Extrema,
  24     ElementType from Extrema,
  25     Pnt         from gp
  26
  27 is
  28     Create returns POnSurfParams;
  29             ---Purpose: empty constructor
  30         ---C++: inline
  31
  32     Create (theU, theV: Real from Standard; thePnt: Pnt from gp)
  33         ---Purpose: Creation of a point on surface with parameter
  34         --          values on the surface and a Pnt from gp.
  35         ---C++: inline
  36     returns POnSurfParams;
  37
  38     SetSqrDistance(me: in out; theSqrDistance: Real from Standard);
  39             ---Purpose: Sets the square distance from this point to another one
  40             --          (e.g. to the point to be projected).
  41         ---C++: inline
  42
  43     GetSqrDistance(me)
  44             ---Purpose: Query the square distance from this point to another one.
  45         ---C++: inline
  46     returns Real from Standard;
  47
  48     SetElementType(me: in out; theElementType: ElementType from Extrema);
  49             ---Purpose: Sets the element type on which this point is situated.
  50         ---C++: inline
  51
  52     GetElementType(me)
  53             ---Purpose: Query the element type on which this point is situated.
  54         ---C++: inline
  55     returns ElementType from Extrema;
  56
  57     SetIndices(me: in out; theIndexU: Integer from Standard;
  58                            theIndexV: Integer from Standard);
  59             ---Purpose: Sets the U and V indices of an element that contains
  60             --          this point.
  61         ---C++: inline
  62
  63     GetIndices(me; theIndexU: out Integer from Standard;
  64                    theIndexV: out Integer from Standard);
  65             ---Purpose: Query the U and V indices of an element that contains
  66             --          this point.
  67         ---C++: inline
  68
  69 fields
  70
  71     mySqrDistance : Real        from Standard;
  72     myElementType : ElementType from Extrema;
  73     myIndexU      : Integer     from Standard;
  74     myIndexV      : Integer     from Standard;
  75
  76 end POnSurfParams;