OCCT

// Created on: 1995-10-18
// Created by: Andre LIEUTIER
// Copyright (c) 1995-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _Plate_Plate_HeaderFile
#define _Plate_Plate_HeaderFile

#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Handle.hxx>

#include <Standard_Integer.hxx>
#include <Plate_PinpointConstraint.hxx>
#include <NCollection_Sequence.hxx>
#include <Plate_LinearXYZConstraint.hxx>
#include <Plate_LinearScalarConstraint.hxx>
#include <gp_XYZ.hxx>
#include <NCollection_Array2.hxx>
#include <NCollection_HArray2.hxx>
#include <gp_XY.hxx>
#include <Message_ProgressScope.hxx>

class Plate_PinpointConstraint;
class Plate_LinearXYZConstraint;
class Plate_LinearScalarConstraint;
class Plate_GlobalTranslationConstraint;
class Plate_LineConstraint;
class Plate_PlaneConstraint;
class Plate_SampledCurveConstraint;
class Plate_GtoCConstraint;
class Plate_FreeGtoCConstraint;
class gp_XYZ;
class gp_XY;
class math_Matrix;

//! This class implement a variational spline algorithm able
//! to define a two variable function satisfying some constraints
//! and minimizing an energy like criterion.
class Plate_Plate
{
public:
  DEFINE_STANDARD_ALLOC

  Standard_EXPORT Plate_Plate();

  Standard_EXPORT Plate_Plate(const Plate_Plate& Ref);

  Standard_EXPORT Plate_Plate& Copy(const Plate_Plate& Ref);

  Plate_Plate& operator=(const Plate_Plate& Ref) { return Copy(Ref); }

  Standard_EXPORT void Load(const Plate_PinpointConstraint& PConst);

  Standard_EXPORT void Load(const Plate_LinearXYZConstraint& LXYZConst);

  Standard_EXPORT void Load(const Plate_LinearScalarConstraint& LScalarConst);

  Standard_EXPORT void Load(const Plate_GlobalTranslationConstraint& GTConst);

  Standard_EXPORT void Load(const Plate_LineConstraint& LConst);

  Standard_EXPORT void Load(const Plate_PlaneConstraint& PConst);

  Standard_EXPORT void Load(const Plate_SampledCurveConstraint& SCConst);

  Standard_EXPORT void Load(const Plate_GtoCConstraint& GtoCConst);

  Standard_EXPORT void Load(const Plate_FreeGtoCConstraint& FGtoCConst);

  Standard_EXPORT void SolveTI(const int                    ord         = 4,
                               const double                 anisotropie = 1.0,
                               const Message_ProgressRange& theProgress = Message_ProgressRange());

  //! returns True if all has been correctly done.
  Standard_EXPORT bool IsDone() const;

  Standard_EXPORT void destroy();

  ~Plate_Plate() { destroy(); }

  //! reset the Plate in the initial state
  //! ( same as after Create())
  Standard_EXPORT void Init();

  Standard_EXPORT gp_XYZ Evaluate(const gp_XY& point2d) const;

  Standard_EXPORT gp_XYZ EvaluateDerivative(const gp_XY& point2d, const int iu, const int iv) const;

  //! Returns the coefficients of the polynomial part of the Plate function.
  //! @return 2D array of polynomial coefficients as XYZ values
  [[nodiscard]] Standard_EXPORT occ::handle<NCollection_HArray2<gp_XYZ>> CoefPol() const;

  //! @deprecated Use CoefPol() returning handle by value instead.
  Standard_DEPRECATED("Use CoefPol() returning handle by value instead")
  Standard_EXPORT void CoefPol(occ::handle<NCollection_HArray2<gp_XYZ>>& Coefs) const;

  Standard_EXPORT void SetPolynomialPartOnly(const bool PPOnly = true);

  Standard_EXPORT int Continuity() const;

  Standard_EXPORT void UVBox(double& UMin, double& UMax, double& VMin, double& VMax) const;

  Standard_EXPORT void UVConstraints(NCollection_Sequence<gp_XY>& Seq) const;

private:
  Standard_EXPORT double SolEm(const gp_XY& point2d, const int iu, const int iv) const;

  double Polm(const gp_XY& point2d, const int iu, const int iv, const int idu, const int idv) const;

  int& Deru(const int index) const;

  int& Derv(const int index) const;

  gp_XYZ& Solution(const int index) const;

  gp_XY& Points(const int index) const;

  Standard_EXPORT void SolveTI1(const int                    IterationNumber,
                                const Message_ProgressRange& theProgress = Message_ProgressRange());

  Standard_EXPORT void SolveTI2(const int                    IterationNumber,
                                const Message_ProgressRange& theProgress = Message_ProgressRange());

  Standard_EXPORT void SolveTI3(const int                    IterationNumber,
                                const Message_ProgressRange& theProgress = Message_ProgressRange());

  Standard_EXPORT void fillXYZmatrix(math_Matrix& mat,
                                     const int    i0,
                                     const int    j0,
                                     const int    ncc1,
                                     const int    ncc2) const;

  int                                                order;
  int                                                n_el;
  int                                                n_dim;
  void*                                              solution;
  void*                                              points;
  void*                                              deru;
  void*                                              derv;
  bool                                               OK;
  NCollection_Sequence<Plate_PinpointConstraint>     myConstraints;
  NCollection_Sequence<Plate_LinearXYZConstraint>    myLXYZConstraints;
  NCollection_Sequence<Plate_LinearScalarConstraint> myLScalarConstraints;
  double                                             ddu[10];
  double                                             ddv[10];
  int                                                maxConstraintOrder;
  bool                                               PolynomialPartOnly;
  double                                             Uold;
  double                                             Vold;
  double                                             U2;
  double                                             R;
  double                                             L;
};

#include <Plate_Plate.lxx>

#endif // _Plate_Plate_HeaderFile