include/opencascade/StdPrs_DeflectionCurve.hxx

0001 // Created on: 1992-12-15
0002 // Created by: Jean Louis FRENKEL
0003 // Copyright (c) 1992-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_DeflectionCurve_HeaderFile
0018 #define _StdPrs_DeflectionCurve_HeaderFile
0019
0020 #include <Prs3d_Root.hxx>
0021 #include <Prs3d_Drawer.hxx>
0022 #include <TColgp_SequenceOfPnt.hxx>
0023
0024 class Adaptor3d_Curve;
0025
0026 //! A framework to provide display of any curve with
0027 //! respect to the maximal chordal deviation defined in
0028 //! the Prs3d_Drawer attributes manager.
0029 class StdPrs_DeflectionCurve  : public Prs3d_Root
0030 {
0031 public:
0032
0033   DEFINE_STANDARD_ALLOC
0034
0035
0036   //! adds to the presentation aPresentation the drawing of the curve
0037   //! aCurve with respect to the maximal chordial deviation defined
0038   //! by the drawer aDrawer.
0039   //! The aspect is defined by LineAspect in aDrawer.
0040   //! If drawCurve equals Standard_False the curve will not be displayed,
0041   //! it is used if the curve is a part of some shape and PrimitiveArray
0042   //! visualization approach is activated (it is activated by default).
0043   Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& aPresentation, Adaptor3d_Curve& aCurve, const Handle(Prs3d_Drawer)& aDrawer, const Standard_Boolean drawCurve = Standard_True);
0044
0045   //! adds to the presentation aPresentation the drawing of the curve
0046   //! aCurve with respect to the maximal chordial deviation defined
0047   //! by the drawer aDrawer.
0048   //! The aspect is defined by LineAspect in aDrawer.
0049   //! The drawing will be limited between the points of parameter U1 and U2.
0050   //! If drawCurve equals Standard_False the curve will not be displayed,
0051   //! it is used if the curve is a part of some shape and PrimitiveArray
0052   //! visualization approach is activated (it is activated by default).
0053   Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& aPresentation, Adaptor3d_Curve& aCurve, const Standard_Real U1, const Standard_Real U2, const Handle(Prs3d_Drawer)& aDrawer, const Standard_Boolean drawCurve = Standard_True);
0054
0055   //! adds to the presentation aPresentation the drawing of the curve
0056   //! aCurve with respect to the maximal chordial deviation aDeflection.
0057   //! The aspect is the current aspect
0058   //! If drawCurve equals Standard_False the curve will not be displayed,
0059   //! it is used if the curve is a part of some shape and PrimitiveArray
0060   //! visualization approach is activated (it is activated by default).
0061   Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& aPresentation, Adaptor3d_Curve& aCurve, const Standard_Real aDeflection, const Standard_Real aLimit, const Standard_Real anAngle = 0.2, const Standard_Boolean drawCurve = Standard_True);
0062
0063   //! adds to the presentation aPresentation the drawing of the curve
0064   //! aCurve with respect to the maximal chordial deviation aDeflection.
0065   //! The aspect is the current aspect
0066   //! Points give a sequence of curve points.
0067   //! If drawCurve equals Standard_False the curve will not be displayed,
0068   //! it is used if the curve is a part of some shape and PrimitiveArray
0069   //! visualization approach is activated (it is activated by default).
0070   Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& aPresentation, Adaptor3d_Curve& aCurve, const Standard_Real aDeflection, const Handle(Prs3d_Drawer)& aDrawer, TColgp_SequenceOfPnt& Points, const Standard_Boolean drawCurve = Standard_True);
0071
0072   //! adds to the presentation aPresentation the drawing of the curve
0073   //! aCurve with respect to the maximal chordial deviation aDeflection.
0074   //! The aspect is the current aspect
0075   //! The drawing will be limited between the points of parameter U1 and U2.
0076   //! Points give a sequence of curve points.
0077   //! If drawCurve equals Standard_False the curve will not be displayed,
0078   //! it is used if the curve is a part of some shape and PrimitiveArray
0079   //! visualization approach is activated (it is activated by default).
0080   Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& aPresentation, Adaptor3d_Curve& aCurve, const Standard_Real U1, const Standard_Real U2, const Standard_Real aDeflection, TColgp_SequenceOfPnt& Points, const Standard_Real anAngle = 0.2, const Standard_Boolean drawCurve = Standard_True);
0081
0082   //! returns true if the distance between the point (X,Y,Z) and the
0083   //! drawing of the curve aCurve with respect of the maximal
0084   //! chordial deviation defined by the drawer aDrawer is less then aDistance.
0085   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);
0086
0087   //! returns true if the distance between the point (X,Y,Z) and the
0088   //! drawing of the curve aCurve with respect of the maximal
0089   //! chordial deviation defined by the drawer aDrawer is less
0090   //! then aDistance. The drawing is considered between the points
0091   //! of parameter U1 and U2;
0092   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 Standard_Real U1, const Standard_Real U2, const Handle(Prs3d_Drawer)& aDrawer);
0093
0094   //! Returns true if the distance between the point (theX, theY, theZ)
0095   //! and the drawing with respect of the maximal chordial deviation theDeflection is less then theDistance.
0096   Standard_EXPORT static Standard_Boolean Match (const Standard_Real theX, const Standard_Real theY, const Standard_Real theZ, const Standard_Real theDistance,
0097                                                  const Adaptor3d_Curve& theCurve,
0098                                                  const Standard_Real theDeflection, const Standard_Real theLimit, const Standard_Real theAngle);
0099
0100   //! Returns true if the distance between the point (theX, theY, theZ)
0101   //! and the drawing with respect of the maximal chordial deviation theDeflection is less then theDistance.
0102   //! The drawing is considered between the points of parameter theU1 and theU2.
0103   Standard_EXPORT static Standard_Boolean Match (const Standard_Real theX, const Standard_Real theY, const Standard_Real theZ, const Standard_Real theDistance,
0104                                                  const Adaptor3d_Curve& theCurve, const Standard_Real theU1, const Standard_Real theU2,
0105                                                  const Standard_Real theDeflection, const Standard_Real theAngle);
0106
0107 };
0108
0109 #endif // _StdPrs_DeflectionCurve_HeaderFile