-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File: SketcherPrs_Tools.h
-// Created: 10 March 2015
-// Author: Vitaly SMETANNIKOV
+// Copyright (C) 2014-2021 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 SketcherPrs_Tools_H
#define SketcherPrs_Tools_H
#include <ModelAPI_Object.h>
#include <ModelAPI_Attribute.h>
#include <ModelAPI_Feature.h>
+#include <ModelAPI_CompositeFeature.h>
+#include <ModelAPI_Result.h>
#include <string>
#include <Events_Loop.h>
#include <Events_Message.h>
class GeomDataAPI_Point2D;
-class AIS_Dimension;
-//#define MyTextHeight 20
+namespace SketcherPrs_Tools {
-/// Message that style of visualization of parameter is changed.
-/// It will be shown as expression or value
-class SketcherPrs_ParameterStyleMessage : public Events_Message
-{
-public:
/// \enum ParameterStyle lists styles of parameter
enum ParameterStyle {
ParameterValue, ///< using symbol with the parameter value
ParameterText ///< using parameter text
};
-public:
- /// Creates an empty message
- SKETCHERPRS_EXPORT SketcherPrs_ParameterStyleMessage(const Events_ID theID,
- const void* theSender = 0)
- : Events_Message(theID, theSender) {}
- /// The virtual destructor
- SKETCHERPRS_EXPORT virtual ~SketcherPrs_ParameterStyleMessage() {}
- /// Static. Returns EventID of the message.
- SKETCHERPRS_EXPORT static Events_ID eventId()
- {
- static const char * MY_EVENT_PARAMETER_STYLE_ID("ParameterStyle");
- return Events_Loop::eventByName(MY_EVENT_PARAMETER_STYLE_ID);
- }
- /// Returns a document stored in the message
- SKETCHERPRS_EXPORT ParameterStyle style() const { return myStyle; }
- /// Sets a document to the message
- SKETCHERPRS_EXPORT void setStyle(ParameterStyle theStyle) { myStyle = theStyle; }
-private:
- ParameterStyle myStyle; /// style of the parameter visualization
-};
+ /// Set dimensions parameters style
+ /// \param theStyle new style
+ SKETCHERPRS_EXPORT void setParameterStyle(ParameterStyle theStyle);
-namespace SketcherPrs_Tools {
+ /// Return dimensions parameters style
+ SKETCHERPRS_EXPORT ParameterStyle parameterStyle();
/// Enumeration with modes for activation of selection custom presentations
enum SelectionModes {
ANGLE_BACKWARD ///< Angle from the second line to the first line
};
+ /// Type of dimension location
+ enum LocationType{
+ LOCATION_RIGHT, ///< Position is marked by right arrow placed on the left
+ LOCATION_AUTOMATIC, ///< Position is marked by two arrow placed on the both sides
+ LOCATION_LEFT ///< Position is marked by left arrow placed on the left
+ };
+
/// Event ID about expression visual state has been changed, the symbol with a digit
/// or parameter text is shown
const std::string& theAttribute,
const std::shared_ptr<GeomAPI_Ax3>& thePlane);
+ /// Collect all sketch points which are not connected with other entities.
+ /// \param theSketch sketch feature
+ /// \return list of results of SketchPlugin_Point features
+ SKETCHERPRS_EXPORT std::list<ResultPtr> getFreePoints(const CompositeFeaturePtr& theSketch);
+
/// Returns value of dimension arrows size
SKETCHERPRS_EXPORT double getArrowSize();
/// Returns default value of dimension arrows size
SKETCHERPRS_EXPORT int getDefaultArrowSize();
+ /// Returns value of dimension arrows size set in preferences
+ SKETCHERPRS_EXPORT int getConfigArrowSize();
+
/// Set value of dimension text height
/// \param theHeight a height value
SKETCHERPRS_EXPORT void setTextHeight(double theHeight);
/// Returns default value of dimension text height
SKETCHERPRS_EXPORT double getDefaultTextHeight();
+ /// Returns value of dimension text height set in preferences
+ SKETCHERPRS_EXPORT double getConfigTextHeight();
+
/// Get flayout distance of the dimension constraint
/// \param theConstraint a dimension constraint object
SKETCHERPRS_EXPORT double getFlyoutDistance(const ModelAPI_Feature* theConstraint);
const ModelAPI_Feature* theConstraint,
const std::shared_ptr<GeomAPI_Ax3>& thePlane);
- /// Sends event about expression visualization type is changed for dimension presentations
- /// Sends event to redisplay all sub-features of composite feature
- /// \param theState a new state
- SKETCHERPRS_EXPORT void sendExpressionShownEvent(const bool& theState);
-
/// Throws an exception(in debug mode) and sends a signal about necessity to hide the object
/// \param theFeature a feature where AIS presentation is empty
/// \param theError a debug error information
SKETCHERPRS_EXPORT void sendEmptyPresentationError(ModelAPI_Feature* theFeature,
const std::string theError);
+
+ SKETCHERPRS_EXPORT void setPixelRatio(int theRatio);
+
+ SKETCHERPRS_EXPORT int pixelRatio();
};
#endif
