Salome HOME
Copyright update 2022
[modules/shaper.git] / src / GeomAPI / GeomAPI_AISObject.h
index 70e06b9beae47857b236e600bd9fb2e9c14f0112..a857b3e1cddd7ba6712002bccaf251a33c0e0aa6 100644 (file)
@@ -1,8 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        GeomAPI_AISObject.hxx
-// Created:     25 Jun 2014
-// Author:      Artem ZHIDKOV
+// Copyright (C) 2014-2022  CEA/DEN, 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, 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
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
 
 #ifndef GeomAPI_AISObject_H_
 #define GeomAPI_AISObject_H_
@@ -36,10 +49,10 @@ class GeomAPI_AISObject : public GeomAPI_Interface
   GEOMAPI_EXPORT
   void createShape(std::shared_ptr<GeomAPI_Shape> theShape);
 
-  /// Reyirns shape used for the presentation creation (can be NULL)
+  /// Returns shape used for the presentation creation (can be NULL)
   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Shape> getShape() const;
 
-  /** \brief Creates AIS_LengthDimension object
+  /** \brief Creates PrsDim_LengthDimension object
    *  \param[in] theStartPoint  first point for dimension
    *  \param[in] theEndPoint    second point for dimension
    *  \param[in] theFlyoutPoint the flyout of dimension relative to the measured line
@@ -60,7 +73,7 @@ class GeomAPI_AISObject : public GeomAPI_Interface
   GEOMAPI_EXPORT
   bool isEmptyDistanceGeometry();
 
-  /** \brief Creates AIS_RadiusDimension object
+  /** \brief Creates PrsDim_RadiusDimension object
    *  \param[in] theCircle      the radius is created for this circle
    *  \param[in] theFlyoutPoint the flyout of dimension
    *  \param[in] theRadius      value of the radius to be shown
@@ -69,7 +82,7 @@ class GeomAPI_AISObject : public GeomAPI_Interface
   void createRadius(std::shared_ptr<GeomAPI_Circ> theCircle,
                     std::shared_ptr<GeomAPI_Pnt> theFlyoutPoint, double theRadius);
 
-  /** \brief Creates AIS_ParallelRelation object for two lines
+  /** \brief Creates PrsDim_ParallelRelation object for two lines
    *  \param[in] theLine1       first parallel line
    *  \param[in] theLine2       second parallel line
    *  \param[in] theFlyoutPoint the flyout point for relation
@@ -81,7 +94,7 @@ class GeomAPI_AISObject : public GeomAPI_Interface
                       std::shared_ptr<GeomAPI_Pnt> theFlyoutPoint,
                       std::shared_ptr<GeomAPI_Pln> thePlane);
 
-  /** \brief Creates AIS_PerpendicularRelation object for two lines
+  /** \brief Creates PrsDim_PerpendicularRelation object for two lines
    *  \param[in] theLine1       first parallel line
    *  \param[in] theLine2       second parallel line
    *  \param[in] thePlane       the plane which contains the lines
@@ -91,7 +104,7 @@ class GeomAPI_AISObject : public GeomAPI_Interface
                            std::shared_ptr<GeomAPI_Shape> theLine2,
                            std::shared_ptr<GeomAPI_Pln> thePlane);
 
-  /** \brief Creates AIS_FixedRelation object for an object
+  /** \brief Creates PrsDim_FixedRelation object for an object
    *  \param[in] theShape       the object
    *  \param[in] thePlane       the plane which contains the lines
    */
@@ -134,6 +147,18 @@ class GeomAPI_AISObject : public GeomAPI_Interface
   GEOMAPI_EXPORT
   double getDeflection() const;
 
+  /** \brief Assigns the transparency to the shape
+   *  \param[in] theTransparency value of transparency
+   */
+  GEOMAPI_EXPORT
+  bool setTransparency(const double theTransparency);
+
+  /** \brief Returns deflection for the shape
+   *  \return double value
+   */
+  GEOMAPI_EXPORT
+  double getTransparency() const;
+
   /// \return Current width of the lines of shape
   GEOMAPI_EXPORT
   double width();