include/opencascade/StdPrs_PoleCurve.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_PoleCurve_HeaderFile
0018 #define _StdPrs_PoleCurve_HeaderFile
0019
0020 #include <Prs3d_Root.hxx>
0021 #include <Prs3d_Drawer.hxx>
0022
0023 class Adaptor3d_Curve;
0024
0025 //! A framework to provide display of Bezier or BSpline curves
0026 //! (by drawing a broken line linking the poles of the curve).
0027 class StdPrs_PoleCurve  : public Prs3d_Root
0028 {
0029 public:
0030
0031   DEFINE_STANDARD_ALLOC
0032
0033
0034   //! Defines display of BSpline and Bezier curves.
0035   //! Adds the 3D curve aCurve to the
0036   //! StdPrs_PoleCurve algorithm. This shape is found in
0037   //! the presentation object aPresentation, and its display
0038   //! attributes are set in the attribute manager aDrawer.
0039   //! The curve object from Adaptor3d provides data from
0040   //! a Geom curve. This makes it possible to use the
0041   //! surface in a geometric algorithm.
0042   Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& aPresentation, const Adaptor3d_Curve& aCurve, const Handle(Prs3d_Drawer)& aDrawer);
0043
0044   //! returns true if the distance between the point (X,Y,Z) and the
0045   //! broken line made of the poles is less then aDistance.
0046   Standard_EXPORT static Standard_Boolean Match (const Standard_Real X, const Standard_Real Y, const Standard_Real Z, const Standard_Real aDistance, const Adaptor3d_Curve& aCurve, const Handle(Prs3d_Drawer)& aDrawer);
0047
0048   //! returns the pole  the most near of the point (X,Y,Z) and
0049   //! returns its range. The distance between the pole and
0050   //! (X,Y,Z) must be less then aDistance. If no pole corresponds, 0 is returned.
0051   Standard_EXPORT static Standard_Integer Pick (const Standard_Real X, const Standard_Real Y, const Standard_Real Z, const Standard_Real aDistance, const Adaptor3d_Curve& aCurve, const Handle(Prs3d_Drawer)& aDrawer);
0052
0053 };
0054
0055 #endif // _StdPrs_PoleCurve_HeaderFile