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

class HYDROData_Object : public HYDROData_Entity /Abstract/
{
%TypeHeaderCode
#include <HYDROData_Object.h>
%End

%ConvertToSubClassCode
   // HYDROData_Object sub-classes provide a unique kind ID.
  switch ( sipCpp->GetKind() )
  {
    case KIND_OBSTACLE:
      sipClass = sipClass_HYDROData_Obstacle;
      break;

    case KIND_CONFLUENCE:
      sipClass = sipClass_HYDROData_Confluence;
      break;
      
    case KIND_IMMERSIBLE_ZONE:
      sipClass = sipClass_HYDROData_ImmersibleZone;
      break;

    case KIND_DIGUE:
      sipClass = sipClass_HYDROData_Digue;
      break;

    case KIND_CHANNEL:
      sipClass = sipClass_HYDROData_Channel;
      break;
      
    case KIND_POLYLINE:
      sipClass = sipClass_HYDROData_Polyline3D;
      break;

    case KIND_PROFILE:
      sipClass = sipClass_HYDROData_Profile;
      break;

    case KIND_STREAM:
      sipClass = sipClass_HYDROData_Stream;
      break;

    case KIND_UNKNOWN:
      sipClass = sipClass_HYDROData_Entity;
      break;

    default:
      // We don't recognise the type.
      sipClass = NULL;
  }
%End

public:

  /**
   * Set reference altitude object for geometry object.
   */
  bool SetAltitudeObject( HYDROData_IAltitudeObject theAltitude ) [void (const Handle_HYDROData_IAltitudeObject&)];
  %MethodCode

    Handle(HYDROData_IAltitudeObject) aRefAltitude =
      Handle(HYDROData_IAltitudeObject)::DownCast( createHandle( a0 ) );
    if ( !aRefAltitude.IsNull() )
    {
      Py_BEGIN_ALLOW_THREADS
      sipRes = sipSelfWasArg ? sipCpp->HYDROData_Object::SetAltitudeObject( aRefAltitude ) : 
                               sipCpp->SetAltitudeObject( aRefAltitude );
      Py_END_ALLOW_THREADS
    }

  %End

  /**
   * Returns reference altitude object of geometry object.
   */
  HYDROData_IAltitudeObject GetAltitudeObject() const [Handle_HYDROData_IAltitudeObject ()];
  %MethodCode

    Handle(HYDROData_IAltitudeObject) aRefAltitude;
    
    Py_BEGIN_ALLOW_THREADS
    aRefAltitude = sipSelfWasArg ? sipCpp->HYDROData_Object::GetAltitudeObject() : 
                                   sipCpp->GetAltitudeObject();
    Py_END_ALLOW_THREADS
    
    sipRes = (HYDROData_IAltitudeObject*)createPointer( aRefAltitude );
  
  %End

  /**
   * Clear the reference altitude object for geometry object.
   */
  void RemoveAltitudeObject();

  /**
   * Sets filling color for zone.
   */
  virtual void SetFillingColor( const QColor& theColor );

  /**
   * Returns filling color of zone.
   */
  virtual QColor GetFillingColor() const;

  /**
   * Sets border color for zone.
   */
  virtual void SetBorderColor( const QColor& theColor );

  /**
   * Returns border color of zone.
   */
  virtual QColor GetBorderColor() const;


  /**
   * Returns sequence of object groups.
   */
  HYDROData_SequenceOfObjects GetGroups() const;

  /**
   * Returns group data model object by it id.
   */
  HYDROData_ShapesGroup GetGroup( const int theGroupId ) const [Handle_HYDROData_ShapesGroup ()];
  %MethodCode

    Handle(HYDROData_ShapesGroup) aRefGroup;
    
    Py_BEGIN_ALLOW_THREADS
    aRefGroup = sipSelfWasArg ? sipCpp->HYDROData_Object::GetGroup( a0 ) : 
                                sipCpp->GetGroup( a0 );
    Py_END_ALLOW_THREADS
    
    sipRes = (HYDROData_ShapesGroup*)createPointer( aRefGroup );
  
  %End

  /**
   * Returns group id by data model object.
   */
  int GetGroupId( HYDROData_ShapesGroup theGroup ) const [int (const Handle_HYDROData_ShapesGroup&)];
  %MethodCode

    Handle(HYDROData_ShapesGroup) aRefGroup =
      Handle(HYDROData_ShapesGroup)::DownCast( createHandle( a0 ) );
    if ( !aRefGroup.IsNull() )
    {
      Py_BEGIN_ALLOW_THREADS
      sipRes = sipSelfWasArg ? sipCpp->HYDROData_Object::GetGroupId( aRefGroup ) : 
                               sipCpp->GetGroupId( aRefGroup );
      Py_END_ALLOW_THREADS
    }

  %End

  void SetIsSubmersible( bool ) const;

protected:

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

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