Logo ROOT   6.19/01
Reference Guide
TEveFrameBox Class Reference

Description of a 2D or 3D frame that can be used to visually group a set of objects.

Definition at line 18 of file TEveFrameBox.h.

Public Types

enum  EFrameType_e { kFT_None, kFT_Quad, kFT_Box }
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 

Public Member Functions

 TEveFrameBox ()
 
virtual ~TEveFrameBox ()
 Destructor. More...
 
Color_t GetBackColor () const
 
UChar_tGetBackRGBA ()
 
Bool_t GetDrawBack () const
 
Color_t GetFrameColor () const
 
Bool_t GetFrameFill () const
 
Float_tGetFramePoints () const
 
UChar_tGetFrameRGBA ()
 
Int_t GetFrameSize () const
 
EFrameType_e GetFrameType () const
 
Float_t GetFrameWidth () const
 
Color_tPtrBackColor ()
 
Color_tPtrFrameColor ()
 
void SetAABox (Float_t x, Float_t y, Float_t z, Float_t dx, Float_t dy, Float_t dz)
 Setup for axis-aligned box with one corner at x, y, z and given sizes in x (dx), y (dy) and z (dz). More...
 
void SetAABoxCenterHalfSize (Float_t x, Float_t y, Float_t z, Float_t dx, Float_t dy, Float_t dz)
 Setup for axis-aligned box with center at x, y, z and given half-sizes in x (dx), y (dy) and z (dz). More...
 
void SetAAQuadXY (Float_t x, Float_t y, Float_t z, Float_t dx, Float_t dy)
 Setup for axis-aligned rectangle with one corner at x, y, z and given sizes in x (dx) and y (dy). More...
 
void SetAAQuadXZ (Float_t x, Float_t y, Float_t z, Float_t dx, Float_t dz)
 Setup for axis-aligned rectangle with one corner at x, y, z and given sizes in x (dx) and z (dz). More...
 
void SetBackColor (Color_t ci)
 Set color of the background polygon. More...
 
void SetBackColorPixel (Pixel_t pix)
 Set color of the background polygon. More...
 
void SetBackColorRGBA (UChar_t r, UChar_t g, UChar_t b, UChar_t a=255)
 Set color of the background polygon. More...
 
void SetDrawBack (Bool_t f)
 
void SetFrameColor (Color_t ci)
 Set color of the frame. More...
 
void SetFrameColorPixel (Pixel_t pix)
 Set color of the frame. More...
 
void SetFrameColorRGBA (UChar_t r, UChar_t g, UChar_t b, UChar_t a=255)
 Set color of the frame. More...
 
void SetFrameFill (Bool_t f)
 
void SetFrameWidth (Float_t f)
 
void SetQuadByPoints (const Float_t *pointArr, Int_t nPoints)
 Setup frame with explicitly given corner coordinates. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 
- Public Member Functions inherited from TEveRefBackPtr
 TEveRefBackPtr ()
 Default constructor. More...
 
 TEveRefBackPtr (const TEveRefBackPtr &)
 Copy constructor. More...
 
virtual ~TEveRefBackPtr ()
 Destructor. Noop, should complain if back-ref list is not empty. More...
 
void DecRefCount ()
 
virtual void DecRefCount (TEveElement *re)
 Decrease reference count and remove re from the list of back-references. More...
 
void IncRefCount ()
 
virtual void IncRefCount (TEveElement *re)
 Increase reference count and add re to the list of back-references. More...
 
TEveRefBackPtroperator= (const TEveRefBackPtr &)
 Assignment operator. More...
 
virtual void StampBackPtrElements (UChar_t stamps)
 Add given stamps to elements in the list of reverse references. More...
 
- Public Member Functions inherited from TEveRefCnt
 TEveRefCnt ()
 
 TEveRefCnt (const TEveRefCnt &)
 
virtual ~TEveRefCnt ()
 
void DecRefCount ()
 
void IncRefCount ()
 
virtual void OnZeroRefCount ()
 
TEveRefCntoperator= (const TEveRefCnt &)
 

Protected Attributes

Color_t fBackColor
 
UChar_t fBackRGBA [4]
 
Bool_t fDrawBack
 
Color_t fFrameColor
 
Bool_t fFrameFill
 
Float_tfFramePoints
 
UChar_t fFrameRGBA [4]
 
Int_t fFrameSize
 
EFrameType_e fFrameType
 
Float_t fFrameWidth
 
