// 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_Polyline3D.h"
%End

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

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

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


public:      
  // Public methods to work with 3D polyline
  
  /**
   * Sets reference x,y polyline object for 3D polyline.
   */
  bool SetPolylineXY( HYDROData_PolylineXY thePolyline,
                              const bool theIsUpdateProfile = true )
  [bool ( const opencascade::handle<HYDROData_PolylineXY>&,
          const bool = true )];
  %MethodCode
    Handle(HYDROData_PolylineXY) aRef =
      Handle(HYDROData_PolylineXY)::DownCast( createHandle( a0 ) );
    if ( !aRef.IsNull() )
    {
      Py_BEGIN_ALLOW_THREADS
      sipRes = sipSelfWasArg ? sipCpp->HYDROData_Polyline3D::SetPolylineXY( aRef, a1 ):
                               sipCpp->SetPolylineXY( aRef, a1 );
      Py_END_ALLOW_THREADS
    }
  %End

  /**
   * Returns reference x,y polyline object of 3D polyline.
   */
  HYDROData_PolylineXY GetPolylineXY() const
  [opencascade::handle<HYDROData_PolylineXY> ()];
  %MethodCode
    Handle(HYDROData_PolylineXY) aRef;
    
    Py_BEGIN_ALLOW_THREADS
    aRef = sipSelfWasArg ? sipCpp->HYDROData_Polyline3D::GetPolylineXY() : 
                           sipCpp->GetPolylineXY();
    Py_END_ALLOW_THREADS
    
    sipRes = (HYDROData_PolylineXY*)createPointer( aRef );
  %End

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


  /**
   * Sets reference u,z profile object for 3D polyline.
   */
  bool SetProfileUZ( HYDROData_ProfileUZ theProfile )
  [bool ( const opencascade::handle<HYDROData_ProfileUZ>& )];
  %MethodCode
    Handle(HYDROData_ProfileUZ) aRef =
      Handle(HYDROData_ProfileUZ)::DownCast( createHandle( a0 ) );
    if ( !aRef.IsNull() )
    {
      Py_BEGIN_ALLOW_THREADS
      sipRes = sipSelfWasArg ? sipCpp->HYDROData_Polyline3D::SetProfileUZ( aRef ):
                               sipCpp->SetProfileUZ( aRef );
      Py_END_ALLOW_THREADS
    }
  %End

  /**
   * Returns reference u,z profile object of 3D polyline.
   */
  HYDROData_ProfileUZ GetProfileUZ() const
  [Hopencascade::handle<HYDROData_ProfileUZ> ()];
  %MethodCode
    Handle(HYDROData_ProfileUZ) aRef;
    
    Py_BEGIN_ALLOW_THREADS
    aRef = sipSelfWasArg ? sipCpp->HYDROData_Polyline3D::GetProfileUZ() : 
                           sipCpp->GetProfileUZ();
    Py_END_ALLOW_THREADS
    
    sipRes = (HYDROData_ProfileUZ*)createPointer( aRef );
  %End

  /**
   * 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.
   */
  bool SetAltitudeObject( HYDROData_IAltitudeObject theAltitude )
  [bool ( const opencascade::handle<HYDROData_IAltitudeObject>& )];
  %MethodCode
    Handle(HYDROData_IAltitudeObject) aRef =
      Handle(HYDROData_IAltitudeObject)::DownCast( createHandle( a0 ) );
    if ( !aRef.IsNull() )
    {
      Py_BEGIN_ALLOW_THREADS
      sipRes = sipSelfWasArg ? sipCpp->HYDROData_Polyline3D::SetAltitudeObject( aRef ):
                               sipCpp->SetAltitudeObject( aRef );
      Py_END_ALLOW_THREADS
    }
  %End

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


  /**
   * Returns the child u,z profile which has been generated from bathymetry.
   */
  HYDROData_ProfileUZ GetChildProfileUZ( const bool theIsCreate = true ) const
  [opencascade::handle<HYDROData_ProfileUZ> ( const bool = true )];
  %MethodCode
    Handle(HYDROData_ProfileUZ) aRef;
    
    Py_BEGIN_ALLOW_THREADS
    aRef = sipSelfWasArg ? sipCpp->HYDROData_Polyline3D::GetChildProfileUZ( a0 ) : 
                           sipCpp->GetChildProfileUZ( a0 );
    Py_END_ALLOW_THREADS
    
    sipRes = (HYDROData_ProfileUZ*)createPointer( aRef );
  %End


  /**
   * Sets the child u,z profile for polyline.
   */
  void SetChildProfileUZ( HYDROData_ProfileUZ theProfile ) [void ( const opencascade::handle<HYDROData_ProfileUZ>& )];
  %MethodCode
    Handle(HYDROData_ProfileUZ) aRef =
      Handle(HYDROData_ProfileUZ)::DownCast( createHandle( a0 ) );
    if ( !aRef.IsNull() )
    {
      Py_BEGIN_ALLOW_THREADS
      sipSelfWasArg ? sipCpp->HYDROData_Polyline3D::SetChildProfileUZ( aRef ):
                      sipCpp->SetChildProfileUZ( aRef );
      Py_END_ALLOW_THREADS
    }
  %End

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();
};