include/opencascade/IntSurf_PathPointTool.hxx

0001 // Created on: 1992-09-25
0002 // Created by: Jacques GOUSSARD
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 _IntSurf_PathPointTool_HeaderFile
0018 #define _IntSurf_PathPointTool_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022
0023 #include <gp_Pnt.hxx>
0024 #include <gp_Vec.hxx>
0025 #include <gp_Dir2d.hxx>
0026 #include <Standard_Integer.hxx>
0027 class Standard_OutOfRange;
0028 class StdFail_UndefinedDerivative;
0029 class IntSurf_PathPoint;
0030
0031
0032
0033 class IntSurf_PathPointTool
0034 {
0035 public:
0036
0037   DEFINE_STANDARD_ALLOC
0038
0039
0040   //! Returns the 3d coordinates of the starting point.
0041     static gp_Pnt Value3d (const IntSurf_PathPoint& PStart);
0042
0043   //! Returns the <U, V> parameters which are associated
0044   //! with <P>
0045   //! it's the parameters which start the marching algorithm
0046     static void Value2d (const IntSurf_PathPoint& PStart, Standard_Real& U, Standard_Real& V);
0047
0048   //! Returns True if the point is a point on a non-oriented
0049   //! arc, which means that the intersection line does not
0050   //! stop at such a point but just go through such a point.
0051   //! IsPassingPnt is True when IsOnArc is True
0052     static Standard_Boolean IsPassingPnt (const IntSurf_PathPoint& PStart);
0053
0054   //! Returns True if the surfaces are tangent at this point.
0055   //! IsTangent can be True when IsOnArc is True
0056   //! if IsPassingPnt is True and IsTangent is True,this point
0057   //! is a stopped point.
0058     static Standard_Boolean IsTangent (const IntSurf_PathPoint& PStart);
0059
0060   //! returns the tangent at the intersection in 3d space
0061   //! associated to <P>
0062   //! an exception is raised if IsTangent is true.
0063     static gp_Vec Direction3d (const IntSurf_PathPoint& PStart);
0064
0065   //! returns the tangent at the intersection in the
0066   //! parametric space of the parametrized surface.This tangent
0067   //! is associated to the value2d
0068   //! la tangente a un sens signifiant (indique le sens de chemin
0069   //! ement)
0070   //! an exception is raised if IsTangent is true.
0071     static gp_Dir2d Direction2d (const IntSurf_PathPoint& PStart);
0072
0073   //! Returns the multiplicity of the point i-e
0074   //! the number of auxillar parameters associated to the
0075   //! point which the principal parameters are given by Value2d
0076     static Standard_Integer Multiplicity (const IntSurf_PathPoint& PStart);
0077
0078   //! Parametric coordinates associated to the multiplicity.
0079   //! An exception is raised if Mult<=0 or Mult>multiplicity.
0080     static void Parameters (const IntSurf_PathPoint& PStart, const Standard_Integer Mult, Standard_Real& U, Standard_Real& V);
0081
0082
0083
0084
0085 protected:
0086
0087
0088
0089
0090
0091 private:
0092
0093
0094
0095
0096
0097 };
0098
0099
0100 #include <IntSurf_PathPointTool.lxx>
0101
0102
0103
0104
0105
0106 #endif // _IntSurf_PathPointTool_HeaderFile