Quick Links: ROOT Homepage Class Index Class Hierarchy

Source: header file source file viewVC header viewVC source

Sections: class description function members data members class charts

class TGLViewerBase: public TGLLockable


 Base class for GL viewers. Provides a basic scene management and a
 small set of control variables (camera, LOD, style, clip) that are
 used by the scene classes. Renering wrappers are available but
 minimal.

 There is no concept of GL-context here ... we just draw
 into whatever is set from outside.

 Development notes:

 Each viewer automatically creates a TGLRnrCtx and passes it down
 all render functions.

Function Members (Methods)

public:

	TGLViewerBase()
virtual	~TGLViewerBase()
virtual void	AddOverlayElement(TGLOverlayElement* el)
TGLSceneInfo*	AddScene(TGLSceneBase* scene)
virtual void	Changed()
static TClass*	Class()
TGLClip*	Clip() const
TGLLockable::ELock	TGLLockable::CurrentLock() const
virtual void	DeleteOverlayAnnotations()
virtual void	DeleteOverlayElements(TGLOverlayElement::ERole r)
Bool_t	FindClosestOpaqueRecord(TGLSelectRecord& rec, Int_t& recIdx)
Bool_t	FindClosestOverlayRecord(TGLOvlSelectRecord& rec, Int_t& recIdx)
Bool_t	FindClosestRecord(TGLSelectRecord& rec, Int_t& recIdx)
TGLLogicalShape*	FindLogicalInScenes(TObject* id)
TGLRnrCtx*	GetRnrCtx() const
TGLSceneInfo*	GetSceneInfo(TGLSceneBase* scene)
virtual TClass*	IsA() const
virtual Bool_t	IsChanged() const
Bool_t	TGLLockable::IsDrawOrSelectLock() const
Bool_t	TGLLockable::IsLocked() const
virtual const char*	LockIdStr() const
static const char*	TGLLockable::LockName(TGLLockable::ELock lock)
static Bool_t	TGLLockable::LockValid(TGLLockable::ELock lock)
Short_t	LOD() const
virtual void	MergeSceneBBoxes(TGLBoundingBox& bbox)
Float_t	OLLineW() const
virtual void	PostRender()
virtual void	PostRenderOverlaySelection()
virtual void	PreRender()
virtual void	PreRenderOverlaySelection()
Bool_t	TGLLockable::ReleaseLock(TGLLockable::ELock lock) const
void	RemoveAllScenes()
virtual void	RemoveOverlayElement(TGLOverlayElement* el)
void	RemoveScene(TGLSceneBase* scene)
virtual void	Render()
virtual void	RenderNonSelected()
virtual void	RenderOpaque(Bool_t rnr_non_selected = kTRUE, Bool_t rnr_selected = kTRUE)
virtual void	RenderOverlay(Int_t state, Bool_t selection)
virtual void	RenderSelected()
virtual void	RenderSelectedForHighlight()
virtual void	RenderTransparent(Bool_t rnr_non_selected = kTRUE, Bool_t rnr_selected = kTRUE)
virtual void	ResetSceneInfos()
Bool_t	ResolveSelectRecord(TGLSelectRecord& rec, Int_t recIdx)
TGLRnrCtx&	RnrCtx() const
void	SceneDestructing(TGLSceneBase* scene)
void	SetClip(TGLClip* p)
void	SetLOD(Short_t lod)
void	SetOLLineW(Float_t w)
void	SetStyle(Short_t st)
void	SetWFLineW(Float_t w)
virtual void	ShowMembers(TMemberInspector&)
virtual void	Streamer(TBuffer&)
void	StreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
Short_t	Style() const
Bool_t	TGLLockable::TakeLock(TGLLockable::ELock lock) const
Float_t	WFLineW() const

protected:

TGLViewerBase::SceneInfoList_i	FindScene(TGLSceneBase* scene)
virtual void	SetupClipObject()
void	SubRenderScenes(TGLViewerBase::SubRender_foo render_foo)

private:

	TGLViewerBase(const TGLViewerBase&)
TGLViewerBase&	operator=(const TGLViewerBase&)

Data Members

public:

enum TGLLockable::ELock {	kUnlocked
	kDrawLock
	kSelectLock
	kModifyLock
};

protected:

TGLCamera*	fCamera	Camera for rendering.
Bool_t	fChanged	Change requiring redraw is pending.
TGLClip*	fClip	Viewer clipping-plane.
Short_t	fLOD	Viewer-lod for rendering.
TGLLockable::ELock	TGLLockable::fLock	Lock state.
Float_t	fOLLineW	Optional override of scene outline line-width
TGLBoundingBox	fOverallBoundingBox	Axis-aligned union of scene bboxes.
vector<TGLOverlayElement*>	fOverlay
Bool_t	fResetSceneInfosOnRender	Request rebuild of view-specific scene data.
TGLRnrCtx*	fRnrCtx
list<TGLSceneInfo*>	fScenes	Registered scenes.
Short_t	fStyle	Viewer-style for rendering.
vector<TGLSceneInfo*>	fVisScenes	Visible scenes.
Float_t	fWFLineW	Optional override of scene wire-frame line-width

