TPadPainterBase.cxx

Go to the documentation of this file.

// @(#)root/gpad:$Id$
// Author:  Sergey Linev  17/04/2026
 
/*************************************************************************
 * Copyright (C) 1995-2026, Rene Brun and Fons Rademakers.               *
 * All rights reserved.                                                  *
 *                                                                       *
 * For the licensing terms see $ROOTSYS/LICENSE.                         *
 * For the list of contributors see $ROOTSYS/README/CREDITS.             *
 *************************************************************************/
 
#include "TPadPainterBase.h"
#include "TColor.h"
 
#include "TVirtualX.h"
#include "TVirtualPad.h"
#include "TMathBase.h"
#include "TError.h"
#include "TTFhandle.h"
#include "TImage.h"
 
/** \class TPadPainterBase
\ingroup gpad
 
Extends TVirtualPadPainter interface to simplify work with graphical attributes
 
Plus for now central place for TTF handling
*/
 
////////////////////////////////////////////////////////////////////////////////
/// Returns fill attributes after modification
/// Checks for special fill styles 4000 .. 4100
 
TAttFill TPadPainterBase::GetAttFillInternal(Bool_t with_transparency)
{
   Style_t style = GetAttFill().GetFillStyle();
   Color_t color = GetAttFill().GetFillColor();
 
   fFullyTransparent = (style == 4000) || (style == 0);
   if (fFullyTransparent) {
      style = 0;
   } else if ((style > 4000) && (style <= 4100)) {
      if ((style < 4100) && with_transparency)
         color = TColor::GetColorTransparent(color, (style - 4000) / 100.);
      style = 1001;
   }
 
   return { color, style };
}
 
////////////////////////////////////////////////////////////////////////////////
/// Returns text extend
 
void TPadPainterBase::GetTextExtent(Font_t font, Double_t size, UInt_t &w, UInt_t &h, const char *mess)
{
   Bool_t res = kFALSE;
 
   if (!HasTTFonts() && gVirtualX)
      res = gVirtualX->GetTextExtentA(font, size, w, h, mess);
 
   if (!res) {
      TTFhandle ttf;
      ttf.SetTextFont(font);
      ttf.SetTextSize(size * GetTTFScale());
      ttf.GetTextExtent(w, h, mess);
   }
}
 
////////////////////////////////////////////////////////////////////////////////
/// Returns text extend
 
void TPadPainterBase::GetTextExtent(Font_t font, Double_t size, UInt_t &w, UInt_t &h, const wchar_t *mess)
{
   Bool_t res = kFALSE;
 
   if (!HasTTFonts() && gVirtualX)
      res = gVirtualX->GetTextExtentA(font, size, w, h, mess);
 
   if (!res) {
      TTFhandle ttf;
      ttf.SetTextFont(font);
      ttf.SetTextSize(size * GetTTFScale());
      ttf.GetTextExtent(w, h, mess);
   }
}
 
////////////////////////////////////////////////////////////////////////////////
/// Returns text accent / descent
 
void TPadPainterBase::GetTextAscentDescent(Font_t font, Double_t size, UInt_t &a, UInt_t &d, const char *mess)
{
   Bool_t res = kFALSE;
 
   if (!HasTTFonts() && gVirtualX) {
      res = gVirtualX->GetFontAscentDescent(font, size, a, d, mess);
      if (res & !a) {
         UInt_t w = 0;
         gVirtualX->GetTextExtentA(font, size, w, a, mess);
      }
   }
 
   if (!res) {
      TTFhandle ttf;
      ttf.SetTextFont(font);
      ttf.SetTextSize(size * GetTTFScale());
      UInt_t w, h;
      ttf.GetTextExtent(w, h, mess);
      a = ttf.GetBoxYMax();
      d = TMath::Abs(ttf.GetBoxYMin());
   }
}
 
////////////////////////////////////////////////////////////////////////////////
/// Returns text accent / descent
 
void TPadPainterBase::GetTextAscentDescent(Font_t font, Double_t size, UInt_t &a, UInt_t &d, const wchar_t *mess)
{
   Bool_t res = kFALSE;
 
   // special use case for MacOS - directly use TTF
   if (!HasTTFonts() && !IsCocoa() && gVirtualX) {
      res = gVirtualX->GetFontAscentDescent(font, size, a, d, "");
      if (res & !a) {
         UInt_t w = 0;
         gVirtualX->GetTextExtentA(font, size, w, a, mess);
      }
   }
 
   if (!res) {
      TTFhandle ttf;
      ttf.SetTextFont(font);
      ttf.SetTextSize(size * GetTTFScale());
      UInt_t w, h;
      ttf.GetTextExtent(w, h, mess);
      a = ttf.GetBoxYMax();
      d = TMath::Abs(ttf.GetBoxYMin());
   }
}
 
////////////////////////////////////////////////////////////////////////////////
/// Returns text advance
 
UInt_t TPadPainterBase::GetTextAdvance(Font_t font, Double_t size, const char *mess, Bool_t kern)
{
   if (!HasTTFonts() && gVirtualX) {
      UInt_t a = 0, h;
      if (gVirtualX->GetTextExtentA(font, size, a, h, mess))
         return a;
   }
 
   TTFhandle ttf;
   ttf.SetTextFont(font);
   ttf.SetTextSize(size * GetTTFScale());
   ttf.SetKerning(kern);
 
   UInt_t a = 0;
   ttf.GetTextAdvance(a, mess);
   return a;
}
 
////////////////////////////////////////////////////////////////////////////////
/// Performs rendering of TTF glyphs on output device
/// Can be implemented in derived classes instead of implementing
/// 4 different signatures of DrawText
 
