1 // Created on: 2012-04-09
2 // Created by: Sergey ANIKIN
3 // Copyright (c) 2012-2014 OPEN CASCADE SAS
5 // This file is part of Open CASCADE Technology software library.
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
16 #include <ViewerTest.hxx>
18 #include <AIS_InteractiveContext.hxx>
19 #include <AIS_InteractiveObject.hxx>
21 #include <Draw_Interpretor.hxx>
22 #include <Graphic3d_Group.hxx>
23 #include <Graphic3d_ShaderObject.hxx>
24 #include <Graphic3d_ShaderProgram.hxx>
25 #include <OpenGl_AspectFace.hxx>
26 #include <OpenGl_AspectLine.hxx>
27 #include <OpenGl_AspectMarker.hxx>
28 #include <OpenGl_AspectText.hxx>
29 #include <OpenGl_Context.hxx>
30 #include <OpenGl_Element.hxx>
31 #include <OpenGl_GlCore20.hxx>
32 #include <OpenGl_GraphicDriver.hxx>
33 #include <OpenGl_Workspace.hxx>
34 #include <OSD_Environment.hxx>
35 #include <OSD_File.hxx>
36 #include <Prs3d_Drawer.hxx>
37 #include <Prs3d_Presentation.hxx>
38 #include <Prs3d_Root.hxx>
39 #include <Prs3d_LineAspect.hxx>
40 #include <Prs3d_ShadingAspect.hxx>
41 #include <Select3D_SensitiveCurve.hxx>
42 #include <SelectMgr_EntityOwner.hxx>
43 #include <SelectMgr_Selection.hxx>
44 #include <TCollection_AsciiString.hxx>
45 #include <V3d_View.hxx>
46 #include <V3d_Viewer.hxx>
47 #include <ViewerTest_DoubleMapOfInteractiveAndName.hxx>
48 #include <ViewerTest_DoubleMapIteratorOfDoubleMapOfInteractiveAndName.hxx>
49 #include <OpenGl_Group.hxx>
51 extern Standard_Boolean VDisplayAISObject (const TCollection_AsciiString& theName,
52 const Handle(AIS_InteractiveObject)& theAISObj,
53 Standard_Boolean theReplaceIfExists = Standard_True);
54 extern ViewerTest_DoubleMapOfInteractiveAndName& GetMapOfAIS();
58 //=======================================================================
59 //function : VUserDraw
60 //purpose : Checks availability and operation of UserDraw feature
61 //=======================================================================
63 class VUserDrawObj : public AIS_InteractiveObject
67 DEFINE_STANDARD_RTTI_INLINE(VUserDrawObj,AIS_InteractiveObject);
80 class Element : public OpenGl_Element
83 Handle(VUserDrawObj) myIObj;
86 Element (const Handle(VUserDrawObj)& theIObj) : myIObj (theIObj) {}
90 virtual void Render (const Handle(OpenGl_Workspace)& theWorkspace) const
93 myIObj->Render(theWorkspace);
96 virtual void Release (OpenGl_Context*)
102 DEFINE_STANDARD_ALLOC
106 // Virtual methods implementation
107 void Compute (const Handle(PrsMgr_PresentationManager3d)& thePresentationManager,
108 const Handle(Prs3d_Presentation)& thePresentation,
109 const Standard_Integer theMode) Standard_OVERRIDE;
111 void ComputeSelection (const Handle(SelectMgr_Selection)& theSelection,
112 const Standard_Integer theMode) Standard_OVERRIDE;
114 // Called by VUserDrawElement
115 void Render(const Handle(OpenGl_Workspace)& theWorkspace) const;
119 friend class Element;
122 void VUserDrawObj::Compute(const Handle(PrsMgr_PresentationManager3d)& thePrsMgr,
123 const Handle(Prs3d_Presentation)& thePrs,
124 const Standard_Integer /*theMode*/)
128 Graphic3d_Vec4 aBndMin (myCoords[0], myCoords[1], myCoords[2], 1.0f);
129 Graphic3d_Vec4 aBndMax (myCoords[3], myCoords[4], myCoords[5], 1.0f);
130 Handle(OpenGl_Group) aGroup = Handle(OpenGl_Group)::DownCast (thePrs->NewGroup());
131 aGroup->SetMinMaxValues (aBndMin.x(), aBndMin.y(), aBndMin.z(),
132 aBndMax.x(), aBndMax.y(), aBndMax.z());
133 aGroup->SetGroupPrimitivesAspect (myDrawer->LineAspect()->Aspect());
134 VUserDrawObj::Element* anElem = new VUserDrawObj::Element (this);
135 aGroup->AddElement(anElem);
137 // invalidate bounding box of the scene
138 thePrsMgr->StructureManager()->Update (thePrsMgr->StructureManager()->UpdateMode());
141 void VUserDrawObj::ComputeSelection (const Handle(SelectMgr_Selection)& theSelection,
142 const Standard_Integer /*theMode*/)
144 Handle(SelectMgr_EntityOwner) anEntityOwner = new SelectMgr_EntityOwner(this);
145 Handle(TColgp_HArray1OfPnt) aPnts = new TColgp_HArray1OfPnt(1, 5);
146 aPnts->SetValue(1, gp_Pnt(myCoords[0], myCoords[1], myCoords[2]));
147 aPnts->SetValue(2, gp_Pnt(myCoords[3], myCoords[4], myCoords[2]));
148 aPnts->SetValue(3, gp_Pnt(myCoords[3], myCoords[4], myCoords[5]));
149 aPnts->SetValue(4, gp_Pnt(myCoords[0], myCoords[1], myCoords[5]));
150 aPnts->SetValue(5, gp_Pnt(myCoords[0], myCoords[1], myCoords[2]));
151 Handle(Select3D_SensitiveCurve) aSensitive = new Select3D_SensitiveCurve(anEntityOwner, aPnts);
152 theSelection->Add(aSensitive);
155 void VUserDrawObj::Render(const Handle(OpenGl_Workspace)& theWorkspace) const
157 // this sample does not use GLSL programs - make sure it is disabled
158 Handle(OpenGl_Context) aCtx = theWorkspace->GetGlContext();
159 aCtx->BindProgram (NULL);
161 // To test linking against OpenGl_Workspace and all aspect classes
162 const OpenGl_AspectLine* aLA = theWorkspace->AspectLine(0);
163 const OpenGl_AspectMarker* aMA = theWorkspace->AspectMarker(0);
165 const OpenGl_AspectText* aTA = theWorkspace->AspectText(0);
167 TEL_COLOUR aColor = theWorkspace->NamedStatus & OPENGL_NS_HIGHLIGHT ?
168 *(theWorkspace->HighlightColor) : aLA->Color();
170 // Finally draw something to make sure UserDraw really works
171 glPushAttrib(GL_ENABLE_BIT);
172 glDisable(GL_LIGHTING);
173 glColor4fv(aColor.rgb);
174 glBegin(GL_LINE_LOOP);
175 glVertex3f(myCoords[0], myCoords[1], myCoords[2]);
176 glVertex3f(myCoords[3], myCoords[4], myCoords[2]);
177 glVertex3f(myCoords[3], myCoords[4], myCoords[5]);
178 glVertex3f(myCoords[0], myCoords[1], myCoords[5]);
183 } // end of anonymous namespace
185 static Standard_Integer VUserDraw (Draw_Interpretor& di,
186 Standard_Integer argc,
189 Handle(AIS_InteractiveContext) aContext = ViewerTest::GetAISContext();
190 if (aContext.IsNull())
192 di << argv[0] << "Call 'vinit' before!\n";
196 Handle(OpenGl_GraphicDriver) aDriver = Handle(OpenGl_GraphicDriver)::DownCast (aContext->CurrentViewer()->Driver());
197 if (aDriver.IsNull())
199 std::cerr << "Graphic driver not available.\n";
205 di << argv[0] << "Wrong number of arguments, only the object name expected\n";
209 TCollection_AsciiString aName (argv[1]);
210 VDisplayAISObject(aName, Handle(AIS_InteractiveObject)());
212 Handle(VUserDrawObj) anIObj = new VUserDrawObj();
213 VDisplayAISObject(aName, anIObj);
218 //==============================================================================
219 //function : VFeedback
221 //==============================================================================
223 static int VFeedback (Draw_Interpretor& theDI,
224 Standard_Integer /*theArgNb*/,
225 const char** /*theArgVec*/)
227 // get the active view
228 Handle(V3d_View) aView = ViewerTest::CurrentView();
231 std::cerr << "No active view. Please call vinit.\n";
235 unsigned int aBufferSize = 1024 * 1024;
238 size_t aBytes = (size_t )aBufferSize * sizeof(GLfloat);
239 if (aBytes / sizeof(GLfloat) != (size_t )aBufferSize)
241 // finito la commedia
242 std::cerr << "Can not allocate buffer - requested size ("
243 << (double(aBufferSize / (1024 * 1024)) * double(sizeof(GLfloat)))
244 << " MiB) is out of address space\n";
248 GLfloat* aBuffer = (GLfloat* )Standard::Allocate (aBytes);
251 // finito la commedia
252 std::cerr << "Can not allocate buffer with size ("
253 << (double(aBufferSize / (1024 * 1024)) * double(sizeof(GLfloat)))
258 glFeedbackBuffer ((GLsizei )aBufferSize, GL_2D, aBuffer);
259 glRenderMode (GL_FEEDBACK);
263 GLint aResult = glRenderMode (GL_RENDER);
268 void* aPtr = aBuffer;
269 Standard::Free (aPtr);
274 std::cout << "FeedBack result= " << aResult << "\n";
281 GLint aBitmapsNb = 0;
282 GLint aPassThrNb = 0;
283 GLint aUnknownNb = 0;
284 const GLint NODE_VALUES = 2; // GL_2D
285 for (GLint anIter = 0; anIter < aResult;)
287 const GLfloat aPos = aBuffer[anIter];
288 switch ((GLint )aPos)
294 anIter += 1 + NODE_VALUES;
297 case GL_LINE_RESET_TOKEN:
302 anIter += 1 + 2 * NODE_VALUES;
305 case GL_POLYGON_TOKEN:
307 const GLint aCount = (GLint )aBuffer[++anIter];
309 anIter += aCount * NODE_VALUES + 1;
314 else if (aCount == 4)
324 case GL_BITMAP_TOKEN:
325 case GL_DRAW_PIXEL_TOKEN:
326 case GL_COPY_PIXEL_TOKEN:
329 anIter += 1 + NODE_VALUES;
332 case GL_PASS_THROUGH_TOKEN:
335 anIter += 2; // header + value
346 void* aPtr = aBuffer;
347 Standard::Free (aPtr);
350 theDI << "Total nodes: " << aNodesNb << "\n"
351 << "Points: " << aPntNb << "\n"
352 << "Line segments: " << aLinesNb << "\n"
353 << "Triangles: " << aTriNb << "\n"
354 << "Quads: " << aQuadsNb << "\n"
355 << "Polygons: " << aPolyNb << "\n"
356 << "Bitmap tokens: " << aBitmapsNb << "\n"
357 << "Pass through: " << aPassThrNb << "\n"
358 << "UNKNOWN: " << aUnknownNb << "\n";
360 double aLen2D = double(aNodesNb * 2 + aPntNb + aLinesNb * 2 + (aTriNb + aQuadsNb + aPolyNb) * 2 + aBitmapsNb + aPassThrNb);
361 double aLen3D = double(aNodesNb * 3 + aPntNb + aLinesNb * 2 + (aTriNb + aQuadsNb + aPolyNb) * 2 + aBitmapsNb + aPassThrNb);
362 double aLen3D_rgba = double(aNodesNb * 7 + aPntNb + aLinesNb * 2 + (aTriNb + aQuadsNb + aPolyNb) * 2 + aBitmapsNb + aPassThrNb);
363 theDI << "Buffer size GL_2D: " << aLen2D * double(sizeof(GLfloat)) / double(1024 * 1024) << " MiB\n"
364 << "Buffer size GL_3D: " << aLen3D * double(sizeof(GLfloat)) / double(1024 * 1024) << " MiB\n"
365 << "Buffer size GL_3D_COLOR: " << aLen3D_rgba * double(sizeof(GLfloat)) / double(1024 * 1024) << " MiB\n";
370 //==============================================================================
371 //function : VImmediateFront
373 //==============================================================================
375 static int VImmediateFront (Draw_Interpretor& /*theDI*/,
376 Standard_Integer theArgNb,
377 const char** theArgVec)
380 Handle(AIS_InteractiveContext) aContextAIS = ViewerTest::GetAISContext();
381 if (aContextAIS.IsNull())
383 std::cerr << "No active view. Please call vinit.\n";
387 Handle(Graphic3d_GraphicDriver) aDriver = aContextAIS->CurrentViewer()->Driver();
389 if (aDriver.IsNull())
391 std::cerr << "Graphic driver not available.\n";
397 std::cerr << "Wrong number of arguments.\n";
401 ViewerTest::CurrentView()->View()->SetImmediateModeDrawToFront (atoi(theArgVec[1]) != 0);
406 //==============================================================================
409 //==============================================================================
411 static int VGlInfo (Draw_Interpretor& theDI,
412 Standard_Integer theArgNb,
413 const char** theArgVec)
415 // get the active view
416 Handle(V3d_View) aView = ViewerTest::CurrentView();
419 std::cerr << "No active view. Please call vinit.\n";
425 Handle(OpenGl_GraphicDriver) aDriver = Handle(OpenGl_GraphicDriver)::DownCast (aView->Viewer()->Driver());
426 if (aDriver.IsNull())
428 std::cerr << "Error: view does not use OpenGL.\n";
431 Handle(OpenGl_Context) aCtx = aDriver->GetSharedContext();
432 Standard_CString aDebugInfo = !aCtx.IsNull() && aCtx->IsDebugContext()
435 theDI << "OpenGL info:\n"
436 << " GLvendor = '" << (const char* )glGetString(GL_VENDOR) << "'\n"
437 << " GLdevice = '" << (const char* )glGetString(GL_RENDERER) << "'\n"
438 << " GLversion = '" << (const char* )glGetString(GL_VERSION) << "'\n"
439 << " GLSLversion = '" << (const char* )glGetString(GL_SHADING_LANGUAGE_VERSION) << "'\n"
444 const Standard_Boolean isList = theArgNb >= 3;
445 for (Standard_Integer anIter = 1; anIter < theArgNb; ++anIter)
447 TCollection_AsciiString aName (theArgVec[anIter]);
449 const char* aValue = NULL;
450 if (aName.Search ("VENDOR") != -1)
452 aValue = (const char* )glGetString (GL_VENDOR);
454 else if (aName.Search ("RENDERER") != -1)
456 aValue = (const char* )glGetString (GL_RENDERER);
458 else if (aName.Search ("SHADING_LANGUAGE_VERSION") != -1
459 || aName.Search ("GLSL") != -1)
461 aValue = (const char* )glGetString (GL_SHADING_LANGUAGE_VERSION);
463 else if (aName.Search ("VERSION") != -1)
465 aValue = (const char* )glGetString (GL_VERSION);
467 else if (aName.Search ("EXTENSIONS") != -1)
469 aValue = (const char* )glGetString (GL_EXTENSIONS);
473 std::cerr << "Unknown key '" << aName.ToCString() << "'\n";
479 theDI << "{" << aValue << "} ";
491 //==============================================================================
492 //function : VShaderProg
493 //purpose : Sets the pair of vertex and fragment shaders for the object
494 //==============================================================================
495 static Standard_Integer VShaderProg (Draw_Interpretor& /*theDI*/,
496 Standard_Integer theArgNb,
497 const char** theArgVec)
499 Handle(AIS_InteractiveContext) aCtx = ViewerTest::GetAISContext();
502 std::cerr << "Use 'vinit' command before " << theArgVec[0] << "\n";
505 else if (theArgNb < 2)
507 std::cerr << theArgVec[0] << " syntax error: lack of arguments\n";
511 TCollection_AsciiString aLastArg (theArgVec[theArgNb - 1]);
512 aLastArg.UpperCase();
513 const Standard_Boolean toTurnOff = aLastArg == "OFF";
514 Standard_Integer anArgsNb = theArgNb - 1;
515 Handle(Graphic3d_ShaderProgram) aProgram;
517 && aLastArg == "PHONG")
519 aProgram = new Graphic3d_ShaderProgram (Graphic3d_ShaderProgram::ShaderName_Phong);
522 && aProgram.IsNull())
526 std::cerr << theArgVec[0] << " syntax error: lack of arguments\n";
530 const TCollection_AsciiString aSrcVert = theArgVec[theArgNb - 2];
531 const TCollection_AsciiString aSrcFrag = theArgVec[theArgNb - 1];
532 if (!aSrcVert.IsEmpty()
533 && !OSD_File (aSrcVert).Exists())
535 std::cerr << "Non-existing vertex shader source\n";
538 if (!aSrcFrag.IsEmpty()
539 && !OSD_File (aSrcFrag).Exists())
541 std::cerr << "Non-existing fragment shader source\n";
545 aProgram = new Graphic3d_ShaderProgram();
546 aProgram->AttachShader (Graphic3d_ShaderObject::CreateFromFile (Graphic3d_TOS_VERTEX, aSrcVert));
547 aProgram->AttachShader (Graphic3d_ShaderObject::CreateFromFile (Graphic3d_TOS_FRAGMENT, aSrcFrag));
548 anArgsNb = theArgNb - 2;
551 Handle(AIS_InteractiveObject) anIO;
553 || *theArgVec[1] == '*')
555 for (ViewerTest_DoubleMapIteratorOfDoubleMapOfInteractiveAndName anIter (GetMapOfAIS());
556 anIter.More(); anIter.Next())
558 anIO = Handle(AIS_InteractiveObject)::DownCast (anIter.Key1());
561 anIO->Attributes()->ShadingAspect()->Aspect()->SetShaderProgram (aProgram);
562 aCtx->Redisplay (anIO, Standard_False);
565 aCtx->UpdateCurrentViewer();
569 for (Standard_Integer anArgIter = 1; anArgIter < anArgsNb; ++anArgIter)
571 const TCollection_AsciiString aName (theArgVec[anArgIter]);
572 if (!GetMapOfAIS().IsBound2 (aName))
574 std::cerr << "Warning: " << aName.ToCString() << " is not displayed\n";
577 anIO = Handle(AIS_InteractiveObject)::DownCast (GetMapOfAIS().Find2 (aName));
580 std::cerr << "Warning: " << aName.ToCString() << " is not an AIS object\n";
583 anIO->Attributes()->ShadingAspect()->Aspect()->SetShaderProgram (aProgram);
584 aCtx->Redisplay (anIO, Standard_False);
587 aCtx->UpdateCurrentViewer();
591 //=======================================================================
592 //function : OpenGlCommands
594 //=======================================================================
596 void ViewerTest::OpenGlCommands(Draw_Interpretor& theCommands)
598 const char* aGroup ="Commands for low-level TKOpenGl features";
600 theCommands.Add("vuserdraw",
601 "vuserdraw : name - simulates drawing with help of UserDraw",
602 __FILE__, VUserDraw, aGroup);
603 theCommands.Add("vfeedback",
604 "vfeedback : perform test GL feedback rendering",
605 __FILE__, VFeedback, aGroup);
606 theCommands.Add("vimmediatefront",
607 "vimmediatefront : render immediate mode to front buffer or to back buffer",
608 __FILE__, VImmediateFront, aGroup);
609 theCommands.Add("vglinfo",
610 "vglinfo [GL_VENDOR] [GL_RENDERER] [GL_VERSION] [GL_SHADING_LANGUAGE_VERSION] [GL_EXTENSIONS]"
612 __FILE__, VGlInfo, aGroup);
613 theCommands.Add("vshaderprog",
614 " 'vshaderprog [name] pathToVertexShader pathToFragmentShader'"
615 "\n\t\t: or 'vshaderprog [name] off' to disable GLSL program"
616 "\n\t\t: or 'vshaderprog [name] phong' to enable per-pixel lighting calculations"
617 "\n\t\t: * might be used to specify all displayed objects",
618 __FILE__, VShaderProg, aGroup);