1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef SketcherPrs_SymbolPrs_H
22 #define SketcherPrs_SymbolPrs_H
24 #include "SketcherPrs_SensitivePoint.h"
25 #include <ModelAPI_Feature.h>
26 #include <ModelAPI_AttributeRefList.h>
28 #include <AIS_InteractiveObject.hxx>
29 #include <GeomAPI_Ax3.h>
30 #include <Graphic3d_ArrayOfPoints.hxx>
31 #include <Graphic3d_AspectMarker3d.hxx>
32 #include <Image_AlienPixMap.hxx>
33 #include <SelectMgr_EntityOwner.hxx>
34 #include <Select3D_EntitySequence.hxx>
36 #include <Standard_DefineHandle.hxx>
39 #include <OpenGl_Workspace.hxx>
44 DEFINE_STANDARD_HANDLE(SketcherPrs_SymbolPrs, AIS_InteractiveObject)
46 class SketcherPrs_SymbolArray;
49 * A base class of constraint presentation which is represented by an icon
51 class SketcherPrs_SymbolPrs: public AIS_InteractiveObject
55 /// \param theConstraint a constraint feature
56 /// \param thePlane a coordinate plane of current sketch
57 Standard_EXPORT SketcherPrs_SymbolPrs(ModelAPI_Feature* theConstraint,
58 const std::shared_ptr<GeomAPI_Ax3>& thePlane);
60 virtual ~SketcherPrs_SymbolPrs();
62 //! Method which draws selected owners ( for fast presentation draw )
63 Standard_EXPORT virtual void HilightSelected(const Handle(PrsMgr_PresentationManager3d)& thePM,
64 const SelectMgr_SequenceOfOwner& theOwners);
66 //! Method which hilight an owner belonging to
67 //! this selectable object ( for fast presentation draw )
68 Standard_EXPORT virtual void HilightOwnerWithColor(
69 const Handle(PrsMgr_PresentationManager3d)& thePM,
70 const Handle(Graphic3d_HighlightStyle)& theStyle,
71 const Handle(SelectMgr_EntityOwner)& theOwner);
73 /// Returns sketcher plane
74 Standard_EXPORT std::shared_ptr<GeomAPI_Ax3> plane() const { return myPlane; }
76 /// Returns feature object
77 Standard_EXPORT ModelAPI_Feature* feature() const { return myConstraint; }
79 /// Return array of points where symbols will be placed
80 const Handle(Graphic3d_ArrayOfPoints)& pointsArray() const { return myPntArray; }
82 /// Set state of the presentation, in case of conflicting state, the icon of the presentation is
83 /// visualized in error color. The state is stored in an internal field, so should be changed
84 /// when constraint become not conflicting
85 /// \param theColor a color for conflicting object
86 Standard_EXPORT void SetCustomColor(const std::vector<int>& theColor);
88 /// Add a bounding box of the presentation to common bounding box
89 /// \param theBndBox the common bounding box to update
90 Standard_EXPORT virtual void BoundingBox (Bnd_Box& theBndBox) Standard_OVERRIDE;
92 DEFINE_STANDARD_RTTIEXT(SketcherPrs_SymbolPrs, AIS_InteractiveObject)
95 /// Redefinition of virtual function
96 Standard_EXPORT virtual void Compute(
97 const Handle(PrsMgr_PresentationManager3d)& thePresentationManager,
98 const Handle(Prs3d_Presentation)& thePresentation, const Standard_Integer theMode = 0);
100 /// Redefinition of virtual function
101 /// \param aSelection selection
102 /// \param aMode compute mode
103 Standard_EXPORT virtual void ComputeSelection(const Handle(SelectMgr_Selection)& aSelection,
104 const Standard_Integer aMode);
106 /// Returns an icon file name. Has to be redefined in successors
107 virtual const char* iconName() const = 0;
109 /// Check and creates if it is necessary myAspect member.
110 /// It has to be called before the object computation
111 virtual void prepareAspect();
113 /// Returns icon corresponded to the current constraint type
114 Handle(Image_AlienPixMap) icon();
116 /// Add a line into the given group
117 /// \param theGroup a group for drawing
118 /// \param theAttrName an attribute name which corresponds to referenced line
119 void addLine(const Handle(Graphic3d_Group)& theGroup, std::string theAttrName) const;
121 /// Redefine this function in order to add additiona lines of constraint base
122 /// \param thePrs a presentation
123 /// \param theColor a color of additiona lines
124 virtual void drawLines(const Handle(Prs3d_Presentation)& thePrs, Quantity_Color theColor) const {}
126 /// Update myPntArray according to presentation positions
127 /// \return true in case of success
128 virtual bool updateIfReadyToDisplay(double theStep, bool withColor) const { return true; }
130 /// Draw a shape into the given presentation scene
131 /// \param theShape the shape to draw
132 /// \param thePrs the presentation scene
133 void drawShape(const std::shared_ptr<GeomAPI_Shape>& theShape,
134 const Handle(Prs3d_Presentation)& thePrs, Quantity_Color theColor) const;
136 /// Draw a list of shapes stored in a RefListAttribute
137 /// \param theListAttr the attribute of reference3s list
138 /// \param thePrs the presentation scene
139 void drawListOfShapes(const std::shared_ptr<ModelAPI_AttributeRefList>& theListAttr,
140 const Handle(Prs3d_Presentation)& thePrs, Quantity_Color theColor) const;
143 /// Constraint feature
144 ModelAPI_Feature* myConstraint;
146 /// Plane of the current sketcher
147 std::shared_ptr<GeomAPI_Ax3> myPlane;
149 /// Aspect for entities drawing
150 Handle(Graphic3d_AspectMarker3d) myAspect;
152 /// Array of symbols positions
153 mutable Handle(Graphic3d_ArrayOfPoints) myPntArray;
155 /// An owner object of the presentation
156 Handle(SelectMgr_EntityOwner) myOwner;
159 /// Static map to collect constraints icons {IconName : IconPixMap}
160 static std::map<const char*, Handle(Image_AlienPixMap)> myIconsMap;
162 Select3D_EntitySequence mySPoints;
164 bool myIsCustomColor; /// state if the presentation is visualized in custom color
165 Quantity_Color myCustomColor; /// the color of mid ring if there is a conflict
167 //bool myIsConflicting; /// state if the presentation is visualized in error state
168 Handle(Image_AlienPixMap) myErrorIcon;
169 Handle(Graphic3d_MarkerImage) myErrorImage;
171 friend class SketcherPrs_SymbolArray;