- Protected Attributes inherited from TEveRefBackPtr
RefMap_t fBackRefs
 
- Protected Attributes inherited from TEveRefCnt
Int_t fRefCount
 

Private Member Functions

 TEveFrameBox (const TEveFrameBox &)
 
TEveFrameBoxoperator= (const TEveFrameBox &)
 

Friends

class TEveFrameBoxGL
 

Additional Inherited Members

- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Protected Types inherited from TEveRefBackPtr
typedef RefMap_t::iterator RefMap_i
 
typedef std::map< TEveElement *, Int_tRefMap_t
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
void MakeZombie ()
 

#include <TEveFrameBox.h>

Inheritance diagram for TEveFrameBox:
[legend]

Member Enumeration Documentation

◆ EFrameType_e

Enumerator
kFT_None 
kFT_Quad 
kFT_Box 

Definition at line 23 of file TEveFrameBox.h.

Constructor & Destructor Documentation

◆ TEveFrameBox() [1/2]

TEveFrameBox::TEveFrameBox ( const TEveFrameBox )
private

◆ TEveFrameBox() [2/2]

TEveFrameBox::TEveFrameBox ( )

Definition at line 25 of file TEveFrameBox.cxx.

◆ ~TEveFrameBox()

TEveFrameBox::~TEveFrameBox ( )
virtual

Destructor.

Definition at line 45 of file TEveFrameBox.cxx.

Member Function Documentation

◆ GetBackColor()

Color_t TEveFrameBox::GetBackColor ( ) const
inline

Definition at line 74 of file TEveFrameBox.h.

◆ GetBackRGBA()

UChar_t* TEveFrameBox::GetBackRGBA ( )
inline

Definition at line 76 of file TEveFrameBox.h.

◆ GetDrawBack()

Bool_t TEveFrameBox::GetDrawBack ( ) const
inline

Definition at line 85 of file TEveFrameBox.h.

◆ GetFrameColor()

Color_t TEveFrameBox::GetFrameColor ( ) const
inline

Definition at line 66 of file TEveFrameBox.h.

◆ GetFrameFill()

Bool_t TEveFrameBox::GetFrameFill ( ) const
inline

Definition at line 82 of file TEveFrameBox.h.

◆ GetFramePoints()

Float_t* TEveFrameBox::GetFramePoints ( ) const
inline

Definition at line 61 of file TEveFrameBox.h.

◆ GetFrameRGBA()

UChar_t* TEveFrameBox::GetFrameRGBA ( )
inline

Definition at line 68 of file TEveFrameBox.h.

◆ GetFrameSize()

Int_t TEveFrameBox::GetFrameSize ( ) const
inline

Definition at line 60 of file TEveFrameBox.h.

◆ GetFrameType()

EFrameType_e TEveFrameBox::GetFrameType ( ) const
inline

Definition at line 59 of file TEveFrameBox.h.

◆ GetFrameWidth()

Float_t TEveFrameBox::GetFrameWidth ( ) const
inline

Definition at line 63 of file TEveFrameBox.h.

◆ operator=()

TEveFrameBox& TEveFrameBox::operator= ( const TEveFrameBox )
private

◆ PtrBackColor()

Color_t* TEveFrameBox::PtrBackColor ( )
inline

Definition at line 75 of file TEveFrameBox.h.

◆ PtrFrameColor()

Color_t* TEveFrameBox::PtrFrameColor ( )
inline

Definition at line 67 of file TEveFrameBox.h.

◆ SetAABox()

void TEveFrameBox::SetAABox ( Float_t  x,
Float_t  y,
Float_t  z,
Float_t  dx,
Float_t  dy,
Float_t  dz 
)

Setup for axis-aligned box with one corner at x, y, z and given sizes in x (dx), y (dy) and z (dz).

Definition at line 105 of file TEveFrameBox.cxx.

◆ SetAABoxCenterHalfSize()

void TEveFrameBox::SetAABoxCenterHalfSize ( Float_t  x,
Float_t  y,
Float_t  z,
Float_t  dx,
Float_t  dy,
Float_t  dz 
)

Setup for axis-aligned box with center at x, y, z and given half-sizes in x (dx), y (dy) and z (dz).

Definition at line 130 of file TEveFrameBox.cxx.

◆ SetAAQuadXY()

void TEveFrameBox::SetAAQuadXY ( Float_t  x,
Float_t  y,
Float_t  z,
Float_t  dx,
Float_t  dy 
)

