1 // Copyright (C) 2014-2019 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 email : webmaster.salome@opencascade.com
20 #ifndef SketcherPrs_SymbolPrs_H
21 #define SketcherPrs_SymbolPrs_H
23 #include "SketcherPrs_SensitivePoint.h"
24 #include <SketchPlugin_Sketch.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 SketchPlugin_Sketch* theSketcher);
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 Standard_EXPORT virtual void HilightOwnerWithColor(
68 const Handle(PrsMgr_PresentationManager3d)& thePM,
69 const Handle(Prs3d_Drawer)& theStyle,
70 const Handle(SelectMgr_EntityOwner)& theOwner);
72 /// Returns sketcher plane
73 Standard_EXPORT std::shared_ptr<GeomAPI_Ax3> plane() const { return mySketcher->coordinatePlane(); }
75 /// Returns feature object
76 Standard_EXPORT ModelAPI_Feature* feature() const { return myConstraint; }
78 /// Returns Sketcher object (owner of the constraint)
79 Standard_EXPORT ModelAPI_CompositeFeature* sketcher() const { return mySketcher; }
81 /// Return array of points where symbols will be placed
82 const Handle(Graphic3d_ArrayOfPoints)& pointsArray() const { return myPntArray; }
84 /// Set state of the presentation, in case of conflicting state, the icon of the presentation is
85 /// visualized in error color. The state is stored in an internal field, so should be changed
86 /// when constraint become not conflicting
87 /// \param theColor a color for conflicting object
88 Standard_EXPORT void SetCustomColor(const std::vector<int>& theColor);
90 /// Add a bounding box of the presentation to common bounding box
91 /// \param theBndBox the common bounding box to update
92 Standard_EXPORT virtual void BoundingBox (Bnd_Box& theBndBox) Standard_OVERRIDE;
94 DEFINE_STANDARD_RTTIEXT(SketcherPrs_SymbolPrs, AIS_InteractiveObject)
97 /// Redefinition of virtual function
98 Standard_EXPORT virtual void Compute(
99 const Handle(PrsMgr_PresentationManager3d)& thePresentationManager,
100 const Handle(Prs3d_Presentation)& thePresentation, const Standard_Integer theMode = 0);
102 /// Redefinition of virtual function
103 /// \param aSelection selection
104 /// \param aMode compute mode
105 Standard_EXPORT virtual void ComputeSelection(const Handle(SelectMgr_Selection)& aSelection,
106 const Standard_Integer aMode);
108 /// Returns an icon file name. Has to be redefined in successors
109 virtual const char* iconName() const = 0;
111 /// Check and creates if it is necessary myAspect member.
112 /// It has to be called before the object computation
113 virtual void prepareAspect();
115 /// Returns icon corresponded to the current constraint type
116 Handle(Image_AlienPixMap) icon();
118 /// Add a line into the given group
119 /// \param theGroup a group for drawing
120 /// \param theAttrName an attribute name which corresponds to referenced line
121 void addLine(const Handle(Graphic3d_Group)& theGroup, std::string theAttrName) const;
123 /// Redefine this function in order to add additiona lines of constraint base
124 /// \param thePrs a presentation
125 /// \param theColor a color of additiona lines
126 virtual void drawLines(const Handle(Prs3d_Presentation)& thePrs, Quantity_Color theColor) const {}
128 /// Update myPntArray according to presentation positions
129 /// \return true in case of success
130 virtual bool updateIfReadyToDisplay(double theStep, bool withColor) const { return true; }
132 /// Draw a shape into the given presentation scene
133 /// \param theShape the shape to draw
134 /// \param thePrs the presentation scene
135 void drawShape(const std::shared_ptr<GeomAPI_Shape>& theShape,
136 const Handle(Prs3d_Presentation)& thePrs, Quantity_Color theColor) const;
138 /// Draw a list of shapes stored in a RefListAttribute
139 /// \param theListAttr the attribute of reference3s list
140 /// \param thePrs the presentation scene
141 void drawListOfShapes(const std::shared_ptr<ModelAPI_AttributeRefList>& theListAttr,
142 const Handle(Prs3d_Presentation)& thePrs, Quantity_Color theColor) const;
145 /// Constraint feature
146 ModelAPI_Feature* myConstraint;
149 SketchPlugin_Sketch* mySketcher;
151 /// Aspect for entities drawing
152 Handle(Graphic3d_AspectMarker3d) myAspect;
154 /// Array of symbols positions
155 mutable Handle(Graphic3d_ArrayOfPoints) myPntArray;
157 /// An owner object of the presentation
158 Handle(SelectMgr_EntityOwner) myOwner;
161 /// Static map to collect constraints icons {IconName : IconPixMap}
162 static std::map<const char*, Handle(Image_AlienPixMap)> myIconsMap;
164 Select3D_EntitySequence mySPoints;
166 bool myIsCustomColor; /// state if the presentation is visualized in custom color
167 Quantity_Color myCustomColor; /// the color of mid ring if there is a conflict
169 //bool myIsConflicting; /// state if the presentation is visualized in error state
170 Handle(Image_AlienPixMap) myErrorIcon;
171 Handle(Graphic3d_MarkerImage) myErrorImage;
173 friend class SketcherPrs_SymbolArray;