Logo ROOT   6.21/01
Reference Guide
TGLLogicalShape Class Referenceabstract

Abstract logical shape - a GL 'drawable' - base for all shapes - faceset sphere etc.

Logical shapes are a unique piece of geometry, described in it's local frame - e.g if we have three spheres in :

  • Sphere A - Radius r1, center v1
  • Sphere B - Radius r2, center v2
  • Sphere C - Radius r1, center v3

Spheres A and C can share a common logical sphere of radius r1 - and place them with two physicals with translations of v1 & v2. Sphere B requires a different logical (radius r2), placed with physical with translation v2.

Physical shapes know about and can share logicals. Logicals do not about (aside from reference counting) physicals or share them.

This sharing of logical shapes greatly reduces memory consumption and scene (re)build times in typical detector geometries which have many repeated objects placements.

TGLLogicalShapes have reference counting, performed by the client physical shapes which are using it.

Display list information is also stored here, possibly per LOD level. Most classes do not support LOD (only sphere and tube) and therefore reasonable defaults are encoded in the following virtual functions:

Int_t DLCacheSize() { return 1; }
UInt_t DLOffset(lod); // Transform lod into DL offset.
Short_t QuantizeShapeLOD(); // Quantize lod.

Classes that have per-LOD display-lists than override these functions. 'UShort_t fDLValid' is used as a bit-field determining validity of each quantized LOD-level; hopefully one will not have more than 16 LOD levels per class. See also: TGLPhysicalShape::CalculateShapeLOD() where LOD is calculated.

See base/src/TVirtualViewer3D for description of common external 3D viewer architecture and how external viewer clients use it.

Definition at line 29 of file TGLLogicalShape.h.

Public Types

enum  ELODAxes {
  kLODAxesNone = 0, kLODAxesX = 1 << 0, kLODAxesY = 1 << 1, kLODAxesZ = 1 << 2,
  kLODAxesAll = kLODAxesX | kLODAxesY | kLODAxesZ
}
 

Public Member Functions

 TGLLogicalShape ()
 global flag for usage of display-lists in shapes that use vertex arrays More...
 
 TGLLogicalShape (TObject *obj)
 Constructor with external object. More...
 
 TGLLogicalShape (const TBuffer3D &buffer)
 Constructor from TBuffer3D. More...
 
virtual ~TGLLogicalShape ()
 Destroy logical shape. More...
 
void AddRef (TGLPhysicalShape *phys) const
 Add reference to given physical shape. More...
 
virtual Bool_t AlwaysSecondarySelect () const
 
const TGLBoundingBoxBoundingBox () const
 
void DestroyPhysicals ()
 Destroy all physicals attached to this logical. More...
 
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. More...
 
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. More...
 
virtual void DLCachePurge ()
 Purge all entries for all LODs for this drawable from the display list cache, returning the reserved ids to GL context. More...
 
virtual UInt_t DLOffset (Short_t) const
 
virtual void Draw (TGLRnrCtx &rnrCtx) const
 Draw the GL drawable, using draw flags. More...
 
virtual void DrawHighlight (TGLRnrCtx &rnrCtx, const TGLPhysicalShape *pshp, Int_t lvl=-1) const
 Draw the logical shape in highlight mode. More...
 
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. More...
 
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'. More...
 
virtual Bool_t KeepDuringSmartRefresh () const
 
virtual void ProcessSelection (TGLRnrCtx &rnrCtx, TGLSelectRecord &rec)
 Virtual method called-back after a secondary selection hit is recorded (see TGLViewer::HandleButton(), Ctrl-Button1). More...
 
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. More...
 
UInt_t Ref () const
 
Bool_t SetDLCache (Bool_t cached)
 Modify capture of draws into display list cache kTRUE - capture, kFALSE direct draw. More...
 
virtual Bool_t ShouldDLCache (const TGLRnrCtx &rnrCtx) const
 Returns kTRUE if draws should be display list cached kFALSE otherwise. More...
 
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). More...
 
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. More...
 
