// Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
//
// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
//
// 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.
//
// 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_Polyline3D.h"
%End

class HYDROData_Polyline3D : public HYDROData_Object
{
%TypeHeaderCode
#include "HYDROData_Polyline3D.h"
%End

public:
  /**
   * Returns default filling color for new 3D polyline.
   */
  static QColor DefaultFillingColor();

  /**
   * Returns default border color for new 3D polyline.
   */
  static QColor DefaultBorderColor();


public:      
  // Public methods to work with 3D polyline
  
  /**
   * Sets reference x,y polyline object for 3D polyline.
   */
  virtual bool SetPolylineXY( const Handle(HYDROData_PolylineXY)& thePolyline,
                              const bool theIsUpdateProfile = true );

  /**
   * Returns reference x,y polyline object of 3D polyline.
   */
  virtual Handle(HYDROData_PolylineXY) GetPolylineXY() const;

  /**
   * Remove reference x,y polyline object from 3D polyline.
   */
  virtual void RemovePolylineXY();


  /**
   * Sets reference u,z profile object for 3D polyline.
   */
  virtual bool SetProfileUZ( const Handle(HYDROData_ProfileUZ)& theProfile );

  /**
   * Returns reference u,z profile object of 3D polyline.
   */
  virtual Handle(HYDROData_ProfileUZ) GetProfileUZ() const;

  /**
   * Remove reference u,z profile object from 3D polyline.
   */
  virtual void RemoveProfileUZ();


  /**
   * Set reference bathymetry object for geometry object.
   * Reimplemented to remove reference u,z profile.
   */
  virtual bool SetAltitudeObject( const Handle(HYDROData_IAltitudeObject)& theAltitude );

  /**
   * Clear the reference bathymetry object for geometry object.
   * Reimplemented to remove child u,z profile.
   */
  virtual void RemoveAltitudeObject();


  /**
   * Returns the child u,z profile which has been generated from bathymetry.
   */
  Handle(HYDROData_ProfileUZ) GetChildProfileUZ( const bool theIsCreate = true ) const;


protected:

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

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