Salome HOME
3D presentation for lin.interp. stream
[modules/hydro.git] / src / HYDROPy / HYDROData_Object.sip
index ea7165670cc267c7bfe43f6caf8f455030c585ec..6507f676b52dfe8845992ca741acc84376985f57 100644 (file)
@@ -1,12 +1,8 @@
-// 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
-//
+// 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.
+// 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
 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
 
-
 %ExportedHeaderCode
 #include <HYDROData_Object.h>
 %End
 
-typedef int ObjectKind;
-
-const ObjectKind KIND_UNKNOWN;
-const ObjectKind KIND_IMAGE;
-const ObjectKind KIND_POLYLINE;
-const ObjectKind KIND_VISUAL_STATE;
-const ObjectKind KIND_BATHYMETRY;
-
-class HYDROData_Object
+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_IMAGE:
-        sipClass = sipClass_HYDROData_Image;
-        break;
-
-      case KIND_POLYLINE:
-        sipClass = sipClass_HYDROData_Polyline;
-        break;
+   // 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_BC_POLYGON:
+      sipClass = sipClass_HYDROData_BCPolygon;
+      break;
+
+    case KIND_UNKNOWN:
+      sipClass = sipClass_HYDROData_Entity;
+      break;
+
+    default:
+      // We don't recognise the type.
+      sipClass = NULL;
+  }
+%End
 
-      case KIND_BATHYMETRY:
-        sipClass = sipClass_HYDROData_Bathymetry;
-        break;
+public:
 
-      case KIND_UNKNOWN:
-        sipClass = sipClass_HYDROData_Object;
-        break;
+  /**
+   * Set reference altitude object for geometry object.
+   */
+  bool SetAltitudeObject( HYDROData_IAltitudeObject theAltitude ) [void (const opencascade::handle<HYDROData_IAltitudeObject>&)];
+  %MethodCode
 
-      default:
-        // We don't recognise the type.
-        sipClass = NULL;
+    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
 
-public:
+  %End
+
+  /**
+   * Returns reference altitude object of geometry object.
+   */
+  HYDROData_IAltitudeObject GetAltitudeObject() const [opencascade::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
 
   /**
-   * Returns the kind of this object. Must be redefined in all objects of known type.
+   * Clear the reference altitude object for geometry object.
    */
-  const ObjectKind GetKind() const;
+  void RemoveAltitudeObject();
 
   /**
-   * Returns the name of this object.
+   * Sets filling color for zone.
    */
-  QString GetName() const;
+  virtual void SetFillingColor( const QColor& theColor );
 
   /**
-   * Updates the name of this object.
+   * Returns filling color of zone.
    */
-  void SetName(const QString& theName);
+  virtual QColor GetFillingColor() const;
 
   /**
-   * Updates object state.
+   * Sets border color for zone.
    */
-  void Update();
+  virtual void SetBorderColor( const QColor& theColor );
 
   /**
-   * Checks is object exists in the data structure.
-   * \returns true is object is not exists in the data model
+   * Returns border color of zone.
    */
-  bool IsRemoved() const;
+  virtual QColor GetBorderColor() const;
+
 
   /**
-   * Removes object from the data structure.
+   * Returns sequence of object groups.
    */
-  void Remove();
+  HYDROData_SequenceOfObjects GetGroups() const;
 
   /**
-   * Returns unique integer identifier of the object (may be used for ordering of objects)
+   * Returns group data model object by it id.
    */
-  int ID() const;
+  HYDROData_ShapesGroup GetGroup( const int theGroupId ) const [opencascade::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
 
   /**
-   * Copies all properties of this to the destinated object.
-   * Objects must be the same type.
-   * \param theDestination initialized object (from any document) - target of copying
+   * Returns group id by data model object.
    */
-  /*
-  void CopyTo( HYDROData_Object theDestination ) const;
-  */
+  int GetGroupId( HYDROData_ShapesGroup theGroup ) const [int (const opencascade::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: