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
  98 interface Gen : GEOM::GEOM_Gen
  99 {
 100   /*!
 101    *  \brief Searches existing or creates a new SHAPERSTUDY_Object to interact with SHAPER
 102    */
 103   SHAPER_Object FindOrCreateShape(in string theInternalEntry);
 104
 105   /*!
 106   *  \brief Stores the variable names of the SHAPER dump to python
 107   */
 108   void StoreVariableName(in string theEntry, in string theVarName);
 109 };
 110
 111 interface IShapesOperations : GEOM::GEOM_IShapesOperations
 112 {
 113 };
 114
 115 interface IGroupOperations  : GEOM::GEOM_IGroupOperations
 116 {
 117   /*!
 118   *  \brief Searches existing group of theOwner shape by the entry. Returns NULL if can not find.
 119   */
 120   SHAPER_Group FindGroup(in SHAPER_Object theOwner, in string theEntry);
 121 };
 122
 123 interface SHAPER_Field             : GEOM::GEOM_Field
 124 {
 125   /*!
 126   *  \brief Sets the type of values in the field
 127   */
 128   void SetValuesType(in short theType);
 129   /*!
 130   *  \brief Returns the type of values in the field
 131   */
 132   short GetValuesType();
 133
 134   /*!
 135   *  \brief Sets the list of time step IDs in the field
 136   */
 137   void SetSteps(in GEOM::ListOfLong theSteps);
 138
 139   /*!
 140   *  \brief Sets the names of components
 141   */
 142   void SetComponents( in GEOM::string_array theComponents );
 143   /*!
 144   *  \brief Erases all steps of this field
 145   */
 146   void ClearFieldSteps();
 147
 148   /*!
 149   *  \brief Appends a step data to this field
 150   */
 151   void AddFieldStep( in long theStampID, in long theStepID, in GEOM::ListOfDouble theValues);
 152
 153
 154   /*!
 155   *  \brief Sets what is returned in the GEOM_IGroupOperations::GetType
 156   */
 157   void SetSelectionType(in long theType);
 158   /*!
 159   *  \brief Returns the type of the selected sub-shapes
 160   */
 161   long GetSelectionType();
 162   /*!
 163   *  \brief Sets what is returned in the GEOM_IGroupOperations::GetObjects
 164   */
 165   void SetSelection(in GEOM::ListOfLong theSelection);
 166   /*!
 167   *  \brief Returns the selected sub-shapes indices
 168   */
 169   GEOM::ListOfLong GetSelection();
 170
 171
 172   /*!
 173   *  \brief Sets the internal entry of the object, common for all objects in SHAPER-STUDY
 174   */
 175   void SetEntry( in string theInternalEntry );
 176   /*!
 177   *  \brief Sets SObject of this object (when it is published)
 178   */
 179   void SetSO( in SALOMEDS::SObject theInternalEntry );
 180   /*!
 181   *  \brief Returns SObject of this object
 182   */
 183   SALOMEDS::SObject GetSO();
 184   /*!
 185   *  \brief Returns true if shape is already dead
 186   */
 187   boolean IsDead();
 188   /*!
 189   *  \brief Makes the dead-copy of the shape and returns it
 190   */
 191   SHAPER_Object MakeDead();
 192
 193 };
 194
 195 interface IFieldOperations  : GEOM::GEOM_IFieldOperations
 196 {
 197   /*!
 198   *  \brief Searches existing field of theOwner shape by the entry. Returns NULL if can not find.
 199   */
 200   SHAPER_Field FindField(in SHAPER_Object theOwner, in string theEntry);
 201   /*!
 202   *  \brief Creates a field of theMainShape.
 203   */
 204   SHAPER_Field CreateFieldByType(in GEOM::GEOM_Object theMainShape, in long theShapeType);
 205 };
 206
 207 interface IMeasureOperations  : GEOM::GEOM_IMeasureOperations
 208 {
 209 };
 210
 211 interface SHAPER_DoubleFieldStep   : GEOM::GEOM_DoubleFieldStep
 212 {
 213 };
 214
 215 interface SHAPER_IntFieldStep      : GEOM::GEOM_IntFieldStep
 216 {
 217 };
 218
 219 interface SHAPER_BoolFieldStep     : GEOM::GEOM_BoolFieldStep
 220 {
 221 };
 222
 223 };
 224
 225 #endif