nel/src/3d/text_context_user.cpp

   1 // NeL - MMORPG Framework <http://dev.ryzom.com/projects/nel/>
   2 // Copyright (C) 2010-2018  Winch Gate Property Limited
   3 //
   4 // This source file has been modified by the following contributors:
   5 // Copyright (C) 2014-2020  Jan BOON (Kaetemi) <jan.boon@kaetemi.be>
   6 //
   7 // This program is free software: you can redistribute it and/or modify
   8 // it under the terms of the GNU Affero General Public License as
   9 // published by the Free Software Foundation, either version 3 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 // GNU Affero General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU Affero General Public License
  18 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 #include "std3d.h"
  21
  22 #include "nel/3d/text_context_user.h"
  23 #include "nel/misc/hierarchical_timer.h"
  24
  25 #ifdef DEBUG_NEW
  26 #define new DEBUG_NEW
  27 #endif
  28
  29 namespace NL3D
  30 {
  31
  32 H_AUTO_DECL( NL3D_Render_TextContext_3D )
  33 #define NL3D_HAUTO_RENDER_3D_TEXTCONTEXT                                H_AUTO_USE( NL3D_Render_TextContext_3D )
  34
  35 // ***************************************************************************
  36 NLMISC::CVector UTextContext::CStringInfo::getHotSpotVector(UTextContext::THotSpot hotspot)
  37 {
  38         H_AUTO2;
  39
  40         NLMISC::CVector hotspotVector(0,0,0);
  41
  42         if(hotspot==UTextContext::MiddleLeft)
  43                 hotspotVector = CVector(0,0,-StringHeight/2);
  44
  45         if(hotspot==UTextContext::TopLeft)
  46                 hotspotVector = CVector(0,0,StringHeight);
  47
  48         if(hotspot==UTextContext::MiddleBottom)
  49                 hotspotVector = CVector(-StringWidth/2,0,0);
  50
  51         if(hotspot==UTextContext::MiddleMiddle)
  52                 hotspotVector = CVector(-StringWidth/2,0,-StringHeight/2);
  53
  54         if(hotspot==UTextContext::MiddleTop)
  55                 hotspotVector = CVector(-StringWidth/2,0,-StringHeight);
  56
  57         if(hotspot==UTextContext::BottomRight)
  58                 hotspotVector = CVector(-StringWidth,0,0);
  59
  60         if(hotspot==UTextContext::MiddleRight)
  61                 hotspotVector = CVector(-StringWidth,0,-StringHeight/2);
  62
  63         if(hotspot==UTextContext::TopRight)
  64                 hotspotVector = CVector(-StringWidth,0,-StringHeight);
  65
  66         return hotspotVector;
  67 }
  68
  69
  70 // ***************************************************************************
  71 void            UTextContext::CStringInfo::convertTo01Size(UDriver *drv)
  72 {
  73         uint32  w,h;
  74         drv->getWindowSize(w,h);
  75         StringWidth/= w;
  76         StringHeight/= h;
  77         StringLine/= h;
  78 }
  79 void            UTextContext::CStringInfo::convertToPixelSize(UDriver *drv)
  80 {
  81         uint32  w,h;
  82         drv->getWindowSize(w,h);
  83         StringWidth*= w;
  84         StringHeight*= h;
  85         StringLine*= h;
  86 }
  87
  88
  89
  90 // ***************************************************************************
  91 void CTextContextUser::setColor(NLMISC::CRGBA color)
  92 {
  93         H_AUTO2;
  94
  95         _TextContext.setColor(color);
  96 }
  97 void CTextContextUser::setFontSize(uint32 fontSize)
  98 {
  99         H_AUTO2;
 100
 101         _TextContext.setFontSize(fontSize);
 102 }
 103 uint32 CTextContextUser::getFontSize() const
 104 {
 105         H_AUTO2;
 106
 107         return _TextContext.getFontSize();
 108 }
 109 void CTextContextUser::setEmbolden(bool b)
 110 {
 111         H_AUTO2;
 112
 113         _TextContext.setEmbolden(b);
 114 }
 115 bool CTextContextUser::getEmbolden() const
 116 {
 117         H_AUTO2;
 118
 119         return _TextContext.getEmbolden();
 120 }
 121 void CTextContextUser::setOblique(bool b)
 122 {
 123         H_AUTO2;
 124
 125         _TextContext.setOblique(b);
 126 }
 127 bool CTextContextUser::getOblique() const
 128 {
 129         H_AUTO2;
 130
 131         return _TextContext.getOblique();
 132 }
 133 void CTextContextUser::setHotSpot(THotSpot hotSpot)
 134 {
 135         H_AUTO2;
 136
 137         _TextContext.setHotSpot((CComputedString::THotSpot)(uint32)hotSpot) ;
 138 }
 139 UTextContext::THotSpot CTextContextUser::getHotSpot() const
 140 {
 141         H_AUTO2;
 142
 143         return (THotSpot)(uint32)_TextContext.getHotSpot();
 144 }
 145 void CTextContextUser::setScaleX(float scaleX)
 146 {
 147         H_AUTO2;
 148
 149         _TextContext.setScaleX(scaleX);
 150 }
 151 void CTextContextUser::setScaleY(float scaleY)
 152 {
 153         H_AUTO2;
 154
 155         _TextContext.setScaleZ(scaleY);
 156 }
 157 float CTextContextUser::getScaleX() const
 158 {
 159         H_AUTO2;
 160
 161         return _TextContext.getScaleX();
 162 }
 163 float CTextContextUser::getScaleY() const
 164 {
 165         H_AUTO2;
 166
 167         return _TextContext.getScaleZ();
 168 }
 169 void CTextContextUser::setShaded(bool b)
 170 {
 171         H_AUTO2;
 172
 173         _TextContext.setShaded(b);
 174 }
 175 bool CTextContextUser::getShaded() const
 176 {
 177         H_AUTO2;
 178
 179         return _TextContext.getShaded();
 180 }
 181 void CTextContextUser::setShadeOutline(bool b)
 182 {
 183         H_AUTO2;
 184
 185         _TextContext.setShadeOutline(b);
 186 }
 187 bool CTextContextUser::getShadeOutline() const
 188 {
 189         H_AUTO2;
 190
 191         return _TextContext.getShadeOutline();
 192 }
 193 void CTextContextUser::setShadeExtent(float x, float y)
 194 {
 195         H_AUTO2;
 196
 197         _TextContext.setShadeExtent(x, y);
 198 }
 199 void CTextContextUser::setShadeColor (NLMISC::CRGBA sc)
 200 {
 201         H_AUTO2;
 202
 203         _TextContext.setShadeColor (sc);
 204 }
 205 NLMISC::CRGBA CTextContextUser::getShadeColor () const
 206 {
 207         H_AUTO2;
 208
 209         return _TextContext.getShadeColor();
 210 }
 211 void                    CTextContextUser::setKeep800x600Ratio(bool keep)
 212 {
 213         H_AUTO2;
 214
 215         _TextContext.setKeep800x600Ratio(keep);
 216 }
 217 bool                    CTextContextUser::getKeep800x600Ratio() const
 218 {
 219         H_AUTO2;
 220
 221         return _TextContext.getKeep800x600Ratio();
 222 }
 223
 224 // ***************************************************************************
 225 uint32 CTextContextUser::textPush(const char *format, ...)
 226 {
 227         H_AUTO2;
 228
 229         char *str;
 230         NLMISC_CONVERT_VARGS (str, format, NLMISC::MaxCStringSize);
 231
 232         return _TextContext.textPush(str) ;
 233 }
 234 uint32 CTextContextUser::textPush(NLMISC::CUtfStringView sv)
 235 {
 236         H_AUTO2;
 237
 238         return _TextContext.textPush(sv) ;
 239 }
 240 void CTextContextUser::setStringColor(uint32 i, CRGBA newCol)
 241 {
 242         CComputedString *str= _TextContext.getComputedString(i);
 243         if(str)
 244         {
 245                 str->Color= newCol;
 246         }
 247 }
 248 void CTextContextUser::setStringSelection(uint32 i, uint32 selectStart, uint32 selectSize)
 249 {
 250         CComputedString *str= _TextContext.getComputedString(i);
 251         if(str)
 252         {
 253                 str->SelectStart= selectStart;
 254                 str->SelectSize= selectSize;
 255         }
 256 }
 257 void CTextContextUser::resetStringSelection(uint32 i)
 258 {
 259         CComputedString *str= _TextContext.getComputedString(i);
 260         if(str)
 261         {
 262                 str->SelectStart= 0;
 263                 str->SelectSize= std::numeric_limits<uint32>::max();
 264         }
 265 }
 266 void CTextContextUser::erase(uint32 i)
 267 {
 268         H_AUTO2;
 269
 270         _TextContext.erase(i);
 271 }
 272 UTextContext::CStringInfo               CTextContextUser::getStringInfo(uint32 i)
 273 {
 274         H_AUTO2;
 275
 276         CComputedString         *cstr= _TextContext.getComputedString(i);
 277         if(!cstr)
 278                 return CStringInfo(0, 0, 0, 0);
 279         else
 280                 return  CStringInfo(cstr->StringWidth, cstr->StringHeight, cstr->StringLine, cstr->Length);
 281 }
 282 UTextContext::CStringInfo               CTextContextUser::getStringInfo(NLMISC::CUtfStringView sv)
 283 {
 284         H_AUTO2;
 285
 286         _TextContext.computeStringInfo(sv, _CacheString);
 287         return CStringInfo (_CacheString.StringWidth, _CacheString.StringHeight, _CacheString.StringLine, _CacheString.Length);
 288 }
 289 UTextContext::CStringInfo               CTextContextUser::getStringInfo(NLMISC::CUtfStringView sv, size_t len)
 290 {
 291         H_AUTO2;
 292
 293         _TextContext.computeStringInfo(sv, _CacheString, len);
 294         return CStringInfo (_CacheString.StringWidth, _CacheString.StringHeight, _CacheString.StringLine, _CacheString.Length);
 295 }
 296 void CTextContextUser::clear()
 297 {
 298         H_AUTO2;
 299
 300         _TextContext.clear();
 301 }
 302 void CTextContextUser::printAt(float x, float y, uint32 i)
 303 {
 304         H_AUTO2;
 305
 306         _TextContext.printAt(x, y, i);
 307         _DriverUser->restoreMatrixContext();
 308 }
 309 void CTextContextUser::printClipAt(URenderStringBuffer &renderBuffer, float x, float y, uint32 i, float xmin, float ymin, float xmax, float ymax)
 310 {
 311         H_AUTO2;
 312
 313         _TextContext.printClipAt(static_cast<CRenderStringBuffer&>(renderBuffer), x, y, i, xmin, ymin, xmax, ymax);
 314         // Don't need to restore Matrix context here since no driver change
 315 }
 316 void CTextContextUser::printClipAtUnProjected(URenderStringBuffer &renderBuffer, class NL3D::CFrustum &frustum, const NLMISC::CMatrix &scaleMatrix, float x, float y, float depth, uint32 i, float xmin, float ymin, float xmax, float ymax)
 317 {
 318         H_AUTO2;
 319
 320         _TextContext.printClipAtUnProjected(static_cast<CRenderStringBuffer&>(renderBuffer), frustum, scaleMatrix, x, y, depth, i, xmin, ymin, xmax, ymax);
 321         // Don't need to restore Matrix context here since no driver change
 322 }
 323 void CTextContextUser::printClipAtOld (float x, float y, uint32 i, float xmin, float ymin, float xmax, float ymax)
 324 {
 325         static  CRenderStringBuffer     rdrBuffer;
 326         printClipAt(rdrBuffer, x, y ,i, xmin, ymin, xmax, ymax);
 327         flushRenderBuffer(&rdrBuffer);
 328 }
 329 void CTextContextUser::printAt(float x, float y, NLMISC::CUtfStringView sv)
 330 {
 331         H_AUTO2;
 332
 333         _TextContext.printAt(x, y, sv);
 334         _DriverUser->restoreMatrixContext();
 335 }
 336 void CTextContextUser::printfAt(float x, float y, const char * format, ...)
 337 {
 338         H_AUTO2;
 339
 340         char *str;
 341         NLMISC_CONVERT_VARGS (str, format, NLMISC::MaxCStringSize);
 342
 343         _TextContext.printAt(x, y, str) ;
 344         _DriverUser->restoreMatrixContext();
 345 }
 346
 347 void CTextContextUser::render3D(const CMatrix &mat, NLMISC::CUtfStringView sv)
 348 {
 349         NL3D_HAUTO_RENDER_3D_TEXTCONTEXT;
 350
 351         CComputedString computedStr;
 352         _TextContext.computeString(sv,computedStr);
 353
 354         computedStr.render3D(*_Driver,mat);
 355
 356         _DriverUser->restoreMatrixContext();
 357 }
 358 void CTextContextUser::render3D(const CMatrix &mat, const char *format, ...)
 359 {
 360         NL3D_HAUTO_RENDER_3D_TEXTCONTEXT;
 361
 362         char *str;
 363         NLMISC_CONVERT_VARGS (str, format, NLMISC::MaxCStringSize);
 364
 365         render3D(mat, str);
 366
 367         _DriverUser->restoreMatrixContext();
 368 }
 369
 370
 371 float CTextContextUser::getLastXBound() const
 372 {
 373         H_AUTO2;
 374
 375         return 0.0f;
 376 }
 377
 378 // ***************************************************************************
 379 void                    CTextContextUser::dumpCacheTexture (const char *filename)
 380 {
 381         _TextContext.dumpCache (filename);
 382 }
 383
 384
 385 // ***************************************************************************
 386 URenderStringBuffer             *CTextContextUser::createRenderBuffer()
 387 {
 388         return new CRenderStringBuffer;
 389 }
 390
 391 // ***************************************************************************
 392 void                                    CTextContextUser::deleteRenderBuffer(URenderStringBuffer *buffer)
 393 {
 394         delete buffer;
 395 }
 396
 397 // ***************************************************************************
 398 void                                    CTextContextUser::flushRenderBuffer(URenderStringBuffer *buffer)
 399 {
 400                 nlassert(buffer);
 401         CRenderStringBuffer     *rdrBuffer= static_cast<CRenderStringBuffer*>(buffer);
 402         if(rdrBuffer->NumQuads)
 403         {
 404                 rdrBuffer->flush(*_Driver, _TextContext.getFontManager()->getFontMaterial());
 405
 406                 // must restore the Matrix context if some display done. Need just for Frustum/Matrixes
 407                 _DriverUser->restoreMatrixContextMatrixOnly();
 408         }
 409 }
 410
 411 // ***************************************************************************
 412 void                                    CTextContextUser::flushRenderBufferUnProjected(URenderStringBuffer *buffer, bool zwrite)
 413 {
 414                 nlassert(buffer);
 415         CRenderStringBuffer     *rdrBuffer= static_cast<CRenderStringBuffer*>(buffer);
 416         if(rdrBuffer->NumQuads)
 417         {
 418                 rdrBuffer->flushUnProjected(*_Driver, _TextContext.getFontManager()->getFontMaterial(), zwrite);
 419         }
 420 }
 421
 422
 423 // ***************************************************************************
 424 void CTextContextUser::setLetterColors(ULetterColors * letterColors, uint index)
 425 {
 426         H_AUTO2;
 427
 428         _TextContext.setLetterColors(static_cast<CLetterColors*>(letterColors), index);
 429 }
 430
 431 // ***************************************************************************
 432 ULetterColors * CTextContextUser::createLetterColors()
 433 {
 434         H_AUTO2;
 435
 436         ULetterColors * uLetterColors = new CLetterColors();
 437         return uLetterColors;
 438 }
 439
 440 bool CTextContextUser::isSameLetterColors(ULetterColors * letterColors, uint index)
 441 {
 442         H_AUTO2;
 443
 444         return _TextContext.isSameLetterColors(static_cast<CLetterColors*>(letterColors), index);
 445 }
 446
 447 } // NL3D