virtual void UpdateBoundingBox ()
 
void UpdateBoundingBoxesOfPhysicals ()
 Update bounding-boxed of all dependent physicals. More...
 

Static Public Member Functions

static Bool_t GetIgnoreSizeForCameraInterest ()
 Get state of static fgIgnoreSizeForCameraInterest flag. More...
 
static void SetEnvDefaults ()
 
static void SetIgnoreSizeForCameraInterest (Bool_t isfci)
 Set state of static fgIgnoreSizeForCameraInterest flag. More...
 

Protected Member Functions

void PurgeDLRange (UInt_t base, Int_t size) const
 External object is a fake. More...
 

Protected Attributes

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

Static Protected Attributes

static Bool_t fgIgnoreSizeForCameraInterest = kFALSE
 
static Bool_t fgUseDLs = kTRUE
 
static Bool_t fgUseDLsForVertArrs = kTRUE
 global flag for usage of display-lists More...
 

Private Member Functions

 TGLLogicalShape (const TGLLogicalShape &)
 
TGLLogicalShapeoperator= (const TGLLogicalShape &)
 

Friends

class TGLScene
 

#include <TGLLogicalShape.h>

Inheritance diagram for TGLLogicalShape:
[legend]

Member Enumeration Documentation

◆ ELODAxes

Enumerator
kLODAxesNone 
kLODAxesX 
kLODAxesY 
kLODAxesZ 
kLODAxesAll 

Definition at line 38 of file TGLLogicalShape.h.

Constructor & Destructor Documentation

◆ TGLLogicalShape() [1/4]

TGLLogicalShape::TGLLogicalShape ( const TGLLogicalShape )
private

◆ TGLLogicalShape() [2/4]

TGLLogicalShape::TGLLogicalShape ( )

global flag for usage of display-lists in shapes that use vertex arrays

Constructor.

Definition at line 74 of file TGLLogicalShape.cxx.

◆ TGLLogicalShape() [3/4]

TGLLogicalShape::TGLLogicalShape ( TObject obj)

Constructor with external object.

Definition at line 91 of file TGLLogicalShape.cxx.

◆ TGLLogicalShape() [4/4]

TGLLogicalShape::TGLLogicalShape ( const TBuffer3D buffer)

Constructor from TBuffer3D.

Definition at line 108 of file TGLLogicalShape.cxx.

◆ ~TGLLogicalShape()

TGLLogicalShape::~TGLLogicalShape ( )
virtual

Destroy logical shape.

Definition at line 140 of file TGLLogicalShape.cxx.

Member Function Documentation

◆ AddRef()

void TGLLogicalShape::AddRef ( TGLPhysicalShape phys) const

Add reference to given physical shape.

Definition at line 163 of file TGLLogicalShape.cxx.

◆ AlwaysSecondarySelect()

virtual Bool_t TGLLogicalShape::AlwaysSecondarySelect ( ) const
inlinevirtual

Reimplemented in TEveCaloLegoGL, TEveCalo2DGL, TEveCalo3DGL, and TEveDigitSetGL.

Definition at line 111 of file TGLLogicalShape.h.

◆ BoundingBox()

const TGLBoundingBox& TGLLogicalShape::BoundingBox ( ) const
inline

Definition at line 86 of file TGLLogicalShape.h.

◆ DestroyPhysicals()

void TGLLogicalShape::DestroyPhysicals ( )

Destroy all physicals attached to this logical.

Definition at line 206 of file TGLLogicalShape.cxx.

◆ DirectDraw()

◆ DLCacheClear()

void TGLLogicalShape::DLCacheClear ( )
virtual

Clear all entries for all LODs for this drawable from the display list cache but keeping the reserved ids from GL context.

Reimplemented in TEveJetConeGL.

Definition at line 303 of file TGLLogicalShape.cxx.

◆ DLCacheDrop()

void TGLLogicalShape::DLCacheDrop ( )
virtual

