1 // Created on: 2011-07-13
2 // Created by: Sergey ZERCHANINOV
3 // Copyright (c) 2011-2013 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 <OpenGl_AspectText.hxx>
17 #include <OpenGl_GlCore11.hxx>
18 #include <OpenGl_GraphicDriver.hxx>
19 #include <OpenGl_ShaderManager.hxx>
20 #include <OpenGl_ShaderProgram.hxx>
21 #include <OpenGl_ShaderStates.hxx>
22 #include <OpenGl_Text.hxx>
23 #include <OpenGl_Utils.hxx>
24 #include <OpenGl_Workspace.hxx>
26 #include <Font_FontMgr.hxx>
27 #include <TCollection_HAsciiString.hxx>
35 static const GLdouble THE_IDENTITY_MATRIX[16] =
44 static char const* TheFamily[] = {"Helvetica", "Courier", "Times"};
45 static char const* TheItalic[] = {"Oblique", "Oblique", "Italic"};
46 static char const* TheBase[] = {"", "", "-Roman"};
48 //! Convert font name used for rendering to some "good" font names
49 //! that produce good vector text.
50 static void getGL2PSFontName (const char* theSrcFont,
53 if (strstr (theSrcFont, "Symbol"))
55 sprintf (thePsFont, "%s", "Symbol");
58 else if (strstr (theSrcFont, "ZapfDingbats"))
60 sprintf (thePsFont, "%s", "WingDings");
66 bool isItalic = false;
67 if (strstr (theSrcFont, "Courier"))
71 else if (strstr (theSrcFont, "Times"))
76 if (strstr (theSrcFont, "Bold"))
80 if (strstr (theSrcFont, "Italic")
81 || strstr (theSrcFont, "Oblique"))
90 sprintf (thePsFont, "%s-Bold%s", TheFamily[aFontId], TheItalic[aFontId]);
94 sprintf (thePsFont, "%s-Bold", TheFamily[aFontId]);
99 sprintf (thePsFont, "%s-%s", TheFamily[aFontId], TheItalic[aFontId]);
103 sprintf (thePsFont, "%s%s", TheFamily[aFontId], TheBase[aFontId]);
107 static void exportText (const NCollection_String& theText,
108 const Standard_Boolean theIs2d,
109 const OpenGl_AspectText& theAspect,
110 const Standard_Integer theHeight)
114 getGL2PSFontName (theAspect.FontName().ToCString(), aPsFont);
116 #if !defined(GL_ES_VERSION_2_0)
119 glRasterPos2f (0.0f, 0.0f);
123 glRasterPos3f (0.0f, 0.0f, 0.0f);
127 glBitmap (1, 1, 0, 0, 0, 0, &aZero);
130 // Standard GL2PS's alignment isn't used, because it doesn't work correctly
131 // for all formats, therefore alignment is calculated manually relative
132 // to the bottom-left corner, which corresponds to the GL2PS_TEXT_BL value
133 gl2psTextOpt (theText.ToCString(), aPsFont, (GLshort)theHeight, GL2PS_TEXT_BL, theAspect.Angle());
139 // =======================================================================
140 // function : OpenGl_Text
142 // =======================================================================
143 OpenGl_Text::OpenGl_Text()
147 myScaleHeight (1.0f),
148 myPoint (0.0f, 0.0f, 0.0f),
151 myParams.Height = 10;
152 myParams.HAlign = Graphic3d_HTA_LEFT;
153 myParams.VAlign = Graphic3d_VTA_BOTTOM;
156 // =======================================================================
157 // function : OpenGl_Text
159 // =======================================================================
160 OpenGl_Text::OpenGl_Text (const Standard_Utf8Char* theText,
161 const OpenGl_Vec3& thePoint,
162 const OpenGl_TextParam& theParams)
166 myScaleHeight (1.0f),
167 myExportHeight (1.0f),
168 myParams (theParams),
176 // =======================================================================
177 // function : SetPosition
179 // =======================================================================
180 void OpenGl_Text::SetPosition (const OpenGl_Vec3& thePoint)
185 // =======================================================================
186 // function : SetFontSize
188 // =======================================================================
189 void OpenGl_Text::SetFontSize (const Handle(OpenGl_Context)& theCtx,
190 const Standard_Integer theFontSize)
192 if (myParams.Height != theFontSize)
194 Release (theCtx.operator->());
196 myParams.Height = theFontSize;
199 // =======================================================================
202 // =======================================================================
203 void OpenGl_Text::Init (const Handle(OpenGl_Context)& theCtx,
204 const Standard_Utf8Char* theText,
205 const OpenGl_Vec3& thePoint)
207 releaseVbos (theCtx.operator->());
210 myString.FromUnicode (theText);
213 // =======================================================================
216 // =======================================================================
217 void OpenGl_Text::Init (const Handle(OpenGl_Context)& theCtx,
218 const Standard_Utf8Char* theText,
219 const OpenGl_Vec3& thePoint,
220 const OpenGl_TextParam& theParams)
222 if (myParams.Height != theParams.Height)
224 Release (theCtx.operator->());
228 releaseVbos (theCtx.operator->());
231 myParams = theParams;
233 myString.FromUnicode (theText);
236 // =======================================================================
239 // =======================================================================
240 void OpenGl_Text::Init (const Handle(OpenGl_Context)& theCtx,
241 const TCollection_ExtendedString& theText,
242 const OpenGl_Vec2& thePoint,
243 const OpenGl_TextParam& theParams)
245 if (myParams.Height != theParams.Height)
247 Release (theCtx.operator->());
251 releaseVbos (theCtx.operator->());
254 myParams = theParams;
255 myPoint.xy() = thePoint;
257 myString.FromUnicode ((Standard_Utf16Char* )theText.ToExtString());
260 // =======================================================================
261 // function : ~OpenGl_Text
263 // =======================================================================
264 OpenGl_Text::~OpenGl_Text()
269 // =======================================================================
270 // function : releaseVbos
272 // =======================================================================
273 void OpenGl_Text::releaseVbos (OpenGl_Context* theCtx)
275 for (Standard_Integer anIter = 0; anIter < myVertsVbo.Length(); ++anIter)
277 Handle(OpenGl_VertexBuffer)& aVerts = myVertsVbo.ChangeValue (anIter);
278 Handle(OpenGl_VertexBuffer)& aTCrds = myTCrdsVbo.ChangeValue (anIter);
282 theCtx->DelayedRelease (aVerts);
283 theCtx->DelayedRelease (aTCrds);
293 // =======================================================================
294 // function : Release
296 // =======================================================================
297 void OpenGl_Text::Release (OpenGl_Context* theCtx)
299 releaseVbos (theCtx);
300 if (!myFont.IsNull())
302 Handle(OpenGl_Context) aCtx = theCtx;
303 const TCollection_AsciiString aKey = myFont->ResourceKey();
306 aCtx->ReleaseResource (aKey, Standard_True);
310 // =======================================================================
311 // function : StringSize
313 // =======================================================================
314 void OpenGl_Text::StringSize (const Handle(OpenGl_Context)& theCtx,
315 const NCollection_String& theText,
316 const OpenGl_AspectText& theTextAspect,
317 const OpenGl_TextParam& theParams,
318 Standard_ShortReal& theWidth,
319 Standard_ShortReal& theAscent,
320 Standard_ShortReal& theDescent)
325 const TCollection_AsciiString aFontKey = FontKey (theTextAspect, theParams.Height);
326 Handle(OpenGl_Font) aFont = FindFont (theCtx, theTextAspect, theParams.Height, aFontKey);
327 if (aFont.IsNull() || !aFont->IsValid())
332 theAscent = aFont->Ascender();
333 theDescent = aFont->Descender();
335 GLfloat aWidth = 0.0f;
336 for (NCollection_Utf8Iter anIter = theText.Iterator(); *anIter != 0;)
338 const Standard_Utf32Char aCharThis = *anIter;
339 const Standard_Utf32Char aCharNext = *++anIter;
341 if (aCharThis == '\x0D' // CR (carriage return)
342 || aCharThis == '\a' // BEL (alarm)
343 || aCharThis == '\f' // FF (form feed) NP (new page)
344 || aCharThis == '\b' // BS (backspace)
345 || aCharThis == '\v') // VT (vertical tab)
347 continue; // skip unsupported carriage control codes
349 else if (aCharThis == '\x0A') // LF (line feed, new line)
351 theWidth = Max (theWidth, aWidth);
355 else if (aCharThis == ' ')
357 aWidth += aFont->AdvanceX (aCharThis, aCharNext);
360 else if (aCharThis == '\t')
362 aWidth += aFont->AdvanceX (' ', aCharNext) * 8.0f;
366 aWidth += aFont->AdvanceX (aCharThis, aCharNext);
368 theWidth = Max (theWidth, aWidth);
370 Handle(OpenGl_Context) aCtx = theCtx;
372 aCtx->ReleaseResource (aFontKey, Standard_True);
375 // =======================================================================
378 // =======================================================================
379 void OpenGl_Text::Render (const Handle(OpenGl_Workspace)& theWorkspace) const
381 const OpenGl_AspectText* aTextAspect = theWorkspace->AspectText (Standard_True);
382 const Handle(OpenGl_Texture) aPrevTexture = theWorkspace->DisableTexture();
383 const Handle(OpenGl_Context)& aCtx = theWorkspace->GetGlContext();
385 // Bind custom shader program or generate default version
386 if (aCtx->core20fwd != NULL)
388 aCtx->ShaderManager()->BindProgram (
389 aTextAspect, aTextAspect->ShaderProgramRes (aCtx));
392 // use highlight color or colors from aspect
393 if (theWorkspace->NamedStatus & OPENGL_NS_HIGHLIGHT)
395 render (theWorkspace->PrinterContext(),
398 *theWorkspace->HighlightColor,
399 *theWorkspace->HighlightColor);
403 render (theWorkspace->PrinterContext(),
406 aTextAspect->Color(),
407 aTextAspect->SubtitleColor());
411 if (!aPrevTexture.IsNull())
413 theWorkspace->EnableTexture (aPrevTexture);
417 // =======================================================================
420 // =======================================================================
421 void OpenGl_Text::Render (const Handle(OpenGl_PrinterContext)& thePrintCtx,
422 const Handle(OpenGl_Context)& theCtx,
423 const OpenGl_AspectText& theTextAspect) const
425 render (thePrintCtx, theCtx, theTextAspect, theTextAspect.Color(), theTextAspect.SubtitleColor());
428 // =======================================================================
429 // function : setupMatrix
431 // =======================================================================
432 void OpenGl_Text::setupMatrix (const Handle(OpenGl_PrinterContext)& thePrintCtx,
433 const Handle(OpenGl_Context)& theCtx,
434 const OpenGl_AspectText& theTextAspect,
435 const OpenGl_Vec3 theDVec) const
437 OpenGl_Mat4d aModViewMat;
441 OpenGl_Utils::Translate<GLdouble> (aModViewMat, myPoint.x() + theDVec.x(), myPoint.y() + theDVec.y(), 0.f);
442 OpenGl_Utils::Scale<GLdouble> (aModViewMat, 1.f, -1.f, 1.f);
443 OpenGl_Utils::Rotate<GLdouble> (aModViewMat, theTextAspect.Angle(), 0.f, 0.f, 1.f);
447 // align coordinates to the nearest integer
448 // to avoid extra interpolation issues
449 GLdouble anObjX, anObjY, anObjZ;
450 OpenGl_Utils::UnProject<Standard_Real> (std::floor (myWinX + theDVec.x()),
451 std::floor (myWinY + theDVec.y()),
452 myWinZ + theDVec.z(),
453 OpenGl_Mat4d::Map (THE_IDENTITY_MATRIX),
454 OpenGl_Mat4d::Map (myProjMatrix),
460 OpenGl_Utils::Translate<GLdouble> (aModViewMat, anObjX, anObjY, anObjZ);
461 OpenGl_Utils::Rotate<GLdouble> (aModViewMat, theTextAspect.Angle(), 0.0, 0.0, 1.0);
463 if (!theTextAspect.IsZoomable())
466 // if the context has assigned printer context, use it's parameters
467 if (!thePrintCtx.IsNull())
469 // get printing scaling in x and y dimensions
470 GLfloat aTextScalex = 1.0f, aTextScaley = 1.0f;
471 thePrintCtx->GetScale (aTextScalex, aTextScaley);
473 // text should be scaled in all directions with same
474 // factor to save its proportions, so use height (y) scaling
475 // as it is better for keeping text/3d graphics proportions
476 OpenGl_Utils::Scale<GLdouble> (aModViewMat, aTextScaley, aTextScaley, aTextScaley);
479 OpenGl_Utils::Scale<GLdouble> (aModViewMat, myScaleHeight, myScaleHeight, myScaleHeight);
483 theCtx->WorldViewState.SetCurrent<Standard_Real> (aModViewMat);
484 theCtx->ApplyWorldViewMatrix();
486 if (!theCtx->ActiveProgram().IsNull())
488 // Upload updated state to shader program
489 theCtx->ShaderManager()->PushState (theCtx->ActiveProgram());
493 // =======================================================================
494 // function : drawText
496 // =======================================================================
498 void OpenGl_Text::drawText (const Handle(OpenGl_PrinterContext)& ,
499 const Handle(OpenGl_Context)& theCtx,
501 const OpenGl_AspectText& theTextAspect) const
503 const OpenGl_AspectText& ) const
507 if (theCtx->IsFeedback())
509 // position of the text and alignment is calculated by transformation matrix
510 exportText (myString, myIs2d, theTextAspect, (Standard_Integer )myExportHeight);
515 if (myVertsVbo.Length() != myTextures.Length()
516 || myTextures.IsEmpty())
521 for (Standard_Integer anIter = 0; anIter < myTextures.Length(); ++anIter)
523 const GLuint aTexId = myTextures.Value (anIter);
524 glBindTexture (GL_TEXTURE_2D, aTexId);
526 const Handle(OpenGl_VertexBuffer)& aVerts = myVertsVbo.Value (anIter);
527 const Handle(OpenGl_VertexBuffer)& aTCrds = myTCrdsVbo.Value (anIter);
528 aVerts->BindAttribute (theCtx, Graphic3d_TOA_POS);
529 aTCrds->BindAttribute (theCtx, Graphic3d_TOA_UV);
531 glDrawArrays (GL_TRIANGLES, 0, GLsizei(aVerts->GetElemsNb()));
533 aTCrds->UnbindAttribute (theCtx, Graphic3d_TOA_UV);
534 aVerts->UnbindAttribute (theCtx, Graphic3d_TOA_POS);
536 glBindTexture (GL_TEXTURE_2D, 0);
539 // =======================================================================
540 // function : FontKey
542 // =======================================================================
543 TCollection_AsciiString OpenGl_Text::FontKey (const OpenGl_AspectText& theAspect,
544 const Standard_Integer theHeight)
546 const Font_FontAspect anAspect = (theAspect.FontAspect() != Font_FA_Undefined) ? theAspect.FontAspect() : Font_FA_Regular;
547 return theAspect.FontName()
548 + TCollection_AsciiString(":") + Standard_Integer(anAspect)
549 + TCollection_AsciiString(":") + theHeight;
552 // =======================================================================
553 // function : FindFont
555 // =======================================================================
556 Handle(OpenGl_Font) OpenGl_Text::FindFont (const Handle(OpenGl_Context)& theCtx,
557 const OpenGl_AspectText& theAspect,
558 const Standard_Integer theHeight,
559 const TCollection_AsciiString theKey)
561 Handle(OpenGl_Font) aFont;
564 return aFont; // invalid parameters
567 if (!theCtx->GetResource (theKey, aFont))
569 Handle(Font_FontMgr) aFontMgr = Font_FontMgr::GetInstance();
570 const Handle(TCollection_HAsciiString) aFontName = new TCollection_HAsciiString (theAspect.FontName());
571 const Font_FontAspect anAspect = (theAspect.FontAspect() != Font_FA_Undefined) ? theAspect.FontAspect() : Font_FA_Regular;
572 Handle(Font_SystemFont) aRequestedFont = aFontMgr->FindFont (aFontName, anAspect, theHeight);
573 if (aRequestedFont.IsNull())
578 Handle(Font_FTFont) aFontFt = new Font_FTFont (NULL);
579 if (!aFontFt->Init (aRequestedFont->FontPath()->ToCString(), theHeight))
584 Handle(OpenGl_Context) aCtx = theCtx;
585 #if !defined(GL_ES_VERSION_2_0)
586 glPushAttrib (GL_TEXTURE_BIT);
588 aFont = new OpenGl_Font (aFontFt, theKey);
589 if (!aFont->Init (aCtx))
592 //return aFont; // out of resources?
594 #if !defined(GL_ES_VERSION_2_0)
595 glPopAttrib(); // texture bit
598 aCtx->ShareResource (theKey, aFont);
603 // =======================================================================
606 // =======================================================================
607 void OpenGl_Text::render (const Handle(OpenGl_PrinterContext)& thePrintCtx,
608 const Handle(OpenGl_Context)& theCtx,
609 const OpenGl_AspectText& theTextAspect,
610 const TEL_COLOUR& theColorText,
611 const TEL_COLOUR& theColorSubs) const
613 if (myString.IsEmpty())
618 const TCollection_AsciiString aFontKey = FontKey (theTextAspect, myParams.Height);
620 && !myFont->ResourceKey().IsEqual (aFontKey))
623 const_cast<OpenGl_Text* > (this)->Release (theCtx.operator->());
628 myFont = FindFont (theCtx, theTextAspect, myParams.Height, aFontKey);
635 if (myTextures.IsEmpty())
637 OpenGl_TextFormatter aFormatter;
638 aFormatter.SetupAlignment (myParams.HAlign, myParams.VAlign);
640 aFormatter.Append (theCtx, myString, *myFont.operator->());
643 aFormatter.Result (theCtx, myTextures, myVertsVbo, myTCrdsVbo);
644 aFormatter.BndBox (myBndBox);
647 if (myTextures.IsEmpty())
652 myExportHeight = 1.0f;
653 myScaleHeight = 1.0f;
655 theCtx->WorldViewState.Push();
657 myModelMatrix.Convert (theCtx->WorldViewState.Current() * theCtx->ModelWorldState.Current());
661 glGetIntegerv (GL_VIEWPORT, myViewport);
662 myProjMatrix.Convert (theCtx->ProjectionState.Current());
664 OpenGl_Utils::Project<Standard_Real> (myPoint.x(),
674 // compute scale factor for constant text height
676 OpenGl_Utils::UnProject<Standard_Real> (myWinX,
679 OpenGl_Mat4d::Map (THE_IDENTITY_MATRIX),
687 const GLdouble h = (GLdouble )myFont->FTFont()->PointSize();
688 OpenGl_Utils::UnProject<Standard_Real> (myWinX,
691 OpenGl_Mat4d::Map (THE_IDENTITY_MATRIX),
698 myScaleHeight = (y2 - y1) / h;
699 if (theTextAspect.IsZoomable())
701 myExportHeight = (float )h;
704 myExportHeight = (float )myFont->FTFont()->PointSize() / myExportHeight;
706 #if !defined(GL_ES_VERSION_2_0)
708 // push enabled flags to the stack
709 glPushAttrib (GL_ENABLE_BIT);
710 glDisable (GL_LIGHTING);
714 && theTextAspect.StyleType() != Aspect_TOST_ANNOTATION)
716 glEnable (GL_DEPTH_TEST);
720 glDisable (GL_DEPTH_TEST);
724 GLint aTexEnvParam = GL_REPLACE;
725 glGetTexEnviv (GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, &aTexEnvParam);
726 if (aTexEnvParam != GL_REPLACE)
728 glTexEnvi (GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_REPLACE);
730 glAlphaFunc (GL_GEQUAL, 0.285f);
731 glEnable (GL_ALPHA_TEST);
735 glBlendFunc (GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA); // GL_ONE
737 // activate texture unit
738 glDisable (GL_TEXTURE_1D);
739 glEnable (GL_TEXTURE_2D);
740 if (theCtx->core15fwd != NULL)
742 theCtx->core15fwd->glActiveTexture (GL_TEXTURE0);
746 switch (theTextAspect.DisplayType())
748 case Aspect_TODT_BLEND:
750 glEnable (GL_COLOR_LOGIC_OP);
754 case Aspect_TODT_SUBTITLE:
756 theCtx->core11->glColor3fv (theColorSubs.rgb);
757 setupMatrix (thePrintCtx, theCtx, theTextAspect, OpenGl_Vec3 (0.0f, 0.0f, 0.00001f));
759 glBindTexture (GL_TEXTURE_2D, 0);
761 glVertex2f (myBndBox.Left, myBndBox.Top);
762 glVertex2f (myBndBox.Right, myBndBox.Top);
763 glVertex2f (myBndBox.Right, myBndBox.Bottom);
764 glVertex2f (myBndBox.Left, myBndBox.Bottom);
768 case Aspect_TODT_DEKALE:
770 theCtx->SetColor4fv (*(const OpenGl_Vec4* )theColorSubs.rgb);
771 setupMatrix (thePrintCtx, theCtx, theTextAspect, OpenGl_Vec3 (+1.0f, +1.0f, 0.00001f));
772 drawText (thePrintCtx, theCtx, theTextAspect);
773 setupMatrix (thePrintCtx, theCtx, theTextAspect, OpenGl_Vec3 (-1.0f, -1.0f, 0.00001f));
774 drawText (thePrintCtx, theCtx, theTextAspect);
775 setupMatrix (thePrintCtx, theCtx, theTextAspect, OpenGl_Vec3 (-1.0f, +1.0f, 0.00001f));
776 drawText (thePrintCtx, theCtx, theTextAspect);
777 setupMatrix (thePrintCtx, theCtx, theTextAspect, OpenGl_Vec3 (+1.0f, -1.0f, 0.00001f));
778 drawText (thePrintCtx, theCtx, theTextAspect);
781 case Aspect_TODT_DIMENSION:
782 case Aspect_TODT_NORMAL:
789 theCtx->SetColor4fv (*(const OpenGl_Vec4* )theColorText.rgb);
790 setupMatrix (thePrintCtx, theCtx, theTextAspect, OpenGl_Vec3 (0.0f, 0.0f, 0.0f));
791 drawText (thePrintCtx, theCtx, theTextAspect);
793 glTexEnvi (GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, aTexEnvParam);
795 if (theTextAspect.DisplayType() == Aspect_TODT_DIMENSION)
797 setupMatrix (thePrintCtx, theCtx, theTextAspect, OpenGl_Vec3 (0.0f, 0.0f, 0.00001f));
799 glDisable (GL_BLEND);
800 glDisable (GL_TEXTURE_2D);
801 glDisable (GL_ALPHA_TEST);
804 glDisable (GL_DEPTH_TEST);
806 glColorMask (GL_FALSE, GL_FALSE, GL_FALSE, GL_FALSE);
808 glClear (GL_STENCIL_BUFFER_BIT);
809 glEnable (GL_STENCIL_TEST);
810 glStencilFunc (GL_ALWAYS, 1, 0xFF);
811 glStencilOp (GL_KEEP, GL_KEEP, GL_REPLACE);
814 glVertex2f (myBndBox.Left, myBndBox.Top);
815 glVertex2f (myBndBox.Right, myBndBox.Top);
816 glVertex2f (myBndBox.Right, myBndBox.Bottom);
817 glVertex2f (myBndBox.Left, myBndBox.Bottom);
820 glStencilFunc (GL_ALWAYS, 0, 0xFF);
821 // glPopAttrib() will reset state for us
822 //glDisable (GL_STENCIL_TEST);
823 //if (!myIs2d) glEnable (GL_DEPTH_TEST);
825 glColorMask (GL_TRUE, GL_TRUE, GL_TRUE, GL_TRUE);
828 // revert OpenGL state
829 glPopAttrib(); // enable bit
831 // model view matrix was modified
832 theCtx->WorldViewState.Pop();
833 theCtx->ApplyModelViewMatrix();