Class Charts

Inheritance Inherited Members Includes Libraries

Function documentation

TGLViewerBase()

 Constructor.

~TGLViewerBase()

 Destructor.

const char* LockIdStr() const

 Name to print in locking output.

FindScene(TGLSceneBase* scene)

 Find scene-info corresponding to scene.

TGLSceneInfo* AddScene(TGLSceneBase* scene)

 Add new scene, appropriate scene-info is created.

void RemoveScene(TGLSceneBase* scene)

 Remove scene from the viewer, its scene-info is deleted.

void RemoveAllScenes()

 Remove all scenes from the viewer, their scene-infos are deleted.

void SceneDestructing(TGLSceneBase* scene)

 Remove scene, its scene-info is deleted.
 Called from scene that is being destroyed while still holding
 viewer references.

TGLSceneInfo* GetSceneInfo(TGLSceneBase* scene)

 Find scene-info corresponding to scene.

TGLLogicalShape* FindLogicalInScenes(TObject* id)

 Find logical-shape representing object id in the list of scenes.
 Return 0 if not found.

void AddOverlayElement(TGLOverlayElement* el)

 Add overlay element.

void RemoveOverlayElement(TGLOverlayElement* el)

 Remove overlay element.

void DeleteOverlayAnnotations()

 Delete overlay elements that are annotations.

void DeleteOverlayElements(TGLOverlayElement::ERole r)

 Delete overlay elements.

void ResetSceneInfos()

 Force rebuild of view-dependent scene-info structures.

 This should be called before calling render (draw/select) if
 something that affects camera interest has been changed.

void MergeSceneBBoxes(TGLBoundingBox& bbox)

 Merge bounding-boxes of all active registered scenes.

void SetupClipObject()

 Setup clip-object. Protected virtual method.

void PreRender()

 Initialize render-context, setup camera, GL, render-area.
 Check and lock scenes, determine their visibility.

void SubRenderScenes(TGLViewerBase::SubRender_foo render_foo)

 Call sub-rendering function render_foo on all currently visible
 scenes.

void Render()

 Render all scenes. This is done in two main passes:
 - render opaque objects from all scenes
 - render transparent objects from all scenes

void RenderNonSelected()

 Render non-selected objects from all scenes.

void RenderSelected()

 Render selected objects from all scenes.

void RenderSelectedForHighlight()

 Render selected objects from all scenes for highlight.

void RenderOpaque(Bool_t rnr_non_selected = kTRUE, Bool_t rnr_selected = kTRUE)

 Render opaque objects from all scenes.

void RenderTransparent(Bool_t rnr_non_selected = kTRUE, Bool_t rnr_selected = kTRUE)

 Render transparent objects from all scenes.

void RenderOverlay(Int_t state, Bool_t selection)

 Render overlay objects.

void PostRender()

 Function called after rendering is finished.
 Here we just unlock the scenes.

void PreRenderOverlaySelection()

 Perform minimal initialization for overlay selection.
 Here we assume that scene has already been drawn and that
 camera and overall bounding box are ok.
 Scenes are not locked.

void PostRenderOverlaySelection()

 Perform cleanup after overlay selection.

Bool_t ResolveSelectRecord(TGLSelectRecord& rec, Int_t recIdx)

 Process selection record on buffer-position 'recIdx' and
 fill the data into 'rec'.

 Returns TRUE if scene was demangled and an object identified.
 When FALSE is returned it is still possible that scene has been
 identified. Check for this if interested in scene-selection.

 The select-buffer is taken form fRnrCtx.

Bool_t FindClosestRecord(TGLSelectRecord& rec, Int_t& recIdx)

 Find next select record that can be resolved, starting from
 position 'recIdx'.
 'recIdx' is passed as reference and points to found record in the buffer.

Bool_t FindClosestOpaqueRecord(TGLSelectRecord& rec, Int_t& recIdx)

 Find next select record that can be resolved and whose result is
 not transparent, starting from position 'recIdx'.
 'recIdx' is passed as reference and points to found record in the buffer.

Bool_t FindClosestOverlayRecord(TGLOvlSelectRecord& rec, Int_t& recIdx)

 Find next overlay-select record that can be resolved, starting from
 position 'recIdx'.
 'recIdx' is passed as reference and points to found record in the buffer.

TGLViewerBase(const TGLViewerBase& )

TGLViewerBase& operator=(const TGLViewerBase& )

void SetClip(TGLClip* p)

{ fClip = p; }

Short_t LOD() const

{ return fLOD; }

void SetLOD(Short_t lod)

{ fLOD = lod; }

Short_t Style() const

{ return fStyle; }

void SetStyle(Short_t st)

{ fStyle = st; }