Drop all entries for all LODs for this drawable from the display list cache, WITHOUT returning the reserved ids to GL context.

This is called by scene if it realized that the GL context was destroyed.

Reimplemented in TEveCaloLegoGL, and TEveBoxSetGL.

Definition at line 315 of file TGLLogicalShape.cxx.

◆ DLCachePurge()

void TGLLogicalShape::DLCachePurge ( )
virtual

Purge all entries for all LODs for this drawable from the display list cache, returning the reserved ids to GL context.

If you override this function:

  1. call the base-class version from it;
  2. call it from the destructor of the derived class!

Reimplemented in TEveCaloLegoGL, and TEveBoxSetGL.

Definition at line 329 of file TGLLogicalShape.cxx.

◆ DLOffset()

virtual UInt_t TGLLogicalShape::DLOffset ( Short_t  ) const
inlinevirtual

Reimplemented in TGLCylinder, and TGLSphere.

Definition at line 93 of file TGLLogicalShape.h.

◆ Draw()

void TGLLogicalShape::Draw ( TGLRnrCtx rnrCtx) const
virtual

Draw the GL drawable, using draw flags.

If DL caching is enabled (see SetDLCache) then attempt to draw from the cache, if not found attempt to capture the draw - done by DirectDraw() - into a new cache entry. If not cached just call DirectDraw() for normal non DL cached drawing.

Reimplemented in TEveBoxProjectedGL, TEveJetConeProjectedGL, TEveJetConeGL, TEvePolygonSetProjectedGL, TEveBoxGL, TEveProjectionAxesGL, TEveStraightLineSetGL, and TPointSet3DGL.

Definition at line 374 of file TGLLogicalShape.cxx.

◆ DrawHighlight()

void TGLLogicalShape::DrawHighlight ( TGLRnrCtx rnrCtx,
const TGLPhysicalShape pshp,
Int_t  lvl = -1 
) const
virtual

Draw the logical shape in highlight mode.

If lvl argument is less than 0 (-1 by default), the index into color-set is taken from the physical shape itself.

Reimplemented in TEveCaloLegoGL, TEveCalo2DGL, TEvePolygonSetProjectedGL, TEveCalo3DGL, and TEveDigitSetGL.

Definition at line 428 of file TGLLogicalShape.cxx.

◆ GetExternal()

TObject* TGLLogicalShape::GetExternal ( ) const
inline

Definition at line 83 of file TGLLogicalShape.h.

◆ GetFirstPhysical()

const TGLPhysicalShape* TGLLogicalShape::GetFirstPhysical ( ) const
inline

Definition at line 80 of file TGLLogicalShape.h.

◆ GetIgnoreSizeForCameraInterest()

Bool_t TGLLogicalShape::GetIgnoreSizeForCameraInterest ( )
static

Get state of static fgIgnoreSizeForCameraInterest flag.

When this is true all objects, also very small, will be drawn by GL.

Definition at line 481 of file TGLLogicalShape.cxx.

◆ GetScene()

TGLScene* TGLLogicalShape::GetScene ( ) const
inline

Definition at line 84 of file TGLLogicalShape.h.

◆ ID()

TObject* TGLLogicalShape::ID ( ) const
inline

Definition at line 82 of file TGLLogicalShape.h.

◆ IgnoreSizeForOfInterest()

Bool_t TGLLogicalShape::IgnoreSizeForOfInterest ( ) const
virtual

Return true if size of this shape should be ignored when determining if the object should be drawn.

In this base-class we simply return state of static flag fgIgnoreSizeForCameraInterest.

Several sub-classes override this virtual function.

Reimplemented in TEveBoxProjectedGL, TEvePolygonSetProjectedGL, TEveBoxGL, TEveProjectionAxesGL, TEveStraightLineSetGL, TEveQuadSetGL, TGLPolyMarker, and TPointSet3DGL.

Definition at line 472 of file TGLLogicalShape.cxx.

