Salome HOME
Documentation of the sources
[modules/shaper.git] / src / SketcherPrs / SketcherPrs_SymbolPrs.cpp
index b4e646709886c7f327bb81be9f1a16afe0d7c578..b66ecbd035211b72fca1adfb8ef989cb2e022c7f 100644 (file)
 #include <GeomAPI_Vertex.h>
 #include <GeomAPI_Curve.h>
 
+#include <Events_Error.h>
+
 #include <Graphic3d_ArrayOfSegments.hxx>
 #include <Graphic3d_BndBox4f.hxx>
 
 #include <SelectMgr_Selection.hxx>
-#include <SelectMgr_SelectionManager.hxx>
 #include <Select3D_SensitivePoint.hxx>
 #include <TopLoc_Location.hxx>
 #include <AIS_InteractiveContext.hxx>
@@ -35,8 +36,6 @@
 #include <OpenGl_PointSprite.hxx>
 #include <OpenGl_VertexBuffer.hxx>
 #include <OpenGl_ShaderManager.hxx>
-#include <OpenGl_VertexBufferCompat.hxx>
-#include <OpenGl_GraphicDriver.hxx>
 
 #ifdef WIN32
 # define FSEP "\\"
@@ -83,6 +82,8 @@ class SketcherPrs_VertexBuffer : public OpenGl_VertexBuffer
 public:
 
   //! Create uninitialized VBO..
+  //! \param theAttribs attributes
+  //! \param theStride a flag
   SketcherPrs_VertexBuffer (const Graphic3d_Attribute* theAttribs,
                         const Standard_Integer     theStride)
   : Stride (theStride), NbAttributes(1)
@@ -98,6 +99,7 @@ public:
     memcpy (Attribs, theAttribs.AttributesArray(), sizeof(Graphic3d_Attribute) * NbAttributes);
   }
 
