src/GeomFill/GeomFill_LocationLaw.hxx

   1 // Created on: 1997-11-20
   2 // Created by: Philippe MANGIN
   3 // Copyright (c) 1997-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _GeomFill_LocationLaw_HeaderFile
  18 #define _GeomFill_LocationLaw_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Standard_Transient.hxx>
  24 #include <Standard_Boolean.hxx>
  25 #include <Standard_Real.hxx>
  26 #include <TColgp_Array1OfPnt2d.hxx>
  27 #include <TColgp_Array1OfVec2d.hxx>
  28 #include <Standard_Integer.hxx>
  29 #include <GeomFill_PipeError.hxx>
  30 #include <GeomAbs_Shape.hxx>
  31 #include <TColStd_Array1OfReal.hxx>
  32 class Standard_NotImplemented;
  33 class Standard_OutOfRange;
  34 class Adaptor3d_HCurve;
  35 class gp_Mat;
  36 class gp_Vec;
  37 class gp_Pnt;
  38
  39
  40 class GeomFill_LocationLaw;
  41 DEFINE_STANDARD_HANDLE(GeomFill_LocationLaw, Standard_Transient)
  42
  43 //! To define location  law in Sweeping location is --
  44 //! defined   by an  Matrix  M and  an Vector  V,  and
  45 //! transform an point P in MP+V.
  46 class GeomFill_LocationLaw : public Standard_Transient
  47 {
  48
  49 public:
  50
  51
  52   Standard_EXPORT virtual void SetCurve (const Handle(Adaptor3d_HCurve)& C) = 0;
  53
  54   Standard_EXPORT virtual const Handle(Adaptor3d_HCurve)& GetCurve() const = 0;
  55
  56   //! Set a transformation Matrix like   the law M(t) become
  57   //! Mat * M(t)
  58   Standard_EXPORT virtual void SetTrsf (const gp_Mat& Transfo) = 0;
  59
  60   Standard_EXPORT virtual Handle(GeomFill_LocationLaw) Copy() const = 0;
  61
  62   //! compute Location
  63   Standard_EXPORT virtual Standard_Boolean D0 (const Standard_Real Param, gp_Mat& M, gp_Vec& V) = 0;
  64
  65   //! compute Location and 2d points
  66   Standard_EXPORT virtual Standard_Boolean D0 (const Standard_Real Param, gp_Mat& M, gp_Vec& V, TColgp_Array1OfPnt2d& Poles2d) = 0;
  67
  68   //! compute location 2d  points and  associated
  69   //! first derivatives.
  70   //! Warning : It used only for C1 or C2 aproximation
  71   Standard_EXPORT virtual Standard_Boolean D1 (const Standard_Real Param, gp_Mat& M, gp_Vec& V, gp_Mat& DM, gp_Vec& DV, TColgp_Array1OfPnt2d& Poles2d, TColgp_Array1OfVec2d& DPoles2d);
  72
  73   //! compute location 2d  points and associated
  74   //! first and seconde  derivatives.
  75   //! Warning : It used only for C2 aproximation
  76   Standard_EXPORT virtual Standard_Boolean D2 (const Standard_Real Param, gp_Mat& M, gp_Vec& V, gp_Mat& DM, gp_Vec& DV, gp_Mat& D2M, gp_Vec& D2V, TColgp_Array1OfPnt2d& Poles2d, TColgp_Array1OfVec2d& DPoles2d, TColgp_Array1OfVec2d& D2Poles2d);
  77
  78   //! get the number of  2d  curves (Restrictions  +  Traces)
  79   //! to approximate.
  80   Standard_EXPORT Standard_Integer Nb2dCurves() const;
  81
  82   //! Say if the first restriction is defined in this class.
  83   //! If it  is true the  first element  of poles array   in
  84   //! D0,D1,D2... Correspond to this restriction.
  85   //! Returns Standard_False (default implementation)
  86   Standard_EXPORT virtual Standard_Boolean HasFirstRestriction() const;
  87
  88   //! Say if the last restriction is defined in this class.
  89   //! If it is  true the  last element  of poles array in
  90   //! D0,D1,D2... Correspond to this restriction.
  91   //! Returns Standard_False (default implementation)
  92   Standard_EXPORT virtual Standard_Boolean HasLastRestriction() const;
  93
  94   //! Give the number of trace (Curves 2d wich are not restriction)
  95   //! Returns 0 (default implementation)
  96   Standard_EXPORT virtual Standard_Integer TraceNumber() const;
  97
  98   //! Give a status to the Law
  99   //! Returns PipeOk (default implementation)
 100   Standard_EXPORT virtual GeomFill_PipeError ErrorStatus() const;
 101
 102   //! Returns  the number  of  intervals for  continuity
 103   //! <S>.
 104   //! May be one if Continuity(me) >= <S>
 105   Standard_EXPORT virtual Standard_Integer NbIntervals (const GeomAbs_Shape S) const = 0;
 106
 107   //! Stores in <T> the  parameters bounding the intervals
 108   //! of continuity <S>.
 109   //!
 110   //! The array must provide  enough room to  accomodate
 111   //! for the parameters. i.e. T.Length() > NbIntervals()
 112   Standard_EXPORT virtual void Intervals (TColStd_Array1OfReal& T, const GeomAbs_Shape S) const = 0;
 113
 114   //! Sets the bounds of the parametric interval on
 115   //! the function
 116   //! This determines the derivatives in these values if the
 117   //! function is not Cn.
 118   Standard_EXPORT virtual void SetInterval (const Standard_Real First, const Standard_Real Last) = 0;
 119
 120   //! Gets the bounds of the parametric interval on
 121   //! the function
 122   Standard_EXPORT virtual void GetInterval (Standard_Real& First, Standard_Real& Last) const = 0;
 123
 124   //! Gets the bounds of the function parametric domain.
 125   //! Warning: This domain it is  not modified by the
 126   //! SetValue method
 127   Standard_EXPORT virtual void GetDomain (Standard_Real& First, Standard_Real& Last) const = 0;
 128
 129   //! Returns the resolutions in the  sub-space 2d <Index>
 130   //! This information is usfull to find an good tolerance in
 131   //! 2d approximation.
 132   Standard_EXPORT virtual void Resolution (const Standard_Integer Index, const Standard_Real Tol, Standard_Real& TolU, Standard_Real& TolV) const;
 133
 134   //! Is usefull, if (me) have to run numerical
 135   //! algorithm to perform D0, D1 or D2
 136   //! The default implementation make nothing.
 137   Standard_EXPORT virtual void SetTolerance (const Standard_Real Tol3d, const Standard_Real Tol2d);
 138
 139   //! Get the maximum Norm  of the matrix-location part.  It
 140   //! is usful to find an good Tolerance to approx M(t).
 141   Standard_EXPORT virtual Standard_Real GetMaximalNorm() = 0;
 142
 143   //! Get average value of M(t) and V(t) it is usfull to
 144   //! make fast approximation of rational surfaces.
 145   Standard_EXPORT virtual void GetAverageLaw (gp_Mat& AM, gp_Vec& AV) = 0;
 146
 147   //! Say if the Location  Law, is an translation of  Location
 148   //! The default implementation is " returns False ".
 149   Standard_EXPORT virtual Standard_Boolean IsTranslation (Standard_Real& Error) const;
 150
 151   //! Say if the Location  Law, is a rotation of Location
 152   //! The default implementation is " returns False ".
 153   Standard_EXPORT virtual Standard_Boolean IsRotation (Standard_Real& Error) const;
 154
 155   Standard_EXPORT virtual void Rotation (gp_Pnt& Center) const;
 156
 157
 158
 159
 160   DEFINE_STANDARD_RTTIEXT(GeomFill_LocationLaw,Standard_Transient)
 161
 162 protected:
 163
 164
 165
 166
 167 private:
 168
 169
 170
 171
 172 };
 173
 174
 175
 176
 177
 178
 179
 180 #endif // _GeomFill_LocationLaw_HeaderFile