// Created on: 2005-12-21
// Created by: Sergey KHROMOV
// Copyright (c) 2005-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 _BRepGProp_UFunction_HeaderFile
#define _BRepGProp_UFunction_HeaderFile

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

#include <BRepGProp_Face.hxx>
#include <gp_Pnt.hxx>
#include <GProp_ValueType.hxx>
#include <Standard_Boolean.hxx>
#include <math_Function.hxx>
class gp_XYZ;

//! This class represents the integrand function for
//! computation of an inner integral. The returned value
//! depends on the value type and the flag IsByPoint.
//!
//! The type of returned value is the one of the following
//! values:
//! -  GProp_Mass - volume computation.
//! -  GProp_CenterMassX, GProp_CenterMassY,
//! GProp_CenterMassZ - X, Y and Z coordinates of center
//! of mass computation.
//! -  GProp_InertiaXX, GProp_InertiaYY, GProp_InertiaZZ,
//! GProp_InertiaXY, GProp_InertiaXZ, GProp_InertiaYZ
//! - moments of inertia computation.
//!
//! If the flag IsByPoint is set to Standard_True, the value is
//! returned for the region of space that is delimited by a
//! surface and a point. Otherwise all computations are
//! performed for the region of space delimited by a surface
//! and a plane.
class BRepGProp_UFunction : public math_Function
{
public:
  DEFINE_STANDARD_ALLOC

  //! Constructor. Initializes the function with the face, the
  //! location point, the flag IsByPoint and the coefficients
  //! theCoeff that have different meaning depending on the value
  //! of IsByPoint.
  //! If IsByPoint is equal to Standard_True, the number of the
  //! coefficients is equal to 3 and they represent X, Y and Z
  //! coordinates (theCoeff[0], theCoeff[1] and theCoeff[2]
  //! correspondingly) of the shift, if the inertia is computed
  //! with respect to the point different then the location.
  //! If IsByPoint is equal to Standard_False, the number of the
  //! coefficients is 4 and they represent the combination of
  //! plane parameters and shift values.
  Standard_EXPORT BRepGProp_UFunction(const BRepGProp_Face&  theSurface,
                                      const gp_Pnt&          theVertex,
                                      const Standard_Boolean IsByPoint,
                                      const Standard_Real*   theCoeffs);

  //! Setting the type of the value to be returned.
  void SetValueType(const GProp_ValueType theType);

  //! Setting the V parameter that is constant during the
  //! integral computation.
  void SetVParam(const Standard_Real theVParam);

  //! Returns a value of the function.
  Standard_EXPORT virtual Standard_Boolean Value(const Standard_Real X,
                                                 Standard_Real&      F) Standard_OVERRIDE;

private:
  //! Private method. Returns the value for volume computation.
  //! Other returned values are:
  //! -  thePMP0 - PSurf(X,Y) minus Location.
  //! -  theS and theD1 coefficients that are computed and used
  //! for computation of center of mass and inertia values
  //! by plane.
  Standard_EXPORT Standard_Real VolumeValue(const Standard_Real X,
                                            gp_XYZ&             thePMP0,
                                            Standard_Real&      theS,
                                            Standard_Real&      theD1);

  //! Private method. Returns a value for the center of mass
  //! computation. If the value type other then GProp_CenterMassX,
  //! GProp_CenterMassY or GProp_CenterMassZ this method returns
  //! Standard_False. Returns Standard_True in case of successful
  //! computation of a value.
  Standard_EXPORT Standard_Boolean CenterMassValue(const Standard_Real X, Standard_Real& F);

  //! Private method. Computes the value of inertia. The type of
  //! a value returned is defined by the value type. If it is
  //! other then GProp_InertiaXX, GProp_InertiaYY,
  //! GProp_InertiaZZ, GProp_InertiaXY, GProp_InertiaXZ or
  //! GProp_InertiaYZ, the method returns Standard_False. Returns
  //! Standard_True in case of successful computation of a value
  Standard_EXPORT Standard_Boolean InertiaValue(const Standard_Real X, Standard_Real& F);

  BRepGProp_Face       mySurface;
  gp_Pnt               myVertex;
  const Standard_Real* myCoeffs;
  Standard_Real        myVParam;
  GProp_ValueType      myValueType;
  Standard_Boolean     myIsByPoint;
};

#include <BRepGProp_UFunction.lxx>

#endif // _BRepGProp_UFunction_HeaderFile
