From: apo <apo@opencascade.com>
Date: Fri, 1 Jun 2007 12:59:11 +0000 (+0000)
Subject: To clarify IDL.
X-Git-Tag: Before_Merging_With_Windows_20jun07~14
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=bf0330b08c352da5dcf132f65e9754128075e2f1;p=modules%2Fvisu.git

To clarify IDL.

1. It is forbiden to change input of Prs3d objects outside of "3D Cache System". So, corresponding functions are removed from IDL (but stays as it is in implementation)

2. "ScalaraMapOnDefomedShape" presentation was modified in the following way:
  a) Method
      void SetScalarField(in string theMeshName, in string theFieldName, in long theIteration, in Entity theEntity)
    was changed to the
      void SetScalarField(in Entity theEntity, in string theFieldName, in long theTimeStampNumber)
  b) Method
      string GetScalarCMeshName()
    was removed at all
  c) Method
      Entity GetScalarEEntity()
    was changed to the
      Entity GetScalarEntity();
  c) Method
      long GetScalarLIteration();
    was changed to the
      long GetScalarTimeStampNumber();
  d) Method
      string GetScalarCFieldName();
    was changed to the
      string GetScalarFieldName();
---

diff --git a/idl/VISU_Gen.idl b/idl/VISU_Gen.idl
index 909a6d58..c3e9d50b 100644
--- a/idl/VISU_Gen.idl
+++ b/idl/VISU_Gen.idl
@@ -319,31 +319,11 @@ module VISU {
    */
   interface Prs3d : PrsObject, SALOME::GenericObj 
   {
-    /*!
-     * Applies a set basic input parameters to the 3D presentation
-     * \return True of the set of input parameters is correct and was succesfully applied,
-     * False otherwise
-     */
-    boolean Apply(in boolean theReInit); 
-
-    //! Sets Result object used by presentation to obtain its input 
-    void SetResultObject(in Result theResult);
-
-    //! Gets Result object used by presentation to obtain its input 
-    Result GetResultObject();
-
-    //! Sets name of the mesh used by presentation to obtain its input 
-    void SetMeshName(in string theMeshName);
-
-    //! Gets name of the mesh used by presentation to obtain its input 
-    string GetMeshName();
-
     /*!
      * Move the 3D presentation according to the given offset parameters
      */
     void SetOffset(in float theDx, in float theDy, in float theDz);
 
-
     /*!
      * Gets offset parameters for the 3D presentation
      */
@@ -432,43 +412,6 @@ module VISU {
    */
   interface ColoredPrs3d : Prs3d 
   {
-    /*! Sets Entity input parameter that defines where the parent mesh to be taken from. 
-     */
-    void SetEntity(in Entity theEntity);
-    /*! Gets Entity input parameter that defines where the parent mesh is taken from. 
-     */
-    Entity GetEntity();
-
-    /*! Sets name of field input parameter that defines what phisical data to be retrived. 
-     */
-    void SetFieldName(in string theName);
-    /*! Gets name of field input parameter that defines what phisical data is retrived. 
-     */
-    string GetFieldName();
-
-    /*! Sets number of timestamp input parameter that defines what time of phisical data to be retrived. 
-     */
-    void SetTimeStampNumber(in long theTimeStampNumber);
-    /*! Gets number of timestamp input parameter that defines what time of phisical data is retrived. 
-     */
-    long GetTimeStampNumber();
-
-    /*! Defines timestamp representation. 
-     */
-    struct TimeStampInfo
-    {
-      string myTime;
-      long myNumber;
-    };
-
-    /*! Defines representation range of timestamps. 
-     */
-    typedef sequence<TimeStampInfo> TimeStampsRange;
-
-    /*! Gets available range of timestamps. 
-     */
-    TimeStampsRange GetTimeStampsRange();
-
     /*! Defines whether this presentation is bound to timestamp or not.
      */
     boolean IsTimeStampFixed();
@@ -588,6 +531,8 @@ module VISU {
   interface View3D;
   interface ColoredPrs3dCache;
 
+
+  //-------------------------------------------------------
   /*! \brief %ColoredPrs3dHolder interface.
    * Interface of 3d presentation's holder, which represents colored 3d presentations,
    * created on fields. It is publishing in the object browser in a separate folder
@@ -624,10 +569,22 @@ module VISU {
      */
     VISUType GetPrsType();
 
+    /*! Defines timestamp representation. 
+     */
+    struct TimeStampInfo
+    {
+      string myTime;
+      long myNumber;
+    };
+
+    /*! Defines representation range of timestamps. 
+     */
+    typedef sequence<TimeStampInfo> TimeStampsRange;
+
     /*!
      * Gets TimeStampsRange information from the last visited presentation.
      */
-    ColoredPrs3d::TimeStampsRange GetTimeStampsRange();
+    TimeStampsRange GetTimeStampsRange();
 
     /*!
      * Gets input parameters of the last visited presentation.
@@ -828,36 +785,32 @@ module VISU {
 
     /*!
      * Sets the scalar field
-     * \param theMeshName  - mesh name
-     * \param theFieldName - the name of scalar field
-     * \param theIteration - the iteration number for scalar field
      * \param theEntity    - entity of scalar field
+     * \param theFieldName - the name of scalar field
+     * \param theTimeStampNumber - the timestamp number for the scalar field
      */
-    void SetScalarField(in string theMeshName,in string theFieldName,
-			in long theIteration,in Entity theEntity);
-
+    void SetScalarField(in Entity theEntity,
+			in string theFieldName,
+			in long theTimeStampNumber);
 
-    /*!
-     * Get scalar iteration number
-     */
-    long GetScalarLIteration();
 
     /*!
      * Get scalar entity
      */
-    Entity GetScalarEEntity();
+    Entity GetScalarEntity();
 
     /*!
      * Get scalar field name
      */
-    string GetScalarCFieldName();
+    string GetScalarFieldName();
 
     /*!
-     * Get mesh name
+     * Get timestamp number for the scalar field
      */
-    string GetScalarCMeshName();
-    
+    long GetScalarTimeStampNumber();
   };
+
+
   //-------------------------------------------------------
   /*!
    *  \brief Plot3D interface