◆ InvokeContextMenu()

void TGLLogicalShape::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'.

Definition at line 458 of file TGLLogicalShape.cxx.

◆ KeepDuringSmartRefresh()

virtual Bool_t TGLLogicalShape::KeepDuringSmartRefresh ( ) const
inlinevirtual

Reimplemented in TGLObject, TGLPlot3D, TF2GL, TGLParametricEquationGL, and TEvePlot3DGL.

Definition at line 108 of file TGLLogicalShape.h.

◆ operator=()

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

◆ ProcessSelection()

void TGLLogicalShape::ProcessSelection ( TGLRnrCtx rnrCtx,
TGLSelectRecord rec 
)
virtual

Virtual method called-back after a secondary selection hit is recorded (see TGLViewer::HandleButton(), Ctrl-Button1).

The ptr argument holds the GL pick-record of the closest hit.

This base-class implementation simply prints out the result.

Reimplemented in TEveCaloLegoGL, TEveCalo2DGL, TEveCalo3DGL, TEveDigitSetGL, TEveStraightLineSetGL, TEveTrackGL, and TPointSet3DGL.

Definition at line 445 of file TGLLogicalShape.cxx.

◆ PurgeDLRange()

void TGLLogicalShape::PurgeDLRange ( UInt_t  base,
Int_t  size 
) const
protected

External object is a fake.

Purge given display-list range.

Utility function.

Definition at line 343 of file TGLLogicalShape.cxx.

◆ QuantizeShapeLOD()

Short_t TGLLogicalShape::QuantizeShapeLOD ( Short_t  shapeLOD,
Short_t  combiLOD 
) const
virtual

Logical shapes usually support only discreet LOD values, especially in view of display-list caching.

This function should be overriden to perform the desired quantization. See TGLSphere.

Reimplemented in TGLCylinder, and TGLSphere.

Definition at line 362 of file TGLLogicalShape.cxx.

◆ Ref()

UInt_t TGLLogicalShape::Ref ( ) const
inline

Definition at line 73 of file TGLLogicalShape.h.

◆ SetDLCache()

Bool_t TGLLogicalShape::SetDLCache ( Bool_t  cache)

Modify capture of draws into display list cache kTRUE - capture, kFALSE direct draw.

Return kTRUE is state changed, kFALSE if not.

Definition at line 265 of file TGLLogicalShape.cxx.

◆ SetEnvDefaults()

void TGLLogicalShape::SetEnvDefaults ( )
static

Definition at line 497 of file TGLLogicalShape.cxx.

◆ SetIgnoreSizeForCameraInterest()

void TGLLogicalShape::SetIgnoreSizeForCameraInterest ( Bool_t  isfci)
static

Set state of static fgIgnoreSizeForCameraInterest flag.

Definition at line 489 of file TGLLogicalShape.cxx.

◆ ShouldDLCache()

Bool_t TGLLogicalShape::ShouldDLCache ( const TGLRnrCtx rnrCtx) const
virtual

Returns kTRUE if draws should be display list cached kFALSE otherwise.

Here we check that: a) fScene is set (Scene manages link to GL-context); b) secondary selection is not in progress as different render-path is usually taken in this case.

Otherwise we return internal bool.

Override this in sub-class if different behaviour is required.

Reimplemented in TGLObject, TEveCalo3DGL, TEveStraightLineSetGL, TEveBoxSetGL, and TPointSet3DGL.

Definition at line 289 of file TGLLogicalShape.cxx.

◆ StrongRef()

void TGLLogicalShape::StrongRef ( Bool_t  strong) const
inline

Definition at line 76 of file TGLLogicalShape.h.

◆ SubRef()

void TGLLogicalShape::SubRef ( TGLPhysicalShape phys) const

Remove reference to given physical shape, potentially deleting this object when hitting zero ref-count (if fRefStrong is true).

Definition at line 175 of file TGLLogicalShape.cxx.

◆ SupportedLODAxes()

