Salome HOME
05fa43cf8568c5be037329cb89f4d03e00ed9a31
[modules/shaper.git] / src / SketcherPrs / SketcherPrs_SymbolPrs.cpp
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
2
3 // File:        SketcherPrs_SymbolPrs.cpp
4 // Created:     12 March 2015
5 // Author:      Vitaly SMETANNIKOV
6
7 #include "SketcherPrs_SymbolPrs.h"
8 #include "SketcherPrs_Tools.h"
9 #include "SketcherPrs_PositionMgr.h"
10
11 #include <GeomAPI_Edge.h>
12 #include <GeomAPI_Vertex.h>
13 #include <GeomAPI_Curve.h>
14
15 #include <Events_Error.h>
16
17 #include <Graphic3d_ArrayOfSegments.hxx>
18 #include <Graphic3d_BndBox4f.hxx>
19
20 #include <SelectMgr_Selection.hxx>
21 #include <Select3D_SensitivePoint.hxx>
22 #include <TopLoc_Location.hxx>
23 #include <AIS_InteractiveContext.hxx>
24 #include <V3d_Viewer.hxx>
25 #include <Prs3d_Root.hxx>
26 #include <Geom_CartesianPoint.hxx>
27 #include <GeomAdaptor_Curve.hxx>
28 #include <StdPrs_DeflectionCurve.hxx>
29 #include <StdPrs_Point.hxx>
30 #include <StdPrs_Curve.hxx>
31
32 #include <OpenGl_Element.hxx>
33 #include <OpenGl_GraphicDriver.hxx>
34 #include <OpenGl_Context.hxx>
35 #include <OpenGl_View.hxx>
36 #include <OpenGl_PointSprite.hxx>
37 #include <OpenGl_VertexBuffer.hxx>
38 #include <OpenGl_ShaderManager.hxx>
39
40 #ifdef WIN32
41 # define FSEP "\\"
42 #else
43 # define FSEP "/"
44 #endif
45
46 /// Step between icons
47 static const double MyDist = 0.02;
48
49 /// Function to convert opengl data type
50 GLenum toGlDataType (const Graphic3d_TypeOfData theType, GLint& theNbComp)
51 {
52   switch (theType) {
53     case Graphic3d_TOD_USHORT:
54       theNbComp = 1;
55       return GL_UNSIGNED_SHORT;
56     case Graphic3d_TOD_UINT:
57       theNbComp = 1;
58       return GL_UNSIGNED_INT;
59     case Graphic3d_TOD_VEC2:
60       theNbComp = 2;
61       return GL_FLOAT;
62     case Graphic3d_TOD_VEC3:
63       theNbComp = 3;
64       return GL_FLOAT;
65     case Graphic3d_TOD_VEC4:
66       theNbComp = 4;
67       return GL_FLOAT;
68     case Graphic3d_TOD_VEC4UB:
69       theNbComp = 4;
70       return GL_UNSIGNED_BYTE;
71   }
72   theNbComp = 0;
73   return GL_NONE;
74 }
75
76
77 //*******************************************************************
78 //! Auxiliary class for Vertex buffer with interleaved attributes.
79 class SketcherPrs_VertexBuffer : public OpenGl_VertexBuffer
80 {
81
82 public:
83
84   //! Create uninitialized VBO..
85   //! \param theAttribs attributes
86   //! \param theStride a flag
87   SketcherPrs_VertexBuffer (const Graphic3d_Attribute* theAttribs,
88                         const Standard_Integer     theStride)
89   : Stride (theStride), NbAttributes(1)
90   {
91
92     memcpy (Attribs, theAttribs, sizeof(Graphic3d_Attribute) * NbAttributes);
93   }
94
95   //! Create uninitialized VBO.
96   SketcherPrs_VertexBuffer (const Graphic3d_Buffer& theAttribs)
97   : Stride (theAttribs.Stride), NbAttributes(1)
98   {
99     memcpy (Attribs, theAttribs.AttributesArray(), sizeof(Graphic3d_Attribute) * NbAttributes);
100   }
101
102   /// Returns True if color attribute is defined
103   virtual bool HasColorAttribute() const
104   {
105     for (Standard_Integer anAttribIter = 0; anAttribIter < NbAttributes; ++anAttribIter) {
106       const Graphic3d_Attribute& anAttrib = Attribs[anAttribIter];
107       if (anAttrib.Id == Graphic3d_TOA_COLOR) {
108         return true;
109       }
110     }
111     return false;
112   }
113
114   /// Returns True if normal attribute is defined
115   virtual bool HasNormalAttribute() const
116   {
117     for (Standard_Integer anAttribIter = 0; anAttribIter < NbAttributes; ++anAttribIter) {
118       const Graphic3d_Attribute& anAttrib = Attribs[anAttribIter];
119       if (anAttrib.Id == Graphic3d_TOA_NORM) {
120         return true;
121       }
122     }
123     return false;
124   }
125
126   /// Bind position of the attribute
127   /// \param theGlCtx OpenGl context
128   virtual void BindPositionAttribute (const Handle(OpenGl_Context)& theGlCtx) const
129   {
130     if (!OpenGl_VertexBuffer::IsValid()) {
131       return;
132     }
133
134     OpenGl_VertexBuffer::Bind (theGlCtx);
135     GLint aNbComp;
136     const GLubyte* anOffset = OpenGl_VertexBuffer::myOffset;
137     for (Standard_Integer anAttribIter = 0; anAttribIter < NbAttributes; ++anAttribIter) {
138       const Graphic3d_Attribute& anAttrib = Attribs[anAttribIter];
139       const GLenum   aDataType = toGlDataType (anAttrib.DataType, aNbComp);
140       if (aDataType == GL_NONE) {
141         continue;
142       } else if (anAttrib.Id == Graphic3d_TOA_POS) {
143         OpenGl_VertexBuffer::bindAttribute (theGlCtx, Graphic3d_TOA_POS, aNbComp, aDataType, Stride, anOffset);
144         break;
145       }
146
147       anOffset += Graphic3d_Attribute::Stride (anAttrib.DataType);
148     }
149   }
150
151   /// Bind all attributes
152   /// \param theGlCtx OpenGl context
153   virtual void BindAllAttributes (const Handle(OpenGl_Context)& theGlCtx) const
154   {
155     if (!OpenGl_VertexBuffer::IsValid())
156       return;
157
158     OpenGl_VertexBuffer::Bind (theGlCtx);
159     GLint aNbComp;
160     const GLubyte* anOffset = OpenGl_VertexBuffer::myOffset;
161     for (Standard_Integer anAttribIter = 0; anAttribIter < NbAttributes; ++anAttribIter)
162     {
163       const Graphic3d_Attribute& anAttrib = Attribs[anAttribIter];
164       const GLenum   aDataType = toGlDataType (anAttrib.DataType, aNbComp);
165       if (aDataType == GL_NONE)
166         continue;
167
168       OpenGl_VertexBuffer::bindAttribute (theGlCtx, anAttrib.Id, aNbComp, aDataType, Stride, anOffset);
169       anOffset += Graphic3d_Attribute::Stride (anAttrib.DataType);
170     }
171   }
172
173   /// Unbind all attributes
174   /// \param theGlCtx OpenGl context
175   virtual void UnbindAllAttributes (const Handle(OpenGl_Context)& theGlCtx) const
176   {
177     if (!OpenGl_VertexBuffer::IsValid())
178       return;
179     OpenGl_VertexBuffer::Unbind (theGlCtx);
180
181     for (Standard_Integer anAttribIter = 0; anAttribIter < NbAttributes; ++anAttribIter) {
182       const Graphic3d_Attribute& anAttrib = Attribs[anAttribIter];
183       OpenGl_VertexBuffer::unbindAttribute (theGlCtx, anAttrib.Id);
184     }
185   }
186
187 public:
188
189   /// Array of attributes
190   Graphic3d_Attribute Attribs[1];
191
192   /// A flag
193   Standard_Integer    Stride;
194
195   /// Number of attributes
196   Standard_Integer NbAttributes;
197 };
198
199 //**************************************************************
200 //! Redefinition of OpenGl_Element
201 class SketcherPrs_Element: public OpenGl_Element
202 {
203 public:
204   /// Constructor
205   /// \param theObj a presentation
206   SketcherPrs_Element(const Handle(SketcherPrs_SymbolPrs)& theObj) : 
207   OpenGl_Element(), myObj(theObj) {}
208
209   /// Render the current presentation
210   /// \param theWorkspace OpenGL workspace
211   virtual void Render (const Handle(OpenGl_Workspace)& theWorkspace) const
212   {
213     if (!myObj.IsNull())
214       myObj->Render(theWorkspace);
215   }
216
217   /// Releases OpenGL resources
218   /// \param theContext OpenGL context
219   virtual void Release (OpenGl_Context* theContext) 
220   {
221     if (!myObj.IsNull())
222       myObj->Release(theContext);
223   }
224
225 private:
226   Handle(SketcherPrs_SymbolPrs) myObj;
227 };
228
229
230 //**************************************************************
231 //! Definition of call back
232 OpenGl_Element* SymbolPrsCallBack(const CALL_DEF_USERDRAW * theUserDraw)
233 {
234   Handle(SketcherPrs_SymbolPrs) anIObj = (SketcherPrs_SymbolPrs*)theUserDraw->Data;
235   if (anIObj.IsNull()) {
236     std::cout << "VUserDrawCallback error: null object passed, the custom scene element will not be rendered" << std::endl;
237   }
238   return new SketcherPrs_Element(anIObj);
239 }
240
241
242 //*****************************************************************************
243 IMPLEMENT_STANDARD_HANDLE(SketcherPrs_SymbolPrs, AIS_InteractiveObject);
244 IMPLEMENT_STANDARD_RTTIEXT(SketcherPrs_SymbolPrs, AIS_InteractiveObject);
245
246
247 std::map<const char*, Handle(Image_AlienPixMap)> SketcherPrs_SymbolPrs::myIconsMap;
248
249
250 SketcherPrs_SymbolPrs::SketcherPrs_SymbolPrs(ModelAPI_Feature* theConstraint, 
251                                              const std::shared_ptr<GeomAPI_Ax3>& thePlane)
252  : AIS_InteractiveObject(), myConstraint(theConstraint), myPlane(thePlane)
253 {
254   SetAutoHilight(Standard_False);
255 }
256
257 SketcherPrs_SymbolPrs::~SketcherPrs_SymbolPrs()
258 {
259   SketcherPrs_PositionMgr* aMgr = SketcherPrs_PositionMgr::get();
260   aMgr->deleteConstraint(this);
261 }
262
263 #ifdef _WINDOWS
264 #pragma warning( disable : 4996 )
265 #endif
266
267 Handle(Image_AlienPixMap) SketcherPrs_SymbolPrs::icon()
268 {
269   if (myIconsMap.count(iconName()) == 1) {
270     return myIconsMap[iconName()];
271   }
272   char* aEnv = getenv("NEWGEOM_ROOT_DIR");
273   if (aEnv != NULL) {
274     TCollection_AsciiString aFile(aEnv);
275     aFile+=FSEP;
276     aFile+="resources";
277     aFile += FSEP;
278     aFile += iconName();
279     Handle(Image_AlienPixMap) aPixMap = new Image_AlienPixMap();
280     if (aPixMap->Load(aFile)) {
281       myIconsMap[iconName()] = aPixMap;
282       return aPixMap;
283     }
284   }
285   static const char aMsg[] = "Error! constraint images are not found";
286   cout<<aMsg<<endl;
287   Events_Error::send(aMsg);
288   myIconsMap[iconName()] = Handle(Image_AlienPixMap)();
289   return Handle(Image_AlienPixMap)();
290 }
291
292 void SketcherPrs_SymbolPrs::prepareAspect()
293 {
294   if (myAspect.IsNull()) {
295     Handle(Image_AlienPixMap) aIcon = icon();
296     if (aIcon.IsNull()) 
297       myAspect = new Graphic3d_AspectMarker3d();
298     else
299       myAspect = new Graphic3d_AspectMarker3d(aIcon);
300   }
301 }
302
303 void SketcherPrs_SymbolPrs::addLine(const Handle(Graphic3d_Group)& theGroup, std::string theAttrName) const
304 {
305   ObjectPtr aObj = SketcherPrs_Tools::getResult(myConstraint, theAttrName);
306   std::shared_ptr<GeomAPI_Shape> aLine = SketcherPrs_Tools::getShape(aObj);
307   if (aLine.get() == NULL)
308     return;
309   std::shared_ptr<GeomAPI_Edge> aEdge = std::shared_ptr<GeomAPI_Edge>(new GeomAPI_Edge(aLine));
310
311   std::shared_ptr<GeomAPI_Pnt> aPnt1 = aEdge->firstPoint();
312   std::shared_ptr<GeomAPI_Pnt> aPnt2 = aEdge->lastPoint();
313
314   Handle(Graphic3d_ArrayOfSegments) aLines = new Graphic3d_ArrayOfSegments(2, 1);
315   aLines->AddVertex(aPnt1->impl<gp_Pnt>());
316   aLines->AddVertex(aPnt2->impl<gp_Pnt>());
317   theGroup->AddPrimitiveArray(aLines);
318 }
319
320 void SketcherPrs_SymbolPrs::HilightSelected(const Handle(PrsMgr_PresentationManager3d)& thePM, 
321                                            const SelectMgr_SequenceOfOwner& theOwners)
322 {
323
324   Handle( Prs3d_Presentation ) aSelectionPrs = GetSelectPresentation( thePM );
325   aSelectionPrs->Clear();
326   drawLines(aSelectionPrs, Quantity_NOC_WHITE);
327
328   aSelectionPrs->SetDisplayPriority(9);
329   aSelectionPrs->Display();
330   thePM->Highlight(this);
331 }
332
333 void SketcherPrs_SymbolPrs::HilightOwnerWithColor(const Handle(PrsMgr_PresentationManager3d)& thePM, 
334                                                  const Quantity_NameOfColor theColor, 
335                                                  const Handle(SelectMgr_EntityOwner)& theOwner)
336 {
337   thePM->Color(this, theColor);
338
339   Handle( Prs3d_Presentation ) aHilightPrs = GetHilightPresentation( thePM );
340   aHilightPrs->Clear();
341   drawLines(aHilightPrs, theColor);
342
343   if (thePM->IsImmediateModeOn())
344     thePM->AddToImmediateList(aHilightPrs);
345 }
346
347 void SketcherPrs_SymbolPrs::Compute(const Handle(PrsMgr_PresentationManager3d)& thePresentationManager,
348                                    const Handle(Prs3d_Presentation)& thePresentation, 
349                                    const Standard_Integer theMode)
350 {
351   prepareAspect();
352
353   Handle(AIS_InteractiveContext) aCtx = GetContext();
354   Handle(OpenGl_GraphicDriver) aDriver = Handle(OpenGl_GraphicDriver)::DownCast(aCtx->CurrentViewer()->Driver());
355   if (!aDriver.IsNull()) {
356     // register the custom element factory function
357     aDriver->UserDrawCallback() = SymbolPrsCallBack;
358   }
359
360   if (!updatePoints(20)) {
361     return;
362   }
363
364   int aNbVertex = myPntArray->VertexNumber();
365   if (myOwner.IsNull()) {
366     myOwner = new SelectMgr_EntityOwner(this);
367   }
368
369   mySPoints.Clear();
370   for (int i = 1; i <= aNbVertex; i++) {
371     Handle(SketcherPrs_SensitivePoint) aSP = new SketcherPrs_SensitivePoint(myOwner, i);
372     mySPoints.Append(aSP);
373   }
374
375   Handle(Graphic3d_Group) aGroup = Prs3d_Root::NewGroup(thePresentation);
376   aGroup->SetPrimitivesAspect(myAspect);
377
378   Graphic3d_BndBox4f& aBnd = aGroup->ChangeBoundingBox();
379   gp_Pnt aVert;
380   aBnd.Clear();
381   for (int i = 1; i <= myPntArray->ItemNumber(); i++) {
382     aVert = myPntArray->Vertice(i);
383     aBnd.Add (Graphic3d_Vec4((float)aVert.X(), (float)aVert.Y(), (float)aVert.Z(), 1.0f));
384   }
385
386   aGroup->UserDraw(this, true);
387
388   // Disable frustum culling for this object by marking it as mutable
389   aGroup->Structure()->SetMutable(true);
390   //aGroup->AddPrimitiveArray(myPntArray);
391 }
392
393
394
395 void SketcherPrs_SymbolPrs::ComputeSelection(const Handle(SelectMgr_Selection)& aSelection,
396                                             const Standard_Integer aMode)
397 {
398   ClearSelected();
399   if ((aMode == 0) || (aMode == SketcherPrs_Tools::Sel_Constraint)) {
400     for (int i = 1; i <= mySPoints.Length(); i++)
401       aSelection->Add(mySPoints.Value(i));
402   }
403 }
404
405
406 void SketcherPrs_SymbolPrs::Render(const Handle(OpenGl_Workspace)& theWorkspace) const
407 {
408   // do not update presentation for invalid or already removed objects: the presentation
409   // should be removed soon
410   if (!myConstraint->data().get() || !myConstraint->data()->isValid())
411     return;
412
413   const OpenGl_AspectMarker* anAspectMarker = theWorkspace->AspectMarker(Standard_True);
414   const Handle(OpenGl_Context)& aCtx = theWorkspace->GetGlContext();
415   Handle(OpenGl_View) aView = theWorkspace->ActiveView();
416   
417   double aScale = aView->Camera()->Scale();
418   if (!updatePoints(MyDist * aScale))
419     return;
420
421   Handle(Graphic3d_Buffer) aAttribs = myPntArray->Attributes();
422
423   if (myVboAttribs.IsNull()) {
424     myVboAttribs = new SketcherPrs_VertexBuffer(*aAttribs);
425   }
426
427   if (!myVboAttribs->init(aCtx, 0, aAttribs->NbElements, aAttribs->Data(), GL_NONE, aAttribs->Stride)) {
428     myVboAttribs->Release (aCtx.operator->());
429     myVboAttribs.Nullify();
430     return;
431   }
432     
433   Handle(OpenGl_Texture) aTextureBack = theWorkspace->DisableTexture();
434
435   const Handle(OpenGl_PointSprite)& aSpriteNorm = anAspectMarker->SpriteRes(aCtx);
436       
437   if (!aSpriteNorm.IsNull() && !aSpriteNorm->IsDisplayList()) {
438     const bool toHilight = (theWorkspace->NamedStatus & OPENGL_NS_HIGHLIGHT) != 0;
439     const Handle(OpenGl_PointSprite)& aSprite = (toHilight && anAspectMarker->SpriteHighlightRes(aCtx)->IsValid())
440                                               ? anAspectMarker->SpriteHighlightRes(aCtx)
441                                               : aSpriteNorm;
442     theWorkspace->EnableTexture (aSprite);
443     aCtx->ShaderManager()->BindProgram(anAspectMarker, aSprite, Standard_False, Standard_False, anAspectMarker->ShaderProgramRes(aCtx));
444     const TEL_COLOUR* aLineColor  =  &anAspectMarker->Color();
445     if (theWorkspace->NamedStatus & OPENGL_NS_HIGHLIGHT)
446       aLineColor = theWorkspace->HighlightColor;
447
448     if (toHilight)
449       aCtx->core11fwd->glDisable (GL_LIGHTING);
450     else
451       aCtx->core11fwd->glEnable (GL_LIGHTING);
452
453     aCtx->SetColor4fv(*(const OpenGl_Vec4* )(aLineColor->rgb));
454
455
456     myVboAttribs->BindAllAttributes(aCtx);
457     // Textured markers will be drawn with the point sprites
458     aCtx->SetPointSize (anAspectMarker->MarkerSize());
459     aCtx->core11fwd->glEnable (GL_ALPHA_TEST);
460     aCtx->core11fwd->glAlphaFunc (GL_GEQUAL, 0.1f);
461
462     aCtx->core11fwd->glEnable (GL_BLEND);
463     aCtx->core11fwd->glBlendFunc (GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
464
465     aCtx->core11fwd->glDrawArrays (0, 0, myVboAttribs->GetElemsNb());
466
467     aCtx->core11fwd->glDisable (GL_BLEND);
468     aCtx->core11fwd->glDisable (GL_ALPHA_TEST);
469     aCtx->SetPointSize (1.0f);
470   }
471   theWorkspace->EnableTexture (aTextureBack);
472   aCtx->BindProgram (NULL);
473
474   // Update selection position only if there is no selected object
475   // because it can corrupt selection of other objects
476   if ((GetContext()->NbCurrents() == 0) && (GetContext()->NbSelected() == 0))
477   {
478     GetContext()->MainSelector()->RebuildSensitivesTree (this);
479     GetContext()->MainSelector()->RebuildObjectsTree (false);
480   }
481 }
482
483
484 void SketcherPrs_SymbolPrs::Release (OpenGl_Context* theContext)
485 {
486   if (!myVboAttribs.IsNull()) {
487     if (theContext) {
488       theContext->DelayedRelease (myVboAttribs);
489     }
490     myVboAttribs.Nullify();
491   }
492 }
493
494 void SketcherPrs_SymbolPrs::drawShape(const std::shared_ptr<GeomAPI_Shape>& theShape, 
495                                       const Handle(Prs3d_Presentation)& thePrs) const
496 {
497   if (theShape->isEdge()) {
498     std::shared_ptr<GeomAPI_Curve> aCurve = 
499       std::shared_ptr<GeomAPI_Curve>(new GeomAPI_Curve(theShape));
500     if (aCurve->isLine()) {
501       GeomAdaptor_Curve aCurv(aCurve->impl<Handle(Geom_Curve)>(), aCurve->startParam(), aCurve->endParam());
502       StdPrs_Curve::Add(thePrs, aCurv, myDrawer);
503     } else {
504       GeomAdaptor_Curve aAdaptor(aCurve->impl<Handle(Geom_Curve)>(), aCurve->startParam(), aCurve->endParam());
505       StdPrs_DeflectionCurve::Add(thePrs,aAdaptor,myDrawer);
506     }
507   } else if (theShape->isVertex()) {
508     std::shared_ptr<GeomAPI_Vertex> aVertex = 
509       std::shared_ptr<GeomAPI_Vertex>(new GeomAPI_Vertex(theShape));
510     std::shared_ptr<GeomAPI_Pnt> aPnt = aVertex->point();
511     Handle(Geom_CartesianPoint) aPoint = new Geom_CartesianPoint(aPnt->impl<gp_Pnt>());
512     StdPrs_Point::Add(thePrs, aPoint, myDrawer);
513   }
514 }
515
516 void SketcherPrs_SymbolPrs::drawListOfShapes(const std::shared_ptr<ModelAPI_AttributeRefList>& theListAttr, 
517                                              const Handle(Prs3d_Presentation)& thePrs) const
518 {
519   int aNb = theListAttr->size();
520   if (aNb == 0)
521     return;
522   int i;
523   ObjectPtr aObj;
524   for (i = 0; i < aNb; i++) {
525     aObj = theListAttr->object(i);
526     std::shared_ptr<GeomAPI_Shape> aShape = SketcherPrs_Tools::getShape(aObj);
527     if (aShape.get() != NULL)
528       drawShape(aShape, thePrs);
529   }
530 }
531
532 void SketcherPrs_SymbolPrs::BoundingBox (Bnd_Box& theBndBox)
533 {
534   Select3D_BndBox3d aTmpBox;
535   for (Select3D_EntitySequenceIter aPntIter (mySPoints); aPntIter.More(); aPntIter.Next())
536   {
537     const Handle(Select3D_SensitiveEntity)& anEnt = aPntIter.Value();
538     aTmpBox.Combine (anEnt->BoundingBox());
539   }
540
541   theBndBox.Update (aTmpBox.CornerMin().x(), aTmpBox.CornerMin().y(), aTmpBox.CornerMin().z(),
542                     aTmpBox.CornerMax().x(), aTmpBox.CornerMax().y(), aTmpBox.CornerMax().z());
543 }
544