include/opencascade/StdPrs_Plane.hxx

0001 // Created on: 1995-07-24
0002 // Created by: Modelistation
0003 // Copyright (c) 1995-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _StdPrs_Plane_HeaderFile
0018 #define _StdPrs_Plane_HeaderFile
0019
0020 #include <Prs3d_Root.hxx>
0021 #include <Prs3d_Drawer.hxx>
0022
0023 class Adaptor3d_Surface;
0024
0025 //! A framework to display infinite planes.
0026 class StdPrs_Plane : public Prs3d_Root
0027 {
0028 public:
0029   DEFINE_STANDARD_ALLOC
0030
0031   //! Defines display of infinite planes.
0032   //! The infinite plane aPlane is added to the display
0033   //! aPresentation, and the attributes of the display are
0034   //! defined by the attribute manager aDrawer.
0035   Standard_EXPORT static void Add(const Handle(Prs3d_Presentation)& aPresentation,
0036                                   const Adaptor3d_Surface&          aPlane,
0037                                   const Handle(Prs3d_Drawer)&       aDrawer);
0038
0039   //! returns true if the distance between the point (X,Y,Z) and the
0040   //! plane is less than aDistance.
0041   Standard_EXPORT static Standard_Boolean Match(const Standard_Real         X,
0042                                                 const Standard_Real         Y,
0043                                                 const Standard_Real         Z,
0044                                                 const Standard_Real         aDistance,
0045                                                 const Adaptor3d_Surface&    aPlane,
0046                                                 const Handle(Prs3d_Drawer)& aDrawer);
0047 };
0048
0049 #endif // _StdPrs_Plane_HeaderFile