+  /// Returns True if color attribute is defined
   virtual bool HasColorAttribute() const
   {
     for (Standard_Integer anAttribIter = 0; anAttribIter < NbAttributes; ++anAttribIter) {
@@ -109,6 +111,7 @@ public:
     return false;
   }
 
+  /// Returns True if normal attribute is defined
   virtual bool HasNormalAttribute() const
   {
     for (Standard_Integer anAttribIter = 0; anAttribIter < NbAttributes; ++anAttribIter) {
@@ -120,6 +123,8 @@ public:
     return false;
   }
 
+  /// Bind position of the attribute
+  /// \param theGlCtx OpenGl context
   virtual void BindPositionAttribute (const Handle(OpenGl_Context)& theGlCtx) const
   {
     if (!OpenGl_VertexBuffer::IsValid()) {
@@ -143,6 +148,8 @@ public:
     }
   }
 
+  /// Bind all attributes
+  /// \param theGlCtx OpenGl context
   virtual void BindAllAttributes (const Handle(OpenGl_Context)& theGlCtx) const
   {
     if (!OpenGl_VertexBuffer::IsValid())
@@ -163,6 +170,8 @@ public:
     }
   }
 
+  /// Unbind all attributes
+  /// \param theGlCtx OpenGl context
   virtual void UnbindAllAttributes (const Handle(OpenGl_Context)& theGlCtx) const
   {
     if (!OpenGl_VertexBuffer::IsValid())
@@ -177,8 +186,13 @@ public:
 
 public:
 
+  /// Array of attributes
   Graphic3d_Attribute Attribs[1];
+
+  /// A flag
   Standard_Integer    Stride;
+
+  /// Number of attributes
   Standard_Integer NbAttributes;
 };
 
@@ -187,15 +201,21 @@ public:
 class SketcherPrs_Element: public OpenGl_Element
 {
 public:
+  /// Constructor
+  /// \param theObj a presentation
   SketcherPrs_Element(const Handle(SketcherPrs_SymbolPrs)& theObj) : 
   OpenGl_Element(), myObj(theObj) {}
 
+  /// Render the current presentation
+  /// \param theWorkspace OpenGL workspace
   virtual void Render (const Handle(OpenGl_Workspace)& theWorkspace) const
   {
     if (!myObj.IsNull())
       myObj->Render(theWorkspace);
   }
 
+  /// Releases OpenGL resources
+  /// \param theContext OpenGL context
   virtual void Release (OpenGl_Context* theContext) 
   {
     if (!myObj.IsNull())
@@ -237,39 +257,50 @@ SketcherPrs_SymbolPrs::SketcherPrs_SymbolPrs(ModelAPI_Feature* theConstraint,
 SketcherPrs_SymbolPrs::~SketcherPrs_SymbolPrs()
 {
   SketcherPrs_PositionMgr* aMgr = SketcherPrs_PositionMgr::get();
+  // Empty memory in position manager
   aMgr->deleteConstraint(this);
 }
 
-
+#ifdef _WINDOWS
+#pragma warning( disable : 4996 )
+#endif
 
 Handle(Image_AlienPixMap) SketcherPrs_SymbolPrs::icon()
 {
   if (myIconsMap.count(iconName()) == 1) {
     return myIconsMap[iconName()];
   }
-  TCollection_AsciiString aFile(getenv("NewGeomResources"));
-  aFile += FSEP;
-  aFile += iconName();
-  Handle(Image_AlienPixMap) aPixMap = new Image_AlienPixMap();
-  if (aPixMap->Load(aFile)) {
-    myIconsMap[iconName()] = aPixMap;
-    return aPixMap;
+  // Load icon for the presentation
+  char* aEnv = getenv("NEWGEOM_ROOT_DIR");
+  if (aEnv != NULL) {
+    TCollection_AsciiString aFile(aEnv);
+    aFile+=FSEP;
+    aFile+="resources";
+    aFile += FSEP;
+    aFile += iconName();
+    Handle(Image_AlienPixMap) aPixMap = new Image_AlienPixMap();
+    if (aPixMap->Load(aFile)) {
+      myIconsMap[iconName()] = aPixMap;
+      return aPixMap;
+    }
   }
+  // The icon for constraint is not found
+  static const char aMsg[] = "Error! constraint images are not found";
+  cout<<aMsg<<endl;
+  Events_Error::send(aMsg);
+  myIconsMap[iconName()] = Handle(Image_AlienPixMap)();
   return Handle(Image_AlienPixMap)();
 }
 
-void SketcherPrs_SymbolPrs::ClearSelected()
-{
-  Handle( Prs3d_Presentation ) aSelectionPrs = GetSelectPresentation( NULL );  
-  if( !aSelectionPrs.IsNull() ) {
-    aSelectionPrs->Clear(); 
-  }
-}
-
 void SketcherPrs_SymbolPrs::prepareAspect()
 {
+  // Create an aspect with the icon
   if (myAspect.IsNull()) {
-    myAspect = new Graphic3d_AspectMarker3d(icon());
+    Handle(Image_AlienPixMap) aIcon = icon();
+    if (aIcon.IsNull()) 
+      myAspect = new Graphic3d_AspectMarker3d();
+    else
+      myAspect = new Graphic3d_AspectMarker3d(aIcon);
   }
 }
 
@@ -284,6 +315,7 @@ void SketcherPrs_SymbolPrs::addLine(const Handle(Graphic3d_Group)& theGroup, std
   std::shared_ptr<GeomAPI_Pnt> aPnt1 = aEdge->firstPoint();
   std::shared_ptr<GeomAPI_Pnt> aPnt2 = aEdge->lastPoint();
 
+  // Draw line by two points
   Handle(Graphic3d_ArrayOfSegments) aLines = new Graphic3d_ArrayOfSegments(2, 1);
   aLines->AddVertex(aPnt1->impl<gp_Pnt>());
   aLines->AddVertex(aPnt2->impl<gp_Pnt>());
@@ -304,7 +336,8 @@ void SketcherPrs_SymbolPrs::HilightSelected(const Handle(PrsMgr_PresentationMana
 }
 
 void SketcherPrs_SymbolPrs::HilightOwnerWithColor(const Handle(PrsMgr_PresentationManager3d)& thePM, 
-                                                 const Quantity_NameOfColor theColor, const Handle(SelectMgr_EntityOwner)& theOwner)
+                                                 const Quantity_NameOfColor theColor, 
+                                                 const Handle(SelectMgr_EntityOwner)& theOwner)
 {
   thePM->Color(this, theColor);
 
@@ -320,6 +353,7 @@ void SketcherPrs_SymbolPrs::Compute(const Handle(PrsMgr_PresentationManager3d)&
                                    const Handle(Prs3d_Presentation)& thePresentation, 
                                    const Standard_Integer theMode)
 {
+  // Create an icon
   prepareAspect();
 
   Handle(AIS_InteractiveContext) aCtx = GetContext();
@@ -329,21 +363,27 @@ void SketcherPrs_SymbolPrs::Compute(const Handle(PrsMgr_PresentationManager3d)&
     aDriver->UserDrawCallback() = SymbolPrsCallBack;
   }
 
-  if (!updatePoints(20))
+  // Update points with default shift value
+  if (!updatePoints(20)) {
     return;
+  }
 
   int aNbVertex = myPntArray->VertexNumber();
   if (myOwner.IsNull()) {
     myOwner = new SelectMgr_EntityOwner(this);
-    for (int i = 1; i <= aNbVertex; i++) {
-      Handle(SketcherPrs_SensitivePoint) aSP = new SketcherPrs_SensitivePoint(myOwner, myPntArray, i);
-      mySPoints.Append(aSP);
-    }
+  }
+
+  // Create sensitive point for each symbol
+  mySPoints.Clear();
+  for (int i = 1; i <= aNbVertex; i++) {
+    Handle(SketcherPrs_SensitivePoint) aSP = new SketcherPrs_SensitivePoint(myOwner, i);
+    mySPoints.Append(aSP);
   }
 
   Handle(Graphic3d_Group) aGroup = Prs3d_Root::NewGroup(thePresentation);
   aGroup->SetPrimitivesAspect(myAspect);
 
+  // Recompute boundary box of the group
   Graphic3d_BndBox4f& aBnd = aGroup->ChangeBoundingBox();
   gp_Pnt aVert;
   aBnd.Clear();
@@ -352,7 +392,11 @@ void SketcherPrs_SymbolPrs::Compute(const Handle(PrsMgr_PresentationManager3d)&
     aBnd.Add (Graphic3d_Vec4((float)aVert.X(), (float)aVert.Y(), (float)aVert.Z(), 1.0f));
   }
 
+  // Pint the group with custom procedure (see Render)
   aGroup->UserDraw(this, true);
+
+  // Disable frustum culling for this object by marking it as mutable
+  aGroup->Structure()->SetMutable(true);
   //aGroup->AddPrimitiveArray(myPntArray);
 }
 
@@ -371,11 +415,17 @@ void SketcherPrs_SymbolPrs::ComputeSelection(const Handle(SelectMgr_Selection)&
 
 void SketcherPrs_SymbolPrs::Render(const Handle(OpenGl_Workspace)& theWorkspace) const
 {
+  // do not update presentation for invalid or already removed objects: the presentation
+  // should be removed soon
+  if (!myConstraint->data().get() || !myConstraint->data()->isValid())
+    return;
+
   const OpenGl_AspectMarker* anAspectMarker = theWorkspace->AspectMarker(Standard_True);
   const Handle(OpenGl_Context)& aCtx = theWorkspace->GetGlContext();
   Handle(OpenGl_View) aView = theWorkspace->ActiveView();
   
   double aScale = aView->Camera()->Scale();
+  // Update points coordinate taking the viewer scale into account
   if (!updatePoints(MyDist * aScale))
     return;
 
@@ -385,6 +435,7 @@ void SketcherPrs_SymbolPrs::Render(const Handle(OpenGl_Workspace)& theWorkspace)
     myVboAttribs = new SketcherPrs_VertexBuffer(*aAttribs);
   }
 
+  // Update drawing attributes
   if (!myVboAttribs->init(aCtx, 0, aAttribs->NbElements, aAttribs->Data(), GL_NONE, aAttribs->Stride)) {
     myVboAttribs->Release (aCtx.operator->());
     myVboAttribs.Nullify();
@@ -406,6 +457,12 @@ void SketcherPrs_SymbolPrs::Render(const Handle(OpenGl_Workspace)& theWorkspace)
     if (theWorkspace->NamedStatus & OPENGL_NS_HIGHLIGHT)
       aLineColor = theWorkspace->HighlightColor;
 
+    // Set lighting of the symbol
+    if (toHilight)
+      aCtx->core11fwd->glDisable (GL_LIGHTING);
+    else
+      aCtx->core11fwd->glEnable (GL_LIGHTING);
+
     aCtx->SetColor4fv(*(const OpenGl_Vec4* )(aLineColor->rgb));
 
 
@@ -430,12 +487,16 @@ void SketcherPrs_SymbolPrs::Render(const Handle(OpenGl_Workspace)& theWorkspace)
   // Update selection position only if there is no selected object
   // because it can corrupt selection of other objects
   if ((GetContext()->NbCurrents() == 0) && (GetContext()->NbSelected() == 0))
-    GetContext()->RecomputeSelectionOnly(this);
+  {
+    GetContext()->MainSelector()->RebuildSensitivesTree (this);
+    GetContext()->MainSelector()->RebuildObjectsTree (false);
+  }
 }
 
 
 void SketcherPrs_SymbolPrs::Release (OpenGl_Context* theContext)
 {
+  // Release OpenGl resources
   if (!myVboAttribs.IsNull()) {
     if (theContext) {
       theContext->DelayedRelease (myVboAttribs);
@@ -448,16 +509,20 @@ void SketcherPrs_SymbolPrs::drawShape(const std::shared_ptr<GeomAPI_Shape>& theS
                                       const Handle(Prs3d_Presentation)& thePrs) const
 {
   if (theShape->isEdge()) {
+    // The shape is edge
     std::shared_ptr<GeomAPI_Curve> aCurve = 
       std::shared_ptr<GeomAPI_Curve>(new GeomAPI_Curve(theShape));
     if (aCurve->isLine()) {
+      // The shape is line
       GeomAdaptor_Curve aCurv(aCurve->impl<Handle(Geom_Curve)>(), aCurve->startParam(), aCurve->endParam());
       StdPrs_Curve::Add(thePrs, aCurv, myDrawer);
     } else {
+      // The shape is circle or arc
       GeomAdaptor_Curve aAdaptor(aCurve->impl<Handle(Geom_Curve)>(), aCurve->startParam(), aCurve->endParam());
       StdPrs_DeflectionCurve::Add(thePrs,aAdaptor,myDrawer);
     }
   } else if (theShape->isVertex()) {
+    // draw vertex
     std::shared_ptr<GeomAPI_Vertex> aVertex = 
       std::shared_ptr<GeomAPI_Vertex>(new GeomAPI_Vertex(theShape));
     std::shared_ptr<GeomAPI_Pnt> aPnt = aVertex->point();
@@ -465,3 +530,32 @@ void SketcherPrs_SymbolPrs::drawShape(const std::shared_ptr<GeomAPI_Shape>& theS
     StdPrs_Point::Add(thePrs, aPoint, myDrawer);
   }
 }
+
+void SketcherPrs_SymbolPrs::drawListOfShapes(const std::shared_ptr<ModelAPI_AttributeRefList>& theListAttr, 
+                                             const Handle(Prs3d_Presentation)& thePrs) const
+{
+  int aNb = theListAttr->size();
+  if (aNb == 0)
+    return;
+  int i;
+  ObjectPtr aObj;
+  for (i = 0; i < aNb; i++) {
+    aObj = theListAttr->object(i);
+    std::shared_ptr<GeomAPI_Shape> aShape = SketcherPrs_Tools::getShape(aObj);
+    if (aShape.get() != NULL)
+      drawShape(aShape, thePrs);
+  }
+}
+
+void SketcherPrs_SymbolPrs::BoundingBox (Bnd_Box& theBndBox)
+{
+  Select3D_BndBox3d aTmpBox;
+  for (Select3D_EntitySequenceIter aPntIter (mySPoints); aPntIter.More(); aPntIter.Next()) {
+    const Handle(Select3D_SensitiveEntity)& anEnt = aPntIter.Value();
+    aTmpBox.Combine (anEnt->BoundingBox());
+  }
+
+  theBndBox.Update (aTmpBox.CornerMin().x(), aTmpBox.CornerMin().y(), aTmpBox.CornerMin().z(),
+                    aTmpBox.CornerMax().x(), aTmpBox.CornerMax().y(), aTmpBox.CornerMax().z());
+}
+