0025129: Visualization - add interactive object for Points Cloud objects
[occt.git] / src / StdPrs / StdPrs_Plane.cdl
1 -- Created on: 1995-07-24
2 -- Created by: Modelistation
3 -- Copyright (c) 1995-1999 Matra Datavision
4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
5 --
6 -- This file is part of Open CASCADE Technology software library.
7 --
8 -- This library is free software; you can redistribute it and/or modify it under
9 -- the terms of the GNU Lesser General Public License version 2.1 as published
10 -- by the Free Software Foundation, with special exception defined in the file
11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 -- distribution for complete text of the license and disclaimer of any warranty.
13 --
14 -- Alternatively, this file may be used under the terms of Open CASCADE
15 -- commercial license or contractual agreement.
16
17 class Plane from StdPrs
18          
19 inherits Root from Prs3d
20
21         ---Purpose: A framework to display infinite planes.
22           
23 uses 
24     Surface           from Adaptor3d,
25     Presentation      from Prs3d,
26     Drawer            from Prs3d,
27     TypeOfLinePicking from Prs3d,
28     Length            from Quantity
29     
30 is
31     Add(myclass; aPresentation: Presentation from Prs3d; 
32                  aPlane       : Surface      from Adaptor3d;
33                  aDrawer      : Drawer       from Prs3d);
34                  
35         ---Purpose: Defines display of infinite planes.
36         -- The infinite plane aPlane is added to the display
37         -- aPresentation, and the attributes of the display are
38         -- defined by the attribute manager aDrawer.
39
40     Match(myclass; X,Y,Z   : Length  from Quantity;
41                   aDistance: Length  from Quantity;
42                   aPlane   : Surface from Adaptor3d;
43                   aDrawer  : Drawer  from Prs3d)
44     returns Boolean from Standard;
45
46         ---Purpose: returns true if the distance between the point (X,Y,Z) and the
47         --          plane is less than aDistance.
48
49
50 end Plane;