// Copyright (C) 2014-2015  EDF-R&D
// 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
//

%ExportedHeaderCode
#include <HYDROData_Obstacle.h>
%End

class HYDROData_Obstacle : public HYDROData_ArtificialObject
{
%TypeHeaderCode
#include <HYDROData_Obstacle.h>
%End

public:
  /**
   * Returns default filling color for new obstacle.
   */
  virtual QColor DefaultFillingColor() const;

  /**
   * Returns default border color for new obstacle.
   */
  virtual QColor DefaultBorderColor() const;

public:

  /**
   * Imports shape from file containing geometrical object and sets this
   * shape as the obstacle shape.
   * The supported file types:
   *  - BREP
   *  - IGES
   *  - STEP
   *  - ACIS
   * \param theFilePath the path to file
   * \return \c true if file has been successfully read
   */
  bool ImportFromFile( const QString& theFilePath );


  /**
   * Stores the file path of the imported file.
   * \param theFilePath file path
   */
  void SetFilePath(const QString& theFilePath);

  /**
   * Returns the imported file path.
   */
  QString GetFilePath() const;


public:

  /**
   * Imports shape from IOR.
   * \param theIOR the IOR of Geom object
   * \return \c true if shape has been successfully imported
   */
  bool ImportFromGeomIOR( const TCollection_AsciiString& theIOR );

  /**
   * Stores the study entry of the imported GEOM object.
   * \param theEntry GEOM object entry
   */
  void SetGeomObjectEntry( const TCollection_AsciiString& theEntry );

  /**
   * Returns the imported GEOM object entry.
   */
  TCollection_AsciiString GetGeomObjectEntry() const;


public:

  /**
   * Translate the obstacle to the given distance.
   */
  void Translate( const double theDx, const double theDy, const double theDz );


protected:

  /**
   * Creates new object in the internal data structure. Use higher level objects 
   * to create objects with real content.
   */
  HYDROData_Obstacle();

  /**
   * Destructs properties of the object and object itself, removes it from the document.
   */
  virtual ~HYDROData_Obstacle();
};