Setup for axis-aligned rectangle with one corner at x, y, z and given sizes in x (dx) and y (dy).

Definition at line 54 of file TEveFrameBox.cxx.

◆ SetAAQuadXZ()

void TEveFrameBox::SetAAQuadXZ ( Float_t  x,
Float_t  y,
Float_t  z,
Float_t  dx,
Float_t  dz 
)

Setup for axis-aligned rectangle with one corner at x, y, z and given sizes in x (dx) and z (dz).

Definition at line 72 of file TEveFrameBox.cxx.

◆ SetBackColor()

void TEveFrameBox::SetBackColor ( Color_t  ci)

Set color of the background polygon.

Definition at line 183 of file TEveFrameBox.cxx.

◆ SetBackColorPixel()

void TEveFrameBox::SetBackColorPixel ( Pixel_t  pix)

Set color of the background polygon.

Definition at line 192 of file TEveFrameBox.cxx.

◆ SetBackColorRGBA()

void TEveFrameBox::SetBackColorRGBA ( UChar_t  r,
UChar_t  g,
UChar_t  b,
UChar_t  a = 255 
)

Set color of the background polygon.

Definition at line 200 of file TEveFrameBox.cxx.

◆ SetDrawBack()

void TEveFrameBox::SetDrawBack ( Bool_t  f)
inline

Definition at line 86 of file TEveFrameBox.h.

◆ SetFrameColor()

void TEveFrameBox::SetFrameColor ( Color_t  ci)

Set color of the frame.

Definition at line 154 of file TEveFrameBox.cxx.

◆ SetFrameColorPixel()

void TEveFrameBox::SetFrameColorPixel ( Pixel_t  pix)

Set color of the frame.

Definition at line 163 of file TEveFrameBox.cxx.

◆ SetFrameColorRGBA()

void TEveFrameBox::SetFrameColorRGBA ( UChar_t  r,
UChar_t  g,
UChar_t  b,
UChar_t  a = 255 
)

Set color of the frame.

Definition at line 171 of file TEveFrameBox.cxx.

◆ SetFrameFill()

void TEveFrameBox::SetFrameFill ( Bool_t  f)
inline

Definition at line 83 of file TEveFrameBox.h.

◆ SetFrameWidth()

void TEveFrameBox::SetFrameWidth ( Float_t  f)
inline

Definition at line 64 of file TEveFrameBox.h.

◆ SetQuadByPoints()

void TEveFrameBox::SetQuadByPoints ( const Float_t pointArr,
Int_t  nPoints 
)

Setup frame with explicitly given corner coordinates.

Arguments:

  • pointArr - array containing the 3D points
  • nPoint - number of points, size of array divided by 3

Definition at line 92 of file TEveFrameBox.cxx.

Friends And Related Function Documentation

◆ TEveFrameBoxGL

friend class TEveFrameBoxGL
friend

Definition at line 20 of file TEveFrameBox.h.

Member Data Documentation

◆ fBackColor

Color_t TEveFrameBox::fBackColor
protected

Definition at line 36 of file TEveFrameBox.h.

◆ fBackRGBA

UChar_t TEveFrameBox::fBackRGBA[4]
protected

Definition at line 38 of file TEveFrameBox.h.

◆ fDrawBack

Bool_t TEveFrameBox::fDrawBack
protected

Definition at line 40 of file TEveFrameBox.h.

◆ fFrameColor

Color_t TEveFrameBox::fFrameColor
protected

Definition at line 35 of file TEveFrameBox.h.

◆ fFrameFill

Bool_t TEveFrameBox::fFrameFill
protected

Definition at line 39 of file TEveFrameBox.h.

◆ fFramePoints

Float_t* TEveFrameBox::fFramePoints
protected

Definition at line 32 of file TEveFrameBox.h.

◆ fFrameRGBA

UChar_t TEveFrameBox::fFrameRGBA[4]
protected

Definition at line 37 of file TEveFrameBox.h.

◆ fFrameSize

Int_t TEveFrameBox::fFrameSize
protected

Definition at line 31 of file TEveFrameBox.h.

◆ fFrameType

EFrameType_e TEveFrameBox::fFrameType
protected

Definition at line 30 of file TEveFrameBox.h.

◆ fFrameWidth

Float_t TEveFrameBox::fFrameWidth
protected

Definition at line 34 of file TEveFrameBox.h.

Libraries for TEveFrameBox:
[legend]

The documentation for this class was generated from the following files: