// Copyright (C) 2014-2016  OPEN CASCADE
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//

#ifndef __CANRECPlugin_IDL__
#define __CANRECPlugin_IDL__

#include "GEOM_Gen.idl"

module CANRECPlugin
{       
  typedef sequence<long> ListOfLong;

  /*!
   *  \brief Interface to Canonical Recognition modeling functions.
   */
  interface ICanRecOperations : GEOM::GEOM_IOperations
  {
    /*!
     * \brief Perform, if possible, conversion of NURBS (B-Spline, Bezier) geometry to canonical (analytical) form. 
     *
     * \param theObject the input object (solid, compound, compsolid).
     * \param theMergeSurf the flag to switch on/off merging surfaces in the result shape.
     * \param theMergeCurves the flag to switch on/off merging curves in the result shape.
     * \param theTolerance the tolerance of the canonical recognition operation.
     * \param theStat the statistics of the operation. Output parameter.
     *                Each integer value in the sequence has its own meaning
     *                depending on its index:
     *                0 - total number of faces in the initial shape;
     *                1 - number of canonical faces in the initial shape;
     *                2 - number of faces converted to the canonical form;
     *                3 - number of merged surfaces;
     *                4 - number of merged curves.
     *                Nagative value means that this value is not computed.
     *
     * \return New GEOM_Object, containing the canonical recognition of the input object.
     */
    GEOM::GEOM_Object MakeCanonicalRecognition
                      (in GEOM::GEOM_Object theObject,
                       in boolean           theMergeSurf,
                       in boolean           theMergeCurves,
                       in double            theTolerance,
                       out ListOfLong       theStat);

    /*!
     * \brief Get the number of canonical faces in the shape.
     *
     * \param theObject the input object (solid, compound, compsolid).
     *
     * \return the number of canonical faces in the object.
     */
    long GetNbCanonicalFaces(in GEOM::GEOM_Object theObject);
  };
};

#endif  // __CANRECPlugin_IDL__