1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: SketcherPrs_SymbolPrs.h
4 // Created: 12 March 2015
5 // Author: Vitaly SMETANNIKOV
7 #ifndef SketcherPrs_SymbolPrs_H
8 #define SketcherPrs_SymbolPrs_H
10 #include "SketcherPrs_SensitivePoint.h"
11 #include <ModelAPI_Feature.h>
12 #include <ModelAPI_AttributeRefList.h>
14 #include <AIS_InteractiveObject.hxx>
15 #include <GeomAPI_Ax3.h>
16 #include <Graphic3d_ArrayOfPoints.hxx>
17 #include <Graphic3d_AspectMarker3d.hxx>
18 #include <Image_AlienPixMap.hxx>
19 #include <SelectMgr_EntityOwner.hxx>
20 #include <Select3D_EntitySequence.hxx>
22 #include <Standard_DefineHandle.hxx>
25 #include <OpenGl_Workspace.hxx>
30 DEFINE_STANDARD_HANDLE(SketcherPrs_SymbolPrs, AIS_InteractiveObject)
34 * A base class of constraint presentation which is represented by an icon
36 class SketcherPrs_SymbolPrs: public AIS_InteractiveObject
40 /// \param theConstraint a constraint feature
41 /// \param thePlane a coordinate plane of current sketch
42 Standard_EXPORT SketcherPrs_SymbolPrs(ModelAPI_Feature* theConstraint,
43 const std::shared_ptr<GeomAPI_Ax3>& thePlane);
45 virtual ~SketcherPrs_SymbolPrs();
47 //! Method which draws selected owners ( for fast presentation draw )
48 Standard_EXPORT virtual void HilightSelected(const Handle(PrsMgr_PresentationManager3d)& thePM,
49 const SelectMgr_SequenceOfOwner& theOwners);
51 //! Method which hilight an owner belonging to
52 //! this selectable object ( for fast presentation draw )
53 Standard_EXPORT virtual void HilightOwnerWithColor(const Handle(PrsMgr_PresentationManager3d)& thePM,
54 const Quantity_NameOfColor theColor, const Handle(SelectMgr_EntityOwner)& theOwner);
56 /// Returns sketcher plane
57 Standard_EXPORT std::shared_ptr<GeomAPI_Ax3> plane() const { return myPlane; }
59 /// Returns feature object
60 Standard_EXPORT ModelAPI_Feature* feature() const { return myConstraint; }
62 /// Return array of points where symbols will be placed
63 const Handle(Graphic3d_ArrayOfPoints)& pointsArray() const { return myPntArray; }
65 /// Set state of the presentation, in case of conflicting state, the icon of the presentation is
66 /// visualized in error color. The state is stored in an internal field, so should be changed when
67 /// constraint become not conflicting
68 /// \param theConflicting a state
69 Standard_EXPORT void SetConflictingConstraint(const bool& theConflicting);
71 /// Render of the presentation
72 /// \param theWorkspace is OpenGl workspace
73 void Render(const Handle(OpenGl_Workspace)& theWorkspace) const;
75 /// Release used OpenGl resources
76 /// \param theContext is an OpenGL context
77 void Release (OpenGl_Context* theContext);
79 /// Add a bounding box of the presentation to common bounding box
80 /// \param theBndBox the common bounding box to update
81 Standard_EXPORT virtual void BoundingBox (Bnd_Box& theBndBox) Standard_OVERRIDE;
83 DEFINE_STANDARD_RTTI(SketcherPrs_SymbolPrs)
86 /// Redefinition of virtual function
87 Standard_EXPORT virtual void Compute(const Handle(PrsMgr_PresentationManager3d)& thePresentationManager,
88 const Handle(Prs3d_Presentation)& thePresentation, const Standard_Integer theMode = 0);
90 /// Redefinition of virtual function
91 /// \param aSelection selection
92 /// \param aMode compute mode
93 Standard_EXPORT virtual void ComputeSelection(const Handle(SelectMgr_Selection)& aSelection,
94 const Standard_Integer aMode);
96 /// Returns an icon file name. Has to be redefined in successors
97 virtual const char* iconName() const = 0;
99 /// Check and creates if it is necessary myAspect member.
100 /// It has to be called before the object computation
101 virtual void prepareAspect();
103 /// Returns icon corresponded to the current constraint type
104 Handle(Image_AlienPixMap) icon();
106 /// Add a line into the given group
107 /// \param theGroup a group for drawing
108 /// \param theAttrName an attribute name which corresponds to referenced line
109 void addLine(const Handle(Graphic3d_Group)& theGroup, std::string theAttrName) const;
111 /// Redefine this function in order to add additiona lines of constraint base
112 /// \param thePrs a presentation
113 /// \param theColor a color of additiona lines
114 virtual void drawLines(const Handle(Prs3d_Presentation)& thePrs, Quantity_Color theColor) const {}
116 /// Update myPntArray according to presentation positions
117 /// \return true in case of success
118 virtual bool updatePoints(double theStep) const { return true; }
120 /// Draw a shape into the given presentation scene
121 /// \param theShape the shape to draw
122 /// \param thePrs the presentation scene
123 void drawShape(const std::shared_ptr<GeomAPI_Shape>& theShape,
124 const Handle(Prs3d_Presentation)& thePrs) const;
126 /// Draw a list of shapes stored in a RefListAttribute
127 /// \param theListAttr the attribute of reference3s list
128 /// \param thePrs the presentation scene
129 void drawListOfShapes(const std::shared_ptr<ModelAPI_AttributeRefList>& theListAttr,
130 const Handle(Prs3d_Presentation)& thePrs) const;
133 /// Constraint feature
134 ModelAPI_Feature* myConstraint;
136 /// Plane of the current sketcher
137 std::shared_ptr<GeomAPI_Ax3> myPlane;
139 /// Aspect for entities drawing
140 Handle(Graphic3d_AspectMarker3d) myAspect;
142 /// Array of symbols positions
143 mutable Handle(Graphic3d_ArrayOfPoints) myPntArray;
145 /// An owner object of the presentation
146 Handle(SelectMgr_EntityOwner) myOwner;
149 /// Static map to collect constraints icons {IconName : IconPixMap}
150 static std::map<const char*, Handle(Image_AlienPixMap)> myIconsMap;
152 mutable Handle(OpenGl_VertexBuffer) myVboAttribs;
154 Select3D_EntitySequence mySPoints;
156 bool myIsConflicting; /// state if the presentation is visualized in error state
157 Handle(Image_AlienPixMap) myErrorIcon;
158 Handle(Graphic3d_MarkerImage) myErrorImage;