virtual ELODAxes TGLLogicalShape::SupportedLODAxes ( ) const
inlinevirtual

Reimplemented in TGLCylinder, and TGLSphere.

Definition at line 98 of file TGLLogicalShape.h.

◆ SupportsSecondarySelect()

virtual Bool_t TGLLogicalShape::SupportsSecondarySelect ( ) const
inlinevirtual

◆ UnrefFirstPhysical()

UInt_t TGLLogicalShape::UnrefFirstPhysical ( )

Unreferenced first physical in the list, returning its id and making it fit for destruction somewhere else.

Returns 0 if there are no replicas attached.

Definition at line 226 of file TGLLogicalShape.cxx.

◆ UpdateBoundingBox()

virtual void TGLLogicalShape::UpdateBoundingBox ( )
inlinevirtual

Reimplemented in TGLObject.

Definition at line 87 of file TGLLogicalShape.h.

◆ UpdateBoundingBoxesOfPhysicals()

void TGLLogicalShape::UpdateBoundingBoxesOfPhysicals ( )

Update bounding-boxed of all dependent physicals.

Definition at line 246 of file TGLLogicalShape.cxx.

Friends And Related Function Documentation

◆ TGLScene

friend class TGLScene
friend

Definition at line 31 of file TGLLogicalShape.h.

Member Data Documentation

◆ fBoundingBox

TGLBoundingBox TGLLogicalShape::fBoundingBox
protected

Also plays the role of ID.

Definition at line 50 of file TGLLogicalShape.h.

◆ fDLBase

UInt_t TGLLogicalShape::fDLBase
mutableprotected

scene where object is stored (can be zero!)

Definition at line 52 of file TGLLogicalShape.h.

◆ fDLCache

Bool_t TGLLogicalShape::fDLCache
mutableprotected

display-list validity bit-field

Definition at line 55 of file TGLLogicalShape.h.

◆ fDLSize

Int_t TGLLogicalShape::fDLSize
mutableprotected

display-list id base

Definition at line 53 of file TGLLogicalShape.h.

◆ fDLValid

UShort_t TGLLogicalShape::fDLValid
mutableprotected

display-list size for different LODs

Definition at line 54 of file TGLLogicalShape.h.

◆ fExternalObj

TObject* TGLLogicalShape::fExternalObj
protected

first replica

Definition at line 49 of file TGLLogicalShape.h.

◆ fFirstPhysical

TGLPhysicalShape* TGLLogicalShape::fFirstPhysical
mutableprotected

physical instance ref counting

Definition at line 47 of file TGLLogicalShape.h.

◆ fgIgnoreSizeForCameraInterest

Bool_t TGLLogicalShape::fgIgnoreSizeForCameraInterest = kFALSE
staticprotected

Definition at line 61 of file TGLLogicalShape.h.

◆ fgUseDLs

Bool_t TGLLogicalShape::fgUseDLs = kTRUE
staticprotected

Definition at line 63 of file TGLLogicalShape.h.

◆ fgUseDLsForVertArrs

Bool_t TGLLogicalShape::fgUseDLsForVertArrs = kTRUE
staticprotected

global flag for usage of display-lists

Definition at line 64 of file TGLLogicalShape.h.

◆ fOwnExtObj

Bool_t TGLLogicalShape::fOwnExtObj
mutableprotected

Strong ref (delete on 0 ref); not in scene.

Definition at line 57 of file TGLLogicalShape.h.

◆ fRef

UInt_t TGLLogicalShape::fRef
mutableprotected

Definition at line 46 of file TGLLogicalShape.h.

◆ fRefStrong

Bool_t TGLLogicalShape::fRefStrong
mutableprotected

use display list caching

Definition at line 56 of file TGLLogicalShape.h.

◆ fScene

TGLScene* TGLLogicalShape::fScene
mutableprotected

Shape's bounding box.

Definition at line 51 of file TGLLogicalShape.h.

Libraries for TGLLogicalShape:
[legend]

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