1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: SketcherPrs_SymbolPrs.cpp
4 // Created: 12 March 2015
5 // Author: Vitaly SMETANNIKOV
7 #include "SketcherPrs_SymbolPrs.h"
8 #include "SketcherPrs_Tools.h"
9 #include "SketcherPrs_PositionMgr.h"
11 #include <GeomAPI_Edge.h>
12 #include <GeomAPI_Vertex.h>
13 #include <GeomAPI_Curve.h>
15 #include <Events_Error.h>
17 #include <Graphic3d_ArrayOfSegments.hxx>
18 #include <Graphic3d_BndBox4f.hxx>
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>
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>
46 /// Step between icons
47 static const double MyDist = 0.02;
49 /// Function to convert opengl data type
50 GLenum toGlDataType (const Graphic3d_TypeOfData theType, GLint& theNbComp)
53 case Graphic3d_TOD_USHORT:
55 return GL_UNSIGNED_SHORT;
56 case Graphic3d_TOD_UINT:
58 return GL_UNSIGNED_INT;
59 case Graphic3d_TOD_VEC2:
62 case Graphic3d_TOD_VEC3:
65 case Graphic3d_TOD_VEC4:
68 case Graphic3d_TOD_VEC4UB:
70 return GL_UNSIGNED_BYTE;
77 //*******************************************************************
78 //! Auxiliary class for Vertex buffer with interleaved attributes.
79 class SketcherPrs_VertexBuffer : public OpenGl_VertexBuffer
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)
92 memcpy (Attribs, theAttribs, sizeof(Graphic3d_Attribute) * NbAttributes);
95 //! Create uninitialized VBO.
96 SketcherPrs_VertexBuffer (const Graphic3d_Buffer& theAttribs)
97 : Stride (theAttribs.Stride), NbAttributes(1)
99 memcpy (Attribs, theAttribs.AttributesArray(), sizeof(Graphic3d_Attribute) * NbAttributes);
102 /// Returns True if color attribute is defined
103 virtual bool HasColorAttribute() const
105 for (Standard_Integer anAttribIter = 0; anAttribIter < NbAttributes; ++anAttribIter) {
106 const Graphic3d_Attribute& anAttrib = Attribs[anAttribIter];
107 if (anAttrib.Id == Graphic3d_TOA_COLOR) {
114 /// Returns True if normal attribute is defined
115 virtual bool HasNormalAttribute() const
117 for (Standard_Integer anAttribIter = 0; anAttribIter < NbAttributes; ++anAttribIter) {
118 const Graphic3d_Attribute& anAttrib = Attribs[anAttribIter];
119 if (anAttrib.Id == Graphic3d_TOA_NORM) {
126 /// Bind position of the attribute
127 /// \param theGlCtx OpenGl context
128 virtual void BindPositionAttribute (const Handle(OpenGl_Context)& theGlCtx) const
130 if (!OpenGl_VertexBuffer::IsValid()) {
134 OpenGl_VertexBuffer::Bind (theGlCtx);
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) {
142 } else if (anAttrib.Id == Graphic3d_TOA_POS) {
143 OpenGl_VertexBuffer::bindAttribute (theGlCtx, Graphic3d_TOA_POS, aNbComp, aDataType, Stride, anOffset);
147 anOffset += Graphic3d_Attribute::Stride (anAttrib.DataType);
151 /// Bind all attributes
152 /// \param theGlCtx OpenGl context
153 virtual void BindAllAttributes (const Handle(OpenGl_Context)& theGlCtx) const
155 if (!OpenGl_VertexBuffer::IsValid())
158 OpenGl_VertexBuffer::Bind (theGlCtx);
160 const GLubyte* anOffset = OpenGl_VertexBuffer::myOffset;
161 for (Standard_Integer anAttribIter = 0; anAttribIter < NbAttributes; ++anAttribIter)
163 const Graphic3d_Attribute& anAttrib = Attribs[anAttribIter];
164 const GLenum aDataType = toGlDataType (anAttrib.DataType, aNbComp);
165 if (aDataType == GL_NONE)
168 OpenGl_VertexBuffer::bindAttribute (theGlCtx, anAttrib.Id, aNbComp, aDataType, Stride, anOffset);
169 anOffset += Graphic3d_Attribute::Stride (anAttrib.DataType);
173 /// Unbind all attributes
174 /// \param theGlCtx OpenGl context
175 virtual void UnbindAllAttributes (const Handle(OpenGl_Context)& theGlCtx) const
177 if (!OpenGl_VertexBuffer::IsValid())
179 OpenGl_VertexBuffer::Unbind (theGlCtx);
181 for (Standard_Integer anAttribIter = 0; anAttribIter < NbAttributes; ++anAttribIter) {
182 const Graphic3d_Attribute& anAttrib = Attribs[anAttribIter];
183 OpenGl_VertexBuffer::unbindAttribute (theGlCtx, anAttrib.Id);
189 /// Array of attributes
190 Graphic3d_Attribute Attribs[1];
193 Standard_Integer Stride;
195 /// Number of attributes
196 Standard_Integer NbAttributes;
199 //**************************************************************
200 //! Redefinition of OpenGl_Element
201 class SketcherPrs_Element: public OpenGl_Element
205 /// \param theObj a presentation
206 SketcherPrs_Element(const Handle(SketcherPrs_SymbolPrs)& theObj) :
207 OpenGl_Element(), myObj(theObj) {}
209 /// Render the current presentation
210 /// \param theWorkspace OpenGL workspace
211 virtual void Render (const Handle(OpenGl_Workspace)& theWorkspace) const
214 myObj->Render(theWorkspace);
217 /// Releases OpenGL resources
218 /// \param theContext OpenGL context
219 virtual void Release (OpenGl_Context* theContext)
222 myObj->Release(theContext);
226 Handle(SketcherPrs_SymbolPrs) myObj;
230 //**************************************************************
231 //! Definition of call back
232 OpenGl_Element* SymbolPrsCallBack(const CALL_DEF_USERDRAW * theUserDraw)
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;
238 return new SketcherPrs_Element(anIObj);
242 //*****************************************************************************
243 IMPLEMENT_STANDARD_HANDLE(SketcherPrs_SymbolPrs, AIS_InteractiveObject);
244 IMPLEMENT_STANDARD_RTTIEXT(SketcherPrs_SymbolPrs, AIS_InteractiveObject);
247 std::map<const char*, Handle(Image_AlienPixMap)> SketcherPrs_SymbolPrs::myIconsMap;
250 SketcherPrs_SymbolPrs::SketcherPrs_SymbolPrs(ModelAPI_Feature* theConstraint,
251 const std::shared_ptr<GeomAPI_Ax3>& thePlane)
252 : AIS_InteractiveObject(), myConstraint(theConstraint), myPlane(thePlane), myIsConflicting(false)
254 SetAutoHilight(Standard_False);
255 myPntArray = new Graphic3d_ArrayOfPoints(1);
256 myPntArray->AddVertex(0., 0., 0.);
259 SketcherPrs_SymbolPrs::~SketcherPrs_SymbolPrs()
261 SketcherPrs_PositionMgr* aMgr = SketcherPrs_PositionMgr::get();
262 // Empty memory in position manager
263 aMgr->deleteConstraint(this);
267 #pragma warning( disable : 4996 )
270 Handle(Image_AlienPixMap) SketcherPrs_SymbolPrs::icon()
272 if (myIconsMap.count(iconName()) == 1) {
273 return myIconsMap[iconName()];
275 // Load icon for the presentation
276 char* aEnv = getenv("SHAPERResources");
278 TCollection_AsciiString aFile(aEnv);
281 Handle(Image_AlienPixMap) aPixMap = new Image_AlienPixMap();
282 if (aPixMap->Load(aFile)) {
283 myIconsMap[iconName()] = aPixMap;
287 // The icon for constraint is not found
288 static const char aMsg[] = "Error! constraint images are not found";
290 Events_Error::send(aMsg);
291 myIconsMap[iconName()] = Handle(Image_AlienPixMap)();
292 return Handle(Image_AlienPixMap)();
295 void SketcherPrs_SymbolPrs::prepareAspect()
297 // Create an aspect with the icon
298 if (myAspect.IsNull()) {
299 Handle(Image_AlienPixMap) aIcon = icon();
301 myAspect = new Graphic3d_AspectMarker3d();
303 myAspect = new Graphic3d_AspectMarker3d(aIcon);
307 void SketcherPrs_SymbolPrs::addLine(const Handle(Graphic3d_Group)& theGroup, std::string theAttrName) const
309 ObjectPtr aObj = SketcherPrs_Tools::getResult(myConstraint, theAttrName);
310 std::shared_ptr<GeomAPI_Shape> aLine = SketcherPrs_Tools::getShape(aObj);
311 if (aLine.get() == NULL)
313 std::shared_ptr<GeomAPI_Edge> aEdge = std::shared_ptr<GeomAPI_Edge>(new GeomAPI_Edge(aLine));
315 std::shared_ptr<GeomAPI_Pnt> aPnt1 = aEdge->firstPoint();
316 std::shared_ptr<GeomAPI_Pnt> aPnt2 = aEdge->lastPoint();
318 // Draw line by two points
319 Handle(Graphic3d_ArrayOfSegments) aLines = new Graphic3d_ArrayOfSegments(2, 1);
320 aLines->AddVertex(aPnt1->impl<gp_Pnt>());
321 aLines->AddVertex(aPnt2->impl<gp_Pnt>());
322 theGroup->AddPrimitiveArray(aLines);
325 void SketcherPrs_SymbolPrs::HilightSelected(const Handle(PrsMgr_PresentationManager3d)& thePM,
326 const SelectMgr_SequenceOfOwner& theOwners)
329 Handle( Prs3d_Presentation ) aSelectionPrs = GetSelectPresentation( thePM );
330 aSelectionPrs->Clear();
331 drawLines(aSelectionPrs, Quantity_NOC_WHITE);
333 aSelectionPrs->SetDisplayPriority(9);
334 aSelectionPrs->Display();
335 thePM->Highlight(this);
338 void SketcherPrs_SymbolPrs::HilightOwnerWithColor(const Handle(PrsMgr_PresentationManager3d)& thePM,
339 const Quantity_NameOfColor theColor,
340 const Handle(SelectMgr_EntityOwner)& theOwner)
342 thePM->Color(this, theColor);
344 Handle( Prs3d_Presentation ) aHilightPrs = GetHilightPresentation( thePM );
345 aHilightPrs->Clear();
346 drawLines(aHilightPrs, theColor);
348 if (thePM->IsImmediateModeOn())
349 thePM->AddToImmediateList(aHilightPrs);
352 void SketcherPrs_SymbolPrs::Compute(const Handle(PrsMgr_PresentationManager3d)& thePresentationManager,
353 const Handle(Prs3d_Presentation)& thePresentation,
354 const Standard_Integer theMode)
359 Handle(AIS_InteractiveContext) aCtx = GetContext();
360 Handle(OpenGl_GraphicDriver) aDriver = Handle(OpenGl_GraphicDriver)::DownCast(aCtx->CurrentViewer()->Driver());
361 if (!aDriver.IsNull()) {
362 // register the custom element factory function
363 aDriver->UserDrawCallback() = SymbolPrsCallBack;
366 // Update points with default shift value
367 // it updates array of points if the presentation is ready to display, or the array of points
368 // contains the previous values
370 bool aReadyToDisplay = updateIfReadyToDisplay(20);
372 int aNbVertex = myPntArray->VertexNumber();
373 if (myOwner.IsNull()) {
374 myOwner = new SelectMgr_EntityOwner(this);
377 // Create sensitive point for each symbol
379 for (int i = 1; i <= aNbVertex; i++) {
380 Handle(SketcherPrs_SensitivePoint) aSP = new SketcherPrs_SensitivePoint(myOwner, i);
381 mySPoints.Append(aSP);
384 Handle(Graphic3d_Group) aGroup = Prs3d_Root::NewGroup(thePresentation);
385 aGroup->SetPrimitivesAspect(myAspect);
387 // Recompute boundary box of the group
388 Graphic3d_BndBox4f& aBnd = aGroup->ChangeBoundingBox();
391 for (int i = 1; i <= myPntArray->ItemNumber(); i++) {
392 aVert = myPntArray->Vertice(i);
393 aBnd.Add (Graphic3d_Vec4((float)aVert.X(), (float)aVert.Y(), (float)aVert.Z(), 1.0f));
396 // Pint the group with custom procedure (see Render)
397 aGroup->UserDraw(this, true);
399 // Disable frustum culling for this object by marking it as mutable
400 aGroup->Structure()->SetMutable(true);
401 //aGroup->AddPrimitiveArray(myPntArray);
403 if (!aReadyToDisplay)
404 SketcherPrs_Tools::sendEmptyPresentationError(myConstraint,
405 "An empty AIS presentation: SketcherPrs_LengthDimension");
410 void SketcherPrs_SymbolPrs::ComputeSelection(const Handle(SelectMgr_Selection)& aSelection,
411 const Standard_Integer aMode)
414 if ((aMode == 0) || (aMode == SketcherPrs_Tools::Sel_Constraint)) {
415 for (int i = 1; i <= mySPoints.Length(); i++)
416 aSelection->Add(mySPoints.Value(i));
420 void SketcherPrs_SymbolPrs::SetConflictingConstraint(const bool& theConflicting,
421 const std::vector<int>& theColor)
425 if (!myAspect.IsNull())
426 myAspect->SetColor (Quantity_Color (theColor[0] / 255., theColor[1] / 255., theColor[2] / 255.,
428 myIsConflicting = true;
432 if (!myAspect.IsNull())
433 myAspect->SetColor (Quantity_Color (1.0, 1.0, 0.0, Quantity_TOC_RGB));
434 myIsConflicting = false;
438 void SketcherPrs_SymbolPrs::Render(const Handle(OpenGl_Workspace)& theWorkspace) const
440 // this method is a combination of OCCT OpenGL functions. The main purpose is to have
441 // equal distance from the source object to symbol indpendently of zoom.
442 // It is base on OCCT 6.9.1 and might need changes when using later OCCT versions.
443 // The specific SHAPER modifications are marked by ShaperModification:start/end, other is OCCT code
445 // do not update presentation for invalid or already removed objects: the presentation
446 // should be removed soon
447 if (!myConstraint->data().get() || !myConstraint->data()->isValid())
450 const OpenGl_AspectMarker* anAspectMarker = theWorkspace->AspectMarker(Standard_True);
451 const Handle(OpenGl_Context)& aCtx = theWorkspace->GetGlContext();
452 Handle(OpenGl_View) aView = theWorkspace->ActiveView();
454 // ShaperModification:start
455 double aScale = aView->Camera()->Scale();
456 // Update points coordinate taking the viewer scale into account
457 updateIfReadyToDisplay(MyDist * aScale);
459 // ShaperModification:end
461 Handle(Graphic3d_Buffer) aAttribs = myPntArray->Attributes();
463 if (myVboAttribs.IsNull()) {
464 myVboAttribs = new SketcherPrs_VertexBuffer(*aAttribs);
467 // Update drawing attributes
468 if (!myVboAttribs->init(aCtx, 0, aAttribs->NbElements, aAttribs->Data(), GL_NONE, aAttribs->Stride)) {
469 myVboAttribs->Release (aCtx.operator->());
470 myVboAttribs.Nullify();
474 Handle(OpenGl_Texture) aTextureBack = theWorkspace->DisableTexture();
476 const Handle(OpenGl_PointSprite)& aSpriteNorm = anAspectMarker->SpriteRes(aCtx);
478 if (!aSpriteNorm.IsNull() && !aSpriteNorm->IsDisplayList()) {
479 // ShaperModification:start : filling the presentation with color if there is a conflict
480 const bool toHilight = (theWorkspace->NamedStatus & OPENGL_NS_HIGHLIGHT) != 0 || myIsConflicting;
481 // ShaperModification:end
483 const Handle(OpenGl_PointSprite)& aSprite = (toHilight && anAspectMarker->SpriteHighlightRes(aCtx)->IsValid())
484 ? anAspectMarker->SpriteHighlightRes(aCtx)
486 theWorkspace->EnableTexture (aSprite);
487 aCtx->ShaderManager()->BindProgram(anAspectMarker, aSprite, Standard_False, Standard_False, anAspectMarker->ShaderProgramRes(aCtx));
488 const TEL_COLOUR* aLineColor = &anAspectMarker->Color();
489 if (theWorkspace->NamedStatus & OPENGL_NS_HIGHLIGHT)
490 aLineColor = theWorkspace->HighlightColor;
492 // Set lighting of the symbol
494 aCtx->core11fwd->glDisable (GL_LIGHTING);
496 aCtx->core11fwd->glEnable (GL_LIGHTING);
498 aCtx->SetColor4fv(*(const OpenGl_Vec4* )(aLineColor->rgb));
501 myVboAttribs->BindAllAttributes(aCtx);
502 // Textured markers will be drawn with the point sprites
503 aCtx->SetPointSize (anAspectMarker->MarkerSize());
504 aCtx->core11fwd->glEnable (GL_ALPHA_TEST);
505 aCtx->core11fwd->glAlphaFunc (GL_GEQUAL, 0.1f);
507 aCtx->core11fwd->glEnable (GL_BLEND);
508 aCtx->core11fwd->glBlendFunc (GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
510 aCtx->core11fwd->glDrawArrays (0, 0, myVboAttribs->GetElemsNb());
512 aCtx->core11fwd->glDisable (GL_BLEND);
513 aCtx->core11fwd->glDisable (GL_ALPHA_TEST);
514 aCtx->SetPointSize (1.0f);
516 theWorkspace->EnableTexture (aTextureBack);
517 aCtx->BindProgram (NULL);
519 // Update selection position only if there is no selected object
520 // because it can corrupt selection of other objects
521 if ((GetContext()->NbCurrents() == 0) && (GetContext()->NbSelected() == 0))
523 GetContext()->MainSelector()->RebuildSensitivesTree (this);
524 GetContext()->MainSelector()->RebuildObjectsTree (false);
529 void SketcherPrs_SymbolPrs::Release (OpenGl_Context* theContext)
531 // Release OpenGl resources
532 if (!myVboAttribs.IsNull()) {
534 theContext->DelayedRelease (myVboAttribs);
536 myVboAttribs.Nullify();
540 void SketcherPrs_SymbolPrs::drawShape(const std::shared_ptr<GeomAPI_Shape>& theShape,
541 const Handle(Prs3d_Presentation)& thePrs) const
543 if (theShape->isEdge()) {
545 std::shared_ptr<GeomAPI_Curve> aCurve =
546 std::shared_ptr<GeomAPI_Curve>(new GeomAPI_Curve(theShape));
547 if (aCurve->isLine()) {
549 GeomAdaptor_Curve aCurv(aCurve->impl<Handle(Geom_Curve)>(), aCurve->startParam(), aCurve->endParam());
550 StdPrs_Curve::Add(thePrs, aCurv, myDrawer);
552 // The shape is circle or arc
553 GeomAdaptor_Curve aAdaptor(aCurve->impl<Handle(Geom_Curve)>(), aCurve->startParam(), aCurve->endParam());
554 StdPrs_DeflectionCurve::Add(thePrs,aAdaptor,myDrawer);
556 } else if (theShape->isVertex()) {
558 std::shared_ptr<GeomAPI_Vertex> aVertex =
559 std::shared_ptr<GeomAPI_Vertex>(new GeomAPI_Vertex(theShape));
560 std::shared_ptr<GeomAPI_Pnt> aPnt = aVertex->point();
561 Handle(Geom_CartesianPoint) aPoint = new Geom_CartesianPoint(aPnt->impl<gp_Pnt>());
562 StdPrs_Point::Add(thePrs, aPoint, myDrawer);
566 void SketcherPrs_SymbolPrs::drawListOfShapes(const std::shared_ptr<ModelAPI_AttributeRefList>& theListAttr,
567 const Handle(Prs3d_Presentation)& thePrs) const
569 int aNb = theListAttr->size();
574 for (i = 0; i < aNb; i++) {
575 aObj = theListAttr->object(i);
576 std::shared_ptr<GeomAPI_Shape> aShape = SketcherPrs_Tools::getShape(aObj);
577 if (aShape.get() != NULL)
578 drawShape(aShape, thePrs);
582 void SketcherPrs_SymbolPrs::BoundingBox (Bnd_Box& theBndBox)
584 Select3D_BndBox3d aTmpBox;
585 for (Select3D_EntitySequenceIter aPntIter (mySPoints); aPntIter.More(); aPntIter.Next()) {
586 const Handle(Select3D_SensitiveEntity)& anEnt = aPntIter.Value();
587 aTmpBox.Combine (anEnt->BoundingBox());
590 theBndBox.Update (aTmpBox.CornerMin().x(), aTmpBox.CornerMin().y(), aTmpBox.CornerMin().z(),
591 aTmpBox.CornerMax().x(), aTmpBox.CornerMax().y(), aTmpBox.CornerMax().z());