X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FGeomAPI%2FGeomAPI_AISObject.h;h=c649ba93862dbb829cb3b7c4ef67b5fed18dfca1;hb=b2fc3132f3010bb1ebc54fff534cda6bb53e89b3;hp=d3f23859186552521fabc6af4cd2e5cb3af3e5f1;hpb=0be8c3180aa1cf83de96e11e8ecf2269ef81f5f7;p=modules%2Fshaper.git diff --git a/src/GeomAPI/GeomAPI_AISObject.h b/src/GeomAPI/GeomAPI_AISObject.h index d3f238591..c649ba938 100644 --- a/src/GeomAPI/GeomAPI_AISObject.h +++ b/src/GeomAPI/GeomAPI_AISObject.h @@ -1,13 +1,15 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + // File: GeomAPI_AISObject.hxx // Created: 25 Jun 2014 // Author: Artem ZHIDKOV -#ifndef GeomAPI_AISObject_HeaderFile -#define GeomAPI_AISObject_HeaderFile +#ifndef GeomAPI_AISObject_H_ +#define GeomAPI_AISObject_H_ #include -#include +#include class GeomAPI_Circ; class GeomAPI_Lin; @@ -15,24 +17,27 @@ class GeomAPI_Pln; class GeomAPI_Pnt; class GeomAPI_Shape; -struct GEOMAPI_EXPORT Colors -{ - static int COLOR_BROWN; -}; - /** \class GeomAPI_AISObject * \ingroup DataModel * \brief Interface for AIS_InteractiveObject */ -class GEOMAPI_EXPORT GeomAPI_AISObject : public GeomAPI_Interface +class GeomAPI_AISObject : public GeomAPI_Interface { -public: + public: /// \brief Creation of empty AIS object + GEOMAPI_EXPORT GeomAPI_AISObject(); + GEOMAPI_EXPORT + ~GeomAPI_AISObject(); + /// \brief Creates AIS_Shape object using specified shape - void createShape(boost::shared_ptr theShape); + GEOMAPI_EXPORT + void createShape(std::shared_ptr theShape); + + /// Reyirns shape used for the presentation creation (can be NULL) + GEOMAPI_EXPORT std::shared_ptr getShape() const; /** \brief Creates AIS_LengthDimension object * \param[in] theStartPoint first point for dimension @@ -41,20 +46,28 @@ public: * \param[in] thePlane the plane which contains all points above * \param[in] theDistance value of the distance to be shown */ - void createDistance(boost::shared_ptr theStartPoint, - boost::shared_ptr theEndPoint, - boost::shared_ptr theFlyoutPoint, - boost::shared_ptr thePlane, - double theDistance); + GEOMAPI_EXPORT + void createDistance(std::shared_ptr theStartPoint, + std::shared_ptr theEndPoint, + std::shared_ptr theFlyoutPoint, + std::shared_ptr thePlane, double theDistance); + + /** + * Returns validity of the AIS distance. It is invalid if set measured geometry is not valid, + * e.g. the distance points are equal. + * \return a boolean result + */ + GEOMAPI_EXPORT + bool isEmptyDistanceGeometry(); /** \brief Creates AIS_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 */ - void createRadius(boost::shared_ptr theCircle, - boost::shared_ptr theFlyoutPoint, - double theRadius); + GEOMAPI_EXPORT + void createRadius(std::shared_ptr theCircle, + std::shared_ptr theFlyoutPoint, double theRadius); /** \brief Creates AIS_ParallelRelation object for two lines * \param[in] theLine1 first parallel line @@ -62,31 +75,85 @@ public: * \param[in] theFlyoutPoint the flyout point for relation * \param[in] thePlane the plane which contains the lines */ - void createParallel(boost::shared_ptr theLine1, - boost::shared_ptr theLine2, - boost::shared_ptr theFlyoutPoint, - boost::shared_ptr thePlane); + GEOMAPI_EXPORT + void createParallel(std::shared_ptr theLine1, + std::shared_ptr theLine2, + std::shared_ptr theFlyoutPoint, + std::shared_ptr thePlane); /** \brief Creates AIS_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 */ - void createPerpendicular(boost::shared_ptr theLine1, - boost::shared_ptr theLine2, - boost::shared_ptr thePlane); + GEOMAPI_EXPORT + void createPerpendicular(std::shared_ptr theLine1, + std::shared_ptr theLine2, + std::shared_ptr thePlane); + + /** \brief Creates AIS_FixedRelation object for an object + * \param[in] theShape the object + * \param[in] thePlane the plane which contains the lines + */ + GEOMAPI_EXPORT + void createFixed(std::shared_ptr theShape, + std::shared_ptr thePlane); /** \brief Assigns the color for the shape * \param[in] theColor index of the color */ + GEOMAPI_EXPORT void setColor(const int& theColor); + /** \brief Assigns the color for the shape + * \param[in] theR value of the red component + * \param[in] theG value of the green component + * \param[in] theB value of the blue component + * \returns true if the presentation color is changed + */ + GEOMAPI_EXPORT + bool setColor(int theR, int theG, int theB); + + /** \brief Returns the color for the shape + * \param[in] theR value of the red component + * \param[in] theG value of the green component + * \param[in] theB value of the blue component + */ + GEOMAPI_EXPORT + void getColor(int& theR, int& theG, int& theB); + /// \brief Assigns the width of the lines of shape - void setWidth(const double& theWidth); + GEOMAPI_EXPORT + bool setWidth(const double& theWidth); /// \brief Checks if the object is empty + GEOMAPI_EXPORT bool empty() const; + + /// Return shape type according to TopAbs_ShapeEnum if the AIS is AIS_Shape + /// Otherwise returns -1 + GEOMAPI_EXPORT + int getShapeType() const; + + /// Sets marker type for vertex. + /// The type has to be defined according to Acpect_TypeOfMarker + GEOMAPI_EXPORT + void setPointMarker(int theType, double theScale); + + /// Set line type of edges + /// Has to be defined according to Aspect_TypeOfLine + /// \returns true if the object value differs from the current + GEOMAPI_EXPORT + bool setLineStyle(int theStyle); + + /// Set transparency of the presentation (theVal = 0 ... 1) + /// \returns true if the object value differs from the current + GEOMAPI_EXPORT + bool setTransparensy(double theVal); }; +//! Pointer on attribute object +typedef std::shared_ptr AISObjectPtr; + #endif