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 class IntSurf_PathPointTool
0032 {
0033 public:
0034   DEFINE_STANDARD_ALLOC
0035
0036   //! Returns the 3d coordinates of the starting point.
0037   static gp_Pnt Value3d(const IntSurf_PathPoint& PStart);
0038
0039   //! Returns the <U, V> parameters which are associated
0040   //! with <P>
0041   //! it's the parameters which start the marching algorithm
0042   static void Value2d(const IntSurf_PathPoint& PStart, double& U, double& V);
0043
0044   //! Returns True if the point is a point on a non-oriented
0045   //! arc, which means that the intersection line does not
0046   //! stop at such a point but just go through such a point.
0047   //! IsPassingPnt is True when IsOnArc is True
0048   static bool IsPassingPnt(const IntSurf_PathPoint& PStart);
0049
0050   //! Returns True if the surfaces are tangent at this point.
0051   //! IsTangent can be True when IsOnArc is True
0052   //! if IsPassingPnt is True and IsTangent is True,this point
0053   //! is a stopped point.
0054   static bool IsTangent(const IntSurf_PathPoint& PStart);
0055
0056   //! returns the tangent at the intersection in 3d space
0057   //! associated to <P>
0058   //! an exception is raised if IsTangent is true.
0059   static gp_Vec Direction3d(const IntSurf_PathPoint& PStart);
0060
0061   //! returns the tangent at the intersection in the
0062   //! parametric space of the parametrized surface.This tangent
0063   //! is associated to the value2d
0064   //! la tangente a un sens signifiant (indique le sens de chemin
0065   //! ement)
0066   //! an exception is raised if IsTangent is true.
0067   static gp_Dir2d Direction2d(const IntSurf_PathPoint& PStart);
0068
0069   //! Returns the multiplicity of the point i-e
0070   //! the number of auxillar parameters associated to the
0071   //! point which the principal parameters are given by Value2d
0072   static int Multiplicity(const IntSurf_PathPoint& PStart);
0073
0074   //! Parametric coordinates associated to the multiplicity.
0075   //! An exception is raised if Mult<=0 or Mult>multiplicity.
0076   static void Parameters(const IntSurf_PathPoint& PStart, const int Mult, double& U, double& V);
0077 };
0078
0079 #include <IntSurf_PathPointTool.lxx>
0080
0081 #endif // _IntSurf_PathPointTool_HeaderFile