void TPadPainterBase::DrawTTFglyphs([[maybe_unused]] Int_t x, [[maybe_unused]] Int_t y, [[maybe_unused]] TTFhandle &ttf, [[maybe_unused]] ETextMode mode)
{
}
 
////////////////////////////////////////////////////////////////////////////////
/// Paint text.
 
void TPadPainterBase::DrawText(Double_t x, Double_t y, const char *text, ETextMode mode)
{
   Int_t px = fPad->XtoPixel(x);
   Int_t py = fPad->YtoPixel(y);
   const TAttText &att = GetAttText();
 
   if (HasTTFonts()) {
      TTFhandle ttf;
      ttf.SetTextFont(att.GetTextFont());
      ttf.SetTextSize(att.GetTextSizePixels(*fPad));
      ttf.SetRotationMatrix(att.GetTextAngle());
      ttf.PrepareString(text);
      ttf.LayoutGlyphs();
      if (ttf.ApplyAlignRotate(px, py, att.GetTextAlign(), fPad->GetPadWidth(), fPad->GetPadHeight()))
         DrawTTFglyphs(px, py, ttf, mode);
   } else if (fWinContext && gVirtualX) {
      gVirtualX->DrawTextW(fWinContext, px, py, att.GetTextAngle(), GetTextMagnitude(), text,
                           (TVirtualX::ETextMode)mode);
   }
}
 
////////////////////////////////////////////////////////////////////////////////
/// Paint wtext.
 
void TPadPainterBase::DrawText(Double_t x, Double_t y, const wchar_t *text, ETextMode mode)
{
   Int_t px = fPad->XtoPixel(x);
   Int_t py = fPad->YtoPixel(y);
   const TAttText &att = GetAttText();
 
   if (HasTTFonts()) {
      TTFhandle ttf;
      ttf.SetTextFont(att.GetTextFont());
      ttf.SetTextSize(att.GetTextSizePixels(*fPad));
      ttf.SetRotationMatrix(att.GetTextAngle());
      ttf.PrepareString(text);
      ttf.LayoutGlyphs();
      if (ttf.ApplyAlignRotate(px, py, att.GetTextAlign(), fPad->GetPadWidth(), fPad->GetPadHeight()))
         DrawTTFglyphs(px, py, ttf, mode);
   } else if (fWinContext && gVirtualX) {
      gVirtualX->DrawTextW(fWinContext, px, py, att.GetTextAngle(), GetTextMagnitude(), text,
                           (TVirtualX::ETextMode)mode);
   }
}
 
////////////////////////////////////////////////////////////////////////////////
/// Paint text at NDC coordinates.
 
void TPadPainterBase::DrawTextNDC(Double_t u, Double_t v, const char *text, ETextMode mode)
{
   Int_t px = fPad->UtoPixel(u);
   Int_t py = fPad->VtoPixel(v);
   const TAttText &att = GetAttText();
 
   if (HasTTFonts()) {
      TTFhandle ttf;
      ttf.SetTextFont(att.GetTextFont());
      ttf.SetTextSize(att.GetTextSizePixels(*fPad));
      ttf.SetRotationMatrix(att.GetTextAngle());
      ttf.PrepareString(text);
      ttf.LayoutGlyphs();
      if (ttf.ApplyAlignRotate(px, py, att.GetTextAlign(), fPad->GetPadWidth(), fPad->GetPadHeight()))
         DrawTTFglyphs(px, py, ttf, mode);
   } else if (fWinContext && gVirtualX) {
      gVirtualX->DrawTextW(fWinContext, px, py, att.GetTextAngle(), GetTextMagnitude(), text,
                           (TVirtualX::ETextMode)mode);
   }
}
 
////////////////////////////////////////////////////////////////////////////////
/// Paint wtext at NDC coordinates.
 
void TPadPainterBase::DrawTextNDC(Double_t u, Double_t v, const wchar_t *text, ETextMode mode)
{
   Int_t px = fPad->UtoPixel(u);
   Int_t py = fPad->VtoPixel(v);
   const TAttText &att = GetAttText();
 
   if (HasTTFonts()) {
      TTFhandle ttf;
      ttf.SetTextFont(att.GetTextFont());
      ttf.SetTextSize(att.GetTextSizePixels(*fPad));
      ttf.SetRotationMatrix(att.GetTextAngle());
      ttf.PrepareString(text);
      ttf.LayoutGlyphs();
      if (ttf.ApplyAlignRotate(px, py, att.GetTextAlign(), fPad->GetPadWidth(), fPad->GetPadHeight()))
         DrawTTFglyphs(px, py, ttf, mode);
   } else if (fWinContext && gVirtualX) {
      gVirtualX->DrawTextW(fWinContext, px, py, att.GetTextAngle(), GetTextMagnitude(), text,
                           (TVirtualX::ETextMode)mode);
   }
}
 
////////////////////////////////////////////////////////////////////////////////
/// Store pad image into the file
/// One should provide FillImageFromPad implementation in the subclass
 
TVirtualPadPainter::ESaveImageResult TPadPainterBase::SaveAsImage(TVirtualPad *pad, const char *fileName, Int_t type) const
{
   std::unique_ptr<TImage> image(TImage::Create());
   if (!image.get()) {
      ::Error("TPadPainterBase::SaveImage", "TImage creation failed");
      return kSaveFail;
   }
 
   if (!FillImageFromPad(image.get(), pad))
      return kSaveFail;
 
   image->WriteImage(fileName, (TImage::EImageFileTypes)type);
 
   return kSaveOk;
}