TPadExtent.hxx

Go to the documentation of this file.

/// \file ROOT/TPadExtent.hxx
/// \ingroup Gpad ROOT7
/// \author Axel Naumann <axel@cern.ch>
/// \date 2017-07-07
/// \warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback
/// is welcome!

/*************************************************************************
 * Copyright (C) 1995-2017, Rene Brun and Fons Rademakers.               *
 * All rights reserved.                                                  *
 *                                                                       *
 * For the licensing terms see $ROOTSYS/LICENSE.                         *
 * For the list of contributors see $ROOTSYS/README/CREDITS.             *
 *************************************************************************/

#ifndef ROOT7_TPadExtent
#define ROOT7_TPadExtent

#include "ROOT/TPadLength.hxx"

#include <array>

namespace ROOT {
namespace Experimental {

namespace Internal {
/** \class ROOT::Experimental::Internal::TPadHorizVert
   A 2D (horizontal and vertical) combination of `TPadLength`s.
   */

struct TPadHorizVert {
   TPadLength fHoriz; ///< Horizontal position
   TPadLength fVert;  ///< Vertical position

   TPadHorizVert() = default;
   TPadHorizVert(const std::array<TPadLength, 2> &hv): fHoriz(hv[0]), fVert(hv[1]) {}
   TPadHorizVert(const TPadLength &horiz, const TPadLength &vert): fHoriz(horiz), fVert(vert) {}
};
}; // namespace Internal

/** \class ROOT::Experimental::TPadExtent
  An extent / size (horizontal and vertical) in a `TPad`.
  */
struct TPadExtent: Internal::TPadHorizVert {
   using Internal::TPadHorizVert::TPadHorizVert;

   /// Add two `TPadExtent`s.
   friend TPadExtent operator+(TPadExtent lhs, const TPadExtent &rhs)
   {
      return {lhs.fHoriz + rhs.fHoriz, lhs.fVert + rhs.fVert};
   }

   /// Subtract two `TPadExtent`s.
   friend TPadExtent operator-(TPadExtent lhs, const TPadExtent &rhs)
   {
      return {lhs.fHoriz - rhs.fHoriz, lhs.fVert - rhs.fVert};
   }

   /// Add a `TPadExtent`.
   TPadExtent &operator+=(const TPadExtent &rhs)
   {
      fHoriz += rhs.fHoriz;
      fVert += rhs.fVert;
      return *this;
   };

   /// Subtract a `TPadExtent`.
   TPadExtent &operator-=(const TPadExtent &rhs)
   {
      fHoriz -= rhs.fHoriz;
      fVert -= rhs.fVert;
      return *this;
   };

   /** \class ScaleFactor
      A scale factor (separate factors for horizontal and vertical) for scaling a `TPadLength`.
      */
   struct ScaleFactor {
      double fHoriz; ///< Horizontal scale factor
      double fVert;  ///< Vertical scale factor
   };

   /// Scale a `TPadHorizVert` horizonally and vertically.
   /// \param scale - the scale factor,
   TPadExtent &operator*=(const ScaleFactor &scale)
   {
      fHoriz *= scale.fHoriz;
      fVert *= scale.fVert;
      return *this;
   };
};

/// Initialize a TPadExtent from a style string.
/// Syntax: X, Y
/// where X and Y are a series of numbers separated by "+", where each number is followed by one of
/// `px`, `user`, `normal` to specify an extent in pixel, user or normal coordinates. Spaces between
/// any part is allowed.
/// Example: `100 px + 0.1 user, 0.5 normal` is a `TPadExtent{100_px + 0.1_user, 0.5_normal}`.

void InitializeAttrFromString(const std::string &name, const std::string &attrStrVal, TPadExtent& val);

} // namespace Experimental
} // namespace ROOT

#endif