src/Select2D/Select2D_SensitivePoint.cdl

   1 -- Created on: 1995-01-26
   2 -- Created by: Mister rmi
   3 -- Copyright (c) 1995-1999 Matra Datavision
   4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
   5 --
   6 -- The content of this file is subject to the Open CASCADE Technology Public
   7 -- License Version 6.5 (the "License"). You may not use the content of this file
   8 -- except in compliance with the License. Please obtain a copy of the License
   9 -- at http://www.opencascade.org and read it completely before using this file.
  10 --
  11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  13 --
  14 -- The Original Code and all software distributed under the License is
  15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  16 -- Initial Developer hereby disclaims all such warranties, including without
  17 -- limitation, any warranties of merchantability, fitness for a particular
  18 -- purpose or non-infringement. Please see the License for the specific terms
  19 -- and conditions governing the rights and limitations under the License.
  20
  21
  22
  23
  24 class SensitivePoint from Select2D inherits SensitiveEntity from Select2D
  25
  26         ---Purpose: A framework to define sensitive 2D points.
  27
  28 uses
  29     Integer from Standard,
  30     Pnt2d from gp,
  31     EntityOwner from SelectBasics,
  32     ListOfBox2d from SelectBasics
  33
  34 is
  35
  36
  37     Create (OwnerId         : EntityOwner from SelectBasics;
  38             Location        : Pnt2d from gp;
  39             InitSensitivity : Real = 0)
  40     returns mutable SensitivePoint from Select2D;
  41         ---Purpose: Constructs the sensitive point object defined by the
  42         -- owner OwnerId, the point Location and the sensitivity InitSensitivity.
  43         -- InitSensitivity allows choice of dimensions in the
  44         -- selectable box around the sensitive point. It is
  45         -- initialized with a null value, and is given a working one by Set.
  46
  47
  48     Set(me:mutable; aSensitivity:Real) is static;
  49         ---Purpose: Sets the sensitivity aSensitivity for sensitive
  50         -- primitives to find owners of points.
  51
  52     Areas  (me:mutable ; aresul : in out ListOfBox2d from SelectBasics) is static;
  53         ---Level: Public
  54         ---Purpose: Returns the 2Dbox around the point (this box) has to be enlarged (sensitivity = 0)
  55
  56
  57     Location(me) returns Pnt2d from gp;
  58         ---Level: Public
  59         ---C++: inline
  60         ---C++: return const&
  61         ---Purpose: returns the original point.
  62
  63
  64
  65     Matches (me     : mutable ;
  66              X,Y    : Real from Standard;
  67              aTol   : Real from Standard;
  68              DMin   : out Real from Standard)
  69     returns Boolean
  70     is static;
  71         ---Purpose: if distance between P
  72
  73     Matches (me  :mutable;
  74              XMin,YMin,XMax,YMax : Real from Standard;
  75              aTol: Real from Standard)
  76     returns Boolean
  77     is static;
  78
  79
  80 fields
  81
  82     mylocation    : Pnt2d from gp;
  83     mysensitivity : Real;
  84
  85 end SensitivePoint;
  86