Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TGLObject Class Referenceabstract

Base-class for direct OpenGL renderers.

This allows classes to circumvent passing of TBuffer3D and use user-provided OpenGL code. By convention, if you want class TFoo : public TObject to have direct rendering you should also provide TFooGL : public TGLObject and implement abstract functions SetModel() and SetBBox(). TAttBBox can be used to facilitate calculation of bounding-boxes. See TPointSet3D and TPointSet3DGL.

Definition at line 21 of file TGLObject.h.

Public Member Functions

 TGLObject ()
 
 ~TGLObject () override
 
TClassIsA () const override
 
Bool_t KeepDuringSmartRefresh () const override
 
virtual void SetBBox ()=0
 
virtual Bool_t SetModel (TObject *obj, const Option_t *opt=nullptr)=0
 
Bool_t ShouldDLCache (const TGLRnrCtx &rnrCtx) const override
 Decide if display-list should be used for this pass rendering, as determined by rnrCtx.
 
void Streamer (TBuffer &) override
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
void UpdateBoundingBox () override
 Update bounding box from external source.
 
- Public Member Functions inherited from TGLLogicalShape
 TGLLogicalShape ()
 global flag for usage of display-lists in shapes that use vertex arrays
 
 TGLLogicalShape (const TBuffer3D &buffer)
 Constructor from TBuffer3D.
 
 TGLLogicalShape (TObject *obj)
 Constructor with external object.
 
virtual ~TGLLogicalShape ()
 Destroy logical shape.
 
void AddRef (TGLPhysicalShape *phys) const
 Add reference to given physical shape.
 
virtual Bool_t AlwaysSecondarySelect () const
 
const TGLBoundingBoxBoundingBox () const
 
void DestroyPhysicals ()
 Destroy all physicals attached to this logical.
 
virtual void DirectDraw (TGLRnrCtx &rnrCtx) const =0
 
virtual void DLCacheClear ()
 Clear all entries for all LODs for this drawable from the display list cache but keeping the reserved ids from GL context.
 
virtual void DLCacheDrop ()
 Drop all entries for all LODs for this drawable from the display list cache, WITHOUT returning the reserved ids to GL context.
 
virtual void DLCachePurge ()
 Purge all entries for all LODs for this drawable from the display list cache, returning the reserved ids to GL context.
 
virtual UInt_t DLOffset (Short_t) const
 
virtual void Draw (TGLRnrCtx &rnrCtx) const
 Draw the GL drawable, using draw flags.
 
virtual void DrawHighlight (TGLRnrCtx &rnrCtx, const TGLPhysicalShape *pshp, Int_t lvl=-1) const
 Draw the logical shape in highlight mode.
 
TObjectGetExternal () const
 
const TGLPhysicalShapeGetFirstPhysical () const
 
TGLSceneGetScene () const
 
TObjectID () const
 
virtual Bool_t IgnoreSizeForOfInterest () const
 Return true if size of this shape should be ignored when determining if the object should be drawn.
 
void InvokeContextMenu (TContextMenu &menu, UInt_t x, UInt_t y) const
 Invoke popup menu or our bound external TObject (if any), using passed 'menu' object, at location 'x' 'y'.
 
virtual void ProcessSelection (TGLRnrCtx &rnrCtx, TGLSelectRecord &rec)
 Virtual method called-back after a secondary selection hit is recorded (see TGLViewer::HandleButton(), Ctrl-Button1).
 
virtual Short_t QuantizeShapeLOD (Short_t shapeLOD, Short_t combiLOD) const
 Logical shapes usually support only discreet LOD values, especially in view of display-list caching.
 
UInt_t Ref () const
 
Bool_t SetDLCache (Bool_t cached)
 Modify capture of draws into display list cache kTRUE - capture, kFALSE direct draw.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
void StrongRef (Bool_t strong) const
 
void SubRef (TGLPhysicalShape *phys) const
 Remove reference to given physical shape, potentially deleting this object when hitting zero ref-count (if fRefStrong is true).
 
virtual ELODAxes SupportedLODAxes () const
 
virtual Bool_t SupportsSecondarySelect () const
 
UInt_t UnrefFirstPhysical ()
 Unreferenced first physical in the list, returning its id and making it fit for destruction somewhere else.
 
void UpdateBoundingBoxesOfPhysicals ()
 Update bounding-boxed of all dependent physicals.
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static TClassGetGLRenderer (TClass *isa)
 Return direct-rendering GL class for class isa.
 
- Static Public Member Functions inherited from TGLLogicalShape
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Bool_t GetIgnoreSizeForCameraInterest ()
 Get state of static fgIgnoreSizeForCameraInterest flag.
 
static void SetEnvDefaults ()
 
static void SetIgnoreSizeForCameraInterest (Bool_t isfci)
 Set state of static fgIgnoreSizeForCameraInterest flag.
 

Protected Member Functions

template<class TT >
TT * DynCast (TObject *obj)
 
void SetAxisAlignedBBox (const Float_t *p)
 Set axis-aligned bounding-box.
 
void SetAxisAlignedBBox (Float_t xmin, Float_t xmax, Float_t ymin, Float_t ymax, Float_t zmin, Float_t zmax)
 Set axis-aligned bounding-box.
 
Bool_t SetModelCheckClass (TObject *obj, TClass *cls)
 Checks if obj is of proper class and sets the model.
 
template<class TT >
TT * SetModelDynCast (TObject *obj)
 
- Protected Member Functions inherited from TGLLogicalShape
void PurgeDLRange (UInt_t base, Int_t size) const
 External object is a fake.
 

Protected Attributes

Bool_t fMultiColor
 
- Protected Attributes inherited from TGLLogicalShape
TGLBoundingBox fBoundingBox
 Also plays the role of ID.
 
