idl/SHAPERSTUDY_Gen.idl

   1 // Copyright (C) 2007-2019  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 #ifndef __SHAPERSTUDY_GEN__
  24 #define __SHAPERSTUDY_GEN__
  25
  26 #include "GEOM_Gen.idl"
  27 #include "SALOMEDS.idl"
  28 #include "SALOME_Exception.idl"
  29
  30 module SHAPERSTUDY_ORB
  31 {
  32
  33 interface SHAPER_Object : GEOM::GEOM_Object
  34 {
  35   /*!
  36   *  \brief Puts the shape to the object by BRep stream.
  37   */
  38   void SetShapeByStream(in string theStream);
  39   /*!
  40   *  \brief Sets the internal entry of the object, common for all objects in SHAPER-STUDY
  41   */
  42   void SetEntry( in string theInternalEntry );
  43   /*!
  44   *  \brief Sets SObject of this object (when it is published)
  45   */
  46   void SetSO( in SALOMEDS::SObject theInternalEntry );
  47   /*!
  48   *  \brief Returns SObject of this object
  49   */
  50   SALOMEDS::SObject GetSO();
  51   /*!
  52   *  \brief Returns true if shape is already dead
  53   */
  54   boolean IsDead();
  55   /*!
  56   *  \brief Makes the dead-copy of the shape and returns it
  57   */
  58   SHAPER_Object MakeDead();
  59   /*!
  60   *  \brief Returns the stream of the previous version of the shape stored here
  61   */
  62   SALOMEDS::TMPFile GetOldShapeStream();
  63   /*!
  64   *  \brief Sets internal type of operation created this object. For group it is 37, shape 1.
  65   */
  66   void SetType( in long theType );
  67
  68   /*!
  69   *  \brief Sets the shape by the pointer to the TopoDS_Shape
  70   */
  71   void SetShapeByPointer(in long long theShape);
  72 };
  73
  74 /*!
  75  * A group extension of the SHAPER object:
  76  * it contains the selection-type and selected sub-shapes indices.
  77  */
  78 interface SHAPER_Group : SHAPER_Object
  79 {
  80   /*!
  81   *  \brief Sets what is returned in the GEOM_IGroupOperations::GetType
  82   */
  83   void SetSelectionType(in long theType);
  84   /*!
  85   *  \brief Returns the type of the selected sub-shapes
  86   */
  87   long GetSelectionType();
  88   /*!
  89   *  \brief Sets what is returned in the GEOM_IGroupOperations::GetObjects
  90   */
  91   void SetSelection(in GEOM::ListOfLong theSelection);
  92   /*!
  93   *  \brief Returns the selected sub-shapes indices
  94   */
  95   GEOM::ListOfLong GetSelection();
  96   /*!
  97   *  \brief Returns the old selected sub-shapes indices (to restore on break-link)
  98   */
  99   GEOM::ListOfLong GetSelectionOld();
 100 };
 101
 102 interface Gen : GEOM::GEOM_Gen
 103 {
 104   /*!
 105    *  \brief Searches existing or creates a new SHAPERSTUDY_Object to interact with SHAPER
 106    */
 107   SHAPER_Object FindOrCreateShape(in string theInternalEntry);
 108
 109   /*!
 110   *  \brief Stores the variable names of the SHAPER dump to python
 111   */
 112   void StoreVariableName(in string theEntry, in string theVarName);
 113 };
 114
 115 interface IShapesOperations : GEOM::GEOM_IShapesOperations
 116 {
 117 };
 118
 119 interface IGroupOperations  : GEOM::GEOM_IGroupOperations
 120 {
 121   /*!
 122   *  \brief Searches existing group of theOwner shape by the entry. Returns NULL if can not find.
 123   */
 124   SHAPER_Group FindGroup(in SHAPER_Object theOwner, in string theEntry);
 125 };
 126
 127 interface SHAPER_Field             : GEOM::GEOM_Field
 128 {
 129   /*!
 130   *  \brief Sets the type of values in the field
 131   */
 132   void SetValuesType(in short theType);
 133   /*!
 134   *  \brief Returns the type of values in the field
 135   */
 136   short GetValuesType();
 137
 138   /*!
 139   *  \brief Sets the list of time step IDs in the field
 140   */
 141   void SetSteps(in GEOM::ListOfLong theSteps);
 142
 143   /*!
 144   *  \brief Sets the names of components
 145   */
 146   void SetComponents( in GEOM::string_array theComponents );
 147   /*!
 148   *  \brief Erases all steps of this field
 149   */
 150   void ClearFieldSteps();
 151
 152   /*!
 153   *  \brief Appends a step data to this field
 154   */
 155   void AddFieldStep( in long theStampID, in long theStepID, in GEOM::ListOfDouble theValues);
 156
 157
 158   /*!
 159   *  \brief Sets what is returned in the GEOM_IGroupOperations::GetType
 160   */
 161   void SetSelectionType(in long theType);
 162   /*!
 163   *  \brief Returns the type of the selected sub-shapes
 164   */
 165   long GetSelectionType();
 166   /*!
 167   *  \brief Sets what is returned in the GEOM_IGroupOperations::GetObjects
 168   */
 169   void SetSelection(in GEOM::ListOfLong theSelection);
 170   /*!
 171   *  \brief Returns the selected sub-shapes indices
 172   */
 173   GEOM::ListOfLong GetSelection();
 174   /*!
 175   *  \brief Returns the old selected sub-shapes indices (to restore on break-link)
 176   */
 177   GEOM::ListOfLong GetSelectionOld();
 178
 179   /*!
 180   *  \brief Sets the internal entry of the object, common for all objects in SHAPER-STUDY
 181   */
 182   void SetEntry( in string theInternalEntry );
 183   /*!
 184   *  \brief Sets SObject of this object (when it is published)
 185   */
 186   void SetSO( in SALOMEDS::SObject theInternalEntry );
 187   /*!
 188   *  \brief Returns SObject of this object
 189   */
 190   SALOMEDS::SObject GetSO();
 191   /*!
 192   *  \brief Returns true if shape is already dead
 193   */
 194   boolean IsDead();
 195   /*!
 196   *  \brief Makes the dead-copy of the shape and returns it
 197   */
 198   SHAPER_Object MakeDead();
 199
 200 };
 201
 202 interface IFieldOperations  : GEOM::GEOM_IFieldOperations
 203 {
 204   /*!
 205   *  \brief Searches existing field of theOwner shape by the entry. Returns NULL if can not find.
 206   */
 207   SHAPER_Field FindField(in SHAPER_Object theOwner, in string theEntry);
 208   /*!
 209   *  \brief Creates a field of theMainShape.
 210   */
 211   SHAPER_Field CreateFieldByType(in GEOM::GEOM_Object theMainShape, in long theShapeType);
 212 };
 213
 214 interface IMeasureOperations  : GEOM::GEOM_IMeasureOperations
 215 {
 216 };
 217
 218 interface SHAPER_DoubleFieldStep   : GEOM::GEOM_DoubleFieldStep
 219 {
 220 };
 221
 222 interface SHAPER_IntFieldStep      : GEOM::GEOM_IntFieldStep
 223 {
 224 };
 225
 226 interface SHAPER_BoolFieldStep     : GEOM::GEOM_BoolFieldStep
 227 {
 228 };
 229
 230 };
 231
 232 #endif