TWebSnapshot.h

Go to the documentation of this file.

// Author:  Sergey Linev, GSI,  6/04/2017
 
/*************************************************************************
 * Copyright (C) 1995-2019, 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 ROOT_TWebSnapshot
#define ROOT_TWebSnapshot
 
#include "TObject.h"
 
#include <vector>
#include <memory>
#include <string>
 
class TWebSnapshot : public TObject {
 
protected:
   std::string fObjectID;       ///<   object identifier
   std::string fOption;         ///<   object draw option
   Int_t fKind{0};              ///<   kind of snapshots
   TObject *fSnapshot{nullptr}; ///<   snapshot data
   Bool_t fOwner{kFALSE};       ///<!  if objected owned
 
   void SetKind(Int_t kind) { fKind = kind; }
 
public:
 
   enum {
// clang++ <v20 (-Wshadow) complains about shadowing GuiTypes.h global variable kNone. Let's silence warning:
#if defined(__clang__) && __clang_major__ < 20
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wshadow"
#endif
      kNone = 0,        ///< dummy
#if defined(__clang__) && __clang_major__ < 20
#pragma clang diagnostic pop
#endif
     kObject = 1,      ///< object itself
     kSVG = 2,         ///< list of SVG primitives
     kSubPad = 3,      ///< subpad
     kColors = 4,      ///< list of ROOT colors + palette
     kStyle = 5,       ///< gStyle object
     kFont = 6         ///< custom web font
   };
 
   ~TWebSnapshot() override;
 
   void SetObjectIDAsPtr(void *ptr, const std::string &suffix = "");
   void SetObjectID(const std::string &id) { fObjectID = id; }
   const char* GetObjectID() const { return fObjectID.c_str(); }
 
   void SetOption(const std::string &opt) { fOption = opt; }
 
   void SetSnapshot(Int_t kind, TObject *snapshot, Bool_t owner = kFALSE);
   Int_t GetKind() const { return fKind; }
   TObject *GetSnapshot() const { return fSnapshot; }
 
   ClassDefOverride(TWebSnapshot,1)  // Object painting snapshot, used for JSROOT
};
 
// =================================================================================
 
class TPadWebSnapshot : public TWebSnapshot {
protected:
   bool fActive{false};                                    ///< true when pad is active
   bool fReadOnly{true};                                   ///< when canvas or pad are in readonly mode
   bool fSetObjectIds{true};                               ///<! set objects ids
   bool fBatchMode{false};                                 ///<! if object created for image generation
   bool fWithoutPrimitives{false};                         ///< true when primitives not send while there are no modifications
   bool fHasExecs{false};                                  ///< if true, more interactive events will be delivered from client
   std::vector<std::unique_ptr<TWebSnapshot>> fPrimitives; ///< list of all primitives, drawn in the pad
 
public:
   TPadWebSnapshot(bool readonly = true, bool setids = true, bool batchmode = false)
   {
      SetKind(kSubPad);
      fReadOnly = readonly;
      fSetObjectIds = setids;
      fBatchMode = batchmode;
   }
 
   void SetActive(bool on = true) { fActive = on; }
 
   void SetWithoutPrimitives(bool on = true) { fWithoutPrimitives = on; }
 
   void SetHasExecs(bool on = true) { fHasExecs = on; }
 
   bool IsReadOnly() const { return fReadOnly; }
 
   bool IsSetObjectIds() const { return fSetObjectIds; }
 
   bool IsBatchMode() const { return fBatchMode; }
 
   TWebSnapshot &NewPrimitive(TObject *obj = nullptr, const std::string &opt = "", const std::string &suffix = "");
 
   TPadWebSnapshot &NewSubPad();
 
   TWebSnapshot &NewSpecials();
 
   ClassDefOverride(TPadWebSnapshot, 3) // Pad painting snapshot, used for JSROOT
};
 
// =================================================================================
 
class TCanvasWebSnapshot : public TPadWebSnapshot {
protected:
   std::string fScripts;           ///< custom scripts to load
   bool fHighlightConnect{false};  ///< does HighlightConnect has connection
   bool fFixedSize{false};         ///< if canvas draw size is fixed
public:
   TCanvasWebSnapshot(bool readonly = true, bool setids = true, bool batchmode = false) : TPadWebSnapshot(readonly, setids, batchmode) {}
 
   void SetScripts(const std::string &src) { fScripts = src; }
   const std::string &GetScripts() const { return fScripts; }
 
   void SetHighlightConnect(bool on = true) { fHighlightConnect = on; }
   bool GetHighlightConnect() const { return fHighlightConnect; }
 
   void SetFixedSize(bool on = true) { fFixedSize = on; }
   bool IsFixedSize() const { return fFixedSize; }
 
   ClassDefOverride(TCanvasWebSnapshot, 4) // Canvas painting snapshot, used for JSROOT
};
 
 
#endif