UInt_t fDLBase
 scene where object is stored (can be zero!)
 
Bool_t fDLCache
 display-list validity bit-field
 
Int_t fDLSize
 display-list id base
 
UShort_t fDLValid
 display-list size for different LODs
 
TObjectfExternalObj
 first replica
 
TGLPhysicalShapefFirstPhysical
 physical instance ref counting
 
Bool_t fOwnExtObj
 Strong ref (delete on 0 ref); not in scene.
 
UInt_t fRef
 
Bool_t fRefStrong
 use display list caching
 
TGLScenefScene
 Shape's bounding box.
 

Static Private Member Functions

static TClassSearchGLRenderer (TClass *cls)
 Recursively search cls and its base classes for a GL-renderer class.
 

Static Private Attributes

static TMap fgGLClassMap
 

Additional Inherited Members

- Public Types inherited from TGLLogicalShape
enum  ELODAxes {
  kLODAxesNone = 0 , kLODAxesX = 1 << 0 , kLODAxesY = 1 << 1 , kLODAxesZ = 1 << 2 ,
  kLODAxesAll = kLODAxesX | kLODAxesY | kLODAxesZ
}
 
- Static Protected Attributes inherited from TGLLogicalShape
static Bool_t fgIgnoreSizeForCameraInterest = kFALSE
 
static Bool_t fgUseDLs = kTRUE
 
static Bool_t fgUseDLsForVertArrs = kTRUE
 global flag for usage of display-lists
 

#include <TGLObject.h>

Inheritance diagram for TGLObject:
[legend]

Constructor & Destructor Documentation

◆ TGLObject()

TGLObject::TGLObject ( )
inline

Definition at line 53 of file TGLObject.h.

◆ ~TGLObject()

TGLObject::~TGLObject ( )
inlineoverride

Definition at line 54 of file TGLObject.h.

Member Function Documentation

◆ Class()

static TClass * TGLObject::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * TGLObject::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t TGLObject::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 74 of file TGLObject.h.

◆ DeclFileName()

static const char * TGLObject::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 74 of file TGLObject.h.

◆ DynCast()

template<class TT >
TT * TGLObject::DynCast ( TObject obj)
inlineprotected

Definition at line 45 of file TGLObject.h.

◆ GetGLRenderer()

TClass * TGLObject::GetGLRenderer ( TClass isa)
static

Return direct-rendering GL class for class isa.

Zero is a valid response.

Definition at line 135 of file TGLObject.cxx.

◆ IsA()

TClass * TGLObject::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TGLLogicalShape.

Reimplemented in TGLParametricEquationGL, TGLPlot3D, TH3GL, and TPointSet3DGL.

Definition at line 74 of file TGLObject.h.

◆ KeepDuringSmartRefresh()

Bool_t TGLObject::KeepDuringSmartRefresh ( ) const
inlineoverridevirtual

Reimplemented from TGLLogicalShape.

Reimplemented in TGLParametricEquationGL, and TGLPlot3D.

Definition at line 62 of file TGLObject.h.

◆ SearchGLRenderer()

TClass * TGLObject::SearchGLRenderer ( TClass cls)
staticprivate

Recursively search cls and its base classes for a GL-renderer class.

Definition at line 108 of file TGLObject.cxx.

◆ SetAxisAlignedBBox() [1/2]

void TGLObject::SetAxisAlignedBBox ( const Float_t p)
protected

Set axis-aligned bounding-box.

Protected helper for subclasses.

Definition at line 98 of file TGLObject.cxx.

◆ SetAxisAlignedBBox() [2/2]

void TGLObject::SetAxisAlignedBBox ( Float_t  xmin,
Float_t  xmax,
Float_t  ymin,
Float_t  ymax,
Float_t  zmin,
Float_t  zmax 
)
protected

Set axis-aligned bounding-box.

Protected helper for subclasses.

Definition at line 86 of file TGLObject.cxx.

◆ SetBBox()

◆ SetModel()

◆ SetModelCheckClass()

Bool_t TGLObject::SetModelCheckClass ( TObject obj,
TClass cls 
)
protected

Checks if obj is of proper class and sets the model.

Protected helper for subclasses. Most sub-classes use exception-throwing SetModelDynCast() instead.

Definition at line 71 of file TGLObject.cxx.

◆ SetModelDynCast()

template<class TT >
TT * TGLObject::SetModelDynCast ( TObject obj)
inlineprotected

Definition at line 37 of file TGLObject.h.

◆ ShouldDLCache()

Bool_t TGLObject::ShouldDLCache ( const TGLRnrCtx rnrCtx) const
overridevirtual

Decide if display-list should be used for this pass rendering, as determined by rnrCtx.

Reimplemented from TGLLogicalShape.

Reimplemented in TPointSet3DGL.

Definition at line 41 of file TGLObject.cxx.

◆ Streamer()

void TGLObject::Streamer ( TBuffer )
overridevirtual

Reimplemented from TGLLogicalShape.

Reimplemented in TGLParametricEquationGL, TGLPlot3D, TH3GL, and TPointSet3DGL.

◆ StreamerNVirtual()

void TGLObject::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 74 of file TGLObject.h.

◆ UpdateBoundingBox()

void TGLObject::UpdateBoundingBox ( )
overridevirtual

Update bounding box from external source.

We call abstract SetBBox() and propagate the change to all attached physicals.

Reimplemented from TGLLogicalShape.

Definition at line 60 of file TGLObject.cxx.

Member Data Documentation

◆ fgGLClassMap

TMap TGLObject::fgGLClassMap
staticprivate

Definition at line 24 of file TGLObject.h.

◆ fMultiColor

Bool_t TGLObject::fMultiColor
mutableprotected

Definition at line 28 of file TGLObject.h.

Libraries for TGLObject:

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