REveDigitSet.hxx

Go to the documentation of this file.

// @(#)root/eve:$Id$
// Authors: Matevz Tadel & Alja Mrak-Tadel: 2006, 2007
 
/*************************************************************************
 * Copyright (C) 1995-2007, 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_REveDigitSet
#define ROOT_REveDigitSet
 
#include "TNamed.h"
 
#include "ROOT/REveUtil.hxx"
#include "ROOT/REveElement.hxx"
#include "ROOT/REveFrameBox.hxx"
#include "ROOT/REveRGBAPalette.hxx"
#include "ROOT/REveChunkManager.hxx"
#include "ROOT/REveSecondarySelectable.hxx"
 
class TRefArray;
 
namespace ROOT {
namespace Experimental {
 
class REveDigitSet : public REveElement, public REveSecondarySelectable {
   friend class REveDigitSetEditor;
   friend class REveDigitSetGL;
 
   REveDigitSet(const REveDigitSet&);            // Not implemented
   REveDigitSet& operator=(const REveDigitSet&); // Not implemented
 
public:
   enum ERenderMode_e { kRM_AsIs, kRM_Line, kRM_Fill };
 
   typedef void (*Callback_foo)(const REveDigitSet*, Int_t, TObject*);
   typedef std::string (*TooltipCB_foo)(const REveDigitSet*, Int_t);
 
   struct DigitBase_t
   {
      // Base-class for digit representation classes.
 
      Int_t  fValue;    // signal value of a digit (can be direct RGBA color)
      void  *fUserData{nullptr}; // user-data for given digit
 
      DigitBase_t(Int_t v=0) : fValue(v), fUserData(nullptr) {}
   };
 
protected:
   TRefArray        *fDigitIds{nullptr};  //  Array holding references to external objects.
 
   Int_t             fDefaultValue;   //  Default signal value.
   Bool_t            fValueIsColor{false};   //  Interpret signal value as RGBA color.
   Bool_t            fSingleColor;    //  Use the same color for all digits.
   Bool_t            fAntiFlick;      // Make extra render pass to avoid flickering when quads are too small.
 
   Bool_t            fOwnIds{false};  //  Flag specifying if id-objects are owned by the TEveDigitSet.
   Bool_t            fDetIdsAsSecondaryIndices;         //  Flag specifying if id-objects are owned by the REveDigitSet.
   REveChunkManager  fPlex;           //  Container of digit data.
   DigitBase_t*      fLastDigit;      ///<! The last / current digit added to collection.
   Int_t             fLastIdx;        ///<! The last / current idx added to collection.
 
   Color_t           fColor;          //  Color used for frame (or all digis with single-color).
   REveFrameBox*     fFrame;          //  Pointer to frame structure.
   REveRGBAPalette*  fPalette;        //  Pointer to signal-color palette.
   ERenderMode_e     fRenderMode;     //  Render mode: as-is / line / filled.
   Bool_t            fSelectViaFrame; //  Allow selection via frame.
   Bool_t            fHighlightFrame; //  Highlight frame when object is selected.
   Bool_t            fDisableLighting;//  Disable lighting for rendering.
   Bool_t            fHistoButtons;   //  Show histogram buttons in object editor.
 
   Bool_t            fEmitSignals;    //  Emit signals on secondary-select.
   Callback_foo      fCallbackFoo;    ///<! Additional function to call on secondary-select.
   TooltipCB_foo     fTooltipCBFoo;   ///<! Function providing highlight tooltips when always-sec-select is active.
 
   DigitBase_t* NewDigit();
   void         ReleaseIds();
 
public:
   REveDigitSet(const char* n="REveDigitSet", const char* t="");
   ~REveDigitSet() override;
 
   void   UseSingleColor();
 
   Bool_t GetAntiFlick() const   { return fAntiFlick; }
   void   SetAntiFlick(Bool_t f) { fAntiFlick = f; }
 
   void SetMainColor(Color_t color) override;
 
   /*
   virtual void UnSelected();
   virtual void UnHighlighted();
*/
   using REveElement::GetHighlightTooltip;
   std::string GetHighlightTooltip(const std::set<int>& secondary_idcs) const override;
 
   // Implemented in sub-classes:
   // virtual void Reset(EQuadType_e quadType, Bool_t valIsCol, Int_t chunkSize);
 
   void RefitPlex();
   void ScanMinMaxValues(Int_t& min, Int_t& max);
 
   // --------------------------------
 
   void SetCurrentDigit(Int_t idx);
 
   void DigitValue(Int_t value);
   void DigitColor(Color_t ci);
   void DigitColor(Color_t ci, Char_t transparency);
   void DigitColor(UChar_t r, UChar_t g, UChar_t b, UChar_t a=255);
   void DigitColor(UChar_t* rgba);
 
   void   DigitId(TObject* id);
   void   DigitId(Int_t n, TObject* id);
 
   Bool_t GetDetIdsAsSecondaryIndices() const     { return fDetIdsAsSecondaryIndices; }
   void   SetDetIdsAsSecondaryIndices(Bool_t o)   { fDetIdsAsSecondaryIndices = o; }
 
   DigitBase_t* GetDigit(Int_t n) const { return (DigitBase_t*) fPlex.Atom(n); }
   TObject*  GetId(Int_t n) const;
 
   // --------------------------------
 
   // Implemented in subclasses:
   // virtual void ComputeBBox();
   /*
   virtual void Paint(Option_t* option="");
 
   virtual void DigitSelected(Int_t idx);
   virtual void SecSelected(REveDigitSet* qs, Int_t idx); // *SIGNAL*
   */
   // --------------------------------
 
   REveChunkManager* GetPlex() { return &fPlex; }
 
   REveFrameBox* GetFrame() const { return fFrame; }
   void          SetFrame(REveFrameBox* b);
 
   Bool_t GetSelectViaFrame() const    { return fSelectViaFrame; }
   void   SetSelectViaFrame(Bool_t sf) { fSelectViaFrame = sf; }
 
   Bool_t GetHighlightFrame() const    { return fHighlightFrame; }
   void   SetHighlightFrame(Bool_t hf) { fHighlightFrame = hf; }
 
   Bool_t GetValueIsColor()  const { return fValueIsColor; }
 
   REveRGBAPalette* GetPalette() const { return fPalette; }
   void             SetPalette(REveRGBAPalette* p);
   REveRGBAPalette* AssertPalette();
 
   ERenderMode_e  GetRenderMode()           const { return fRenderMode; }
   void           SetRenderMode(ERenderMode_e rm) { fRenderMode = rm; }
 
   Bool_t GetDisableLighting() const   { return fDisableLighting; }
   void   SetDisableLighting(Bool_t l) { fDisableLighting = l; }
 
   Bool_t GetHistoButtons() const   { return fHistoButtons; }
   void   SetHistoButtons(Bool_t f) { fHistoButtons = f; }
 
   Bool_t GetEmitSignals() const   { return fEmitSignals; }
   void   SetEmitSignals(Bool_t f) { fEmitSignals = f; }
 
   Callback_foo GetCallbackFoo()         const { return fCallbackFoo; }
   void         SetCallbackFoo(Callback_foo f) { fCallbackFoo = f; }
 
   TooltipCB_foo GetTooltipCBFoo()          const { return fTooltipCBFoo; }
   void          SetTooltipCBFoo(TooltipCB_foo f) { fTooltipCBFoo = f; }
 
   bool    IsDigitVisible(const DigitBase_t*) const;
   int     GetAtomIdxFromShapeIdx(int) const;
   int     GetShapeIdxFromAtomIdx(int) const;
 
   void    NewShapePicked(int shapeId, Int_t selectionId, bool multi);
 
   bool    RequiresExtraSelectionData() const override { return GetAlwaysSecSelect(); };
   void    FillExtraSelectionData(nlohmann::json& j, const std::set<int>& secondary_idcs) const override;
 
   Int_t WriteCoreJson(nlohmann::json &j, Int_t rnr_offset) override;
};
 
} // namespace Experimental
} // namespace ROOT
#endif