From: ouv <ouv@opencascade.com>
Date: Fri, 11 Nov 2005 12:53:13 +0000 (+0000)
Subject: Documentation.
X-Git-Tag: BR-D5-38-2003_D2005-24-11~50
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=1aa0d38f8069c523eaaf081b7b9f49e914a3f970;p=modules%2Fvisu.git

Documentation.
---

diff --git a/src/VISU_I/VISU_GaussPoints_i.hh b/src/VISU_I/VISU_GaussPoints_i.hh
index 85d97629..1a6ca183 100644
--- a/src/VISU_I/VISU_GaussPoints_i.hh
+++ b/src/VISU_I/VISU_GaussPoints_i.hh
@@ -34,6 +34,7 @@ class VISU_GaussPointsPL;
 
 namespace VISU
 {
+  //! Class of the Gauss Points presentation.
   class GaussPoints_i : public virtual POA_VISU::GaussPoints,
 			public virtual VISU::TGaussPtsActorFactory,
 			public virtual ColoredPrs3d_i
@@ -65,106 +66,137 @@ namespace VISU
 
     typedef VISU::GaussPoints TInterface;
 
+    //! Get the Gauss Points Pipeline.
     VISU_GaussPointsPL* 
     GetGaussPointsPL();
 
+    //! Get color for Geometry mode of the presentation.
     QColor
     GetColor() { return myColor; }
 
+    //! Set color for Geometry mode of the presentation.
     void
     SetColor( const QColor& theColor ) { myColor = theColor; }
 
+    //! Get flag indicating which mode of the presentation is active.
+    /*! When Results mode is active, returns true. Geometry - false. */
     bool 
     GetIsColored() { return myIsColored; }
 
+    //! Get flag indicating which mode of the presentation is active.
     void
     SetIsColored( bool theIsColored );
 
+    //! Set path to the image using for Main Point Sprite texture.
     bool
     SetMainTexture( const QString& theMainTexture );
 
+    //! Get path to the image using for Main Point Sprite texture.
     const QString&
     GetMainTexture();
 
+    //! Set path to the image using for Alpha Point Sprite texture.
     bool
     SetAlphaTexture( const QString& theAlphaTexture );
 
+    //! Get path to the image using for Alpha Point Sprite texture.
     const QString&
     GetAlphaTexture();
 
+    //! Convert Main and AlphaMask images to VTI format and set them to pipeline.
     void
     SetTextures( const QString& theMainTexture,
 		 const QString& theAlphaTexture );
 
+    //! Redirect the request to VISU_GaussPointsPL::SetAlphaThreshold.
     void
     SetAlphaThreshold(float theAlphaThreshold);
 
+    //! Redirect the request to VISU_GaussPointsPL::GetAlphaThreshold.
     float
     GetAlphaThreshold();
 
+    //! Redirect the request to VISU_GaussPointsPL::GetMaximumSupportedSize.
     float 
     GetMaximumSupportedSize();
 
+    //! Redirect the request to VISU_GaussPointsPL::SetClamp.
     void
     SetClamp(float theClamp);
 
+    //! Redirect the request to VISU_GaussPointsPL::GetClamp.
     float
     GetClamp();
 
+    //! Redirect the request to VISU_GaussPointsPL::SetSize.
     void
     SetConstSize(float theConstSize);
 
+    //! Redirect the request to VISU_GaussPointsPL::GetSize.
     float 
     GetConstSize();
 
+    //! Redirect the request to VISU_GaussPointsPL::SetMinSize.
     void
     SetMinSize(float theMinSize);
 
+    //! Redirect the request to VISU_GaussPointsPL::GetMinSize.
     float 
     GetMinSize();
 
+    //! Redirect the request to VISU_GaussPointsPL::SetMaxSize.
     void
     SetMaxSize(float theMaxSize);
 
+    //! Redirect the request to VISU_GaussPointsPL::GetMaxSize.
     float 
     GetMaxSize();
 
-    float
-    GetMaxPointSize();
-
+    //! Redirect the request to VISU_GaussPointsPL::SetMagnification.
     void
     SetMagnification(float theMagnification);
 
+    //! Redirect the request to VISU_GaussPointsPL::GetMagnification.
     float
     GetMagnification();
 
+    //! Redirect the request to VISU_GaussPointsPL::SetMagnificationIncrement.
     void
     SetMagnificationIncrement(float theIncrement);
 
+    //! Redirect the request to VISU_GaussPointsPL::GetMagnificationIncrement.
     float
     GetMagnificationIncrement();
 
+    //! Set flag indicating which scalar bar is active.
     void
     SetIsActiveLocalScalarBar(const bool theFlag);
 
+    //! Get flag indicating which scalar bar is active.
     bool
     GetIsActiveLocalScalarBar() const;
 
+    //! Set flag indicating visibility of global scalar bar.
     void
     SetIsDispGlobalScalarBar(const bool theFlag);
 
+    //! Get flag indicating visibility of global scalar bar.
     bool
     GetIsDispGlobalScalarBar() const;
 
+    //! Redirect the request to VISU_GaussPointsPL::SetBicolor.
     void
     SetBiColor(bool theIsBiColor);
 
+    //! Redirect the request to VISU_GaussPointsPL::GetBicolor.
     bool
     GetBiColor();
 
+    //! Set value of the distance between global and local scalar bars.
     void
     SetSpacing(const float theSpacing);
 
+    //! Get value of the distance between global and local scalar bars.
     float
     GetSpacing() const;