REveViewer Reve representation of TGLViewer.

Definition at line 27 of file REveViewer.hxx.

Public Types
enum	EAxesType { kAxesNone , kAxesOrigin , kAxesEdge }

enum	ECameraType { kCameraPerspXOZ , kCameraOrthoXOY }

Public Types inherited from ROOT::Experimental::REveElement
typedef std::list< REveAunt * >	AuntList_t

enum	EChangeBits { kCBColorSelection = (1ULL << ( 0 )) , kCBTransBBox = (1ULL << ( 1 )) , kCBObjProps = (1ULL << ( 2 )) , kCBVisibility = (1ULL << ( 3 )) , kCBElementAdded = (1ULL << ( 4 )) }

typedef std::list< REveElement * >	List_t

typedef std::set< REveElement * >	Set_t

Public Member Functions
	REveViewer (const std::string &n="REveViewer", const std::string &t="")
	Constructor.

	~REveViewer () override
	Destructor.

virtual void	AddScene (REveScene *scene)
	Add 'scene' to the list of scenes.

void	ConnectClient ()
	Function called from MIR when user wants to stream unsubscribed view.

void	DisconnectClient ()
	Function called from MIR when user closes one of the viewer window.

ECameraType	GetCameraType () const

bool	GetMandatory ()

void	Redraw (Bool_t resetCameras=kFALSE)
	Redraw viewer immediately.

void	RemoveElementLocal (REveElement *el) override
	Remove element 'el' from the list of children and also remove appropriate GLScene from GLViewer's list of scenes.

void	RemoveElementsLocal () override
	Remove all children, forwarded to GLViewer.

void	SetAxesType (int)

void	SetBlackBackground (bool)

void	SetCameraType (ECameraType t)

void	SetMandatory (bool x)

Int_t	WriteCoreJson (nlohmann::json &cj, Int_t rnr_offset) override
	Stream Camera Info.

Public Member Functions inherited from ROOT::Experimental::REveElement
	REveElement (const REveElement &e)
	Copy constructor.

	REveElement (const std::string &name="", const std::string &title="")
	Default constructor.

virtual	~REveElement ()
	Destructor.

virtual Bool_t	AcceptElement (REveElement *el)
	Check if el can be added to this element.

virtual void	AddAunt (REveAunt *au)
	Add el into the list aunts.

virtual void	AddElement (REveElement *el)
	Add el to the list of children.

virtual void	AddStamp (UChar_t bits)
	Add (bitwise or) given stamps to fChangeBits.

virtual void	Annihilate ()
	Optimized destruction without check of reference-count.

virtual void	AnnihilateElements ()
	Annihilate elements.

Bool_t	ApplyVizTag (const TString &tag, const TString &fallback_tag="")
	Set the VizTag, find model-element from the VizDB and copy visualization-parameters from it.

virtual void	BuildRenderData ()
	Write transformation Matrix to render data.

virtual Bool_t	CanEditElement () const

virtual Bool_t	CanEditMainColor () const

virtual Bool_t	CanEditMainTrans () const

virtual Bool_t	CanEditMainTransparency () const

virtual void	CheckReferenceCount (const std::string &from="<unknown>")
	Check external references to this and eventually auto-destruct the render-element.

virtual void	ClearStamps ()

virtual void	CloneChildrenRecurse (REveElement *dest, Int_t level=0) const
	Clone children and attach them to the dest element.

virtual REveElement *	CloneElement () const
	Clone the element via copy constructor.

virtual REveElement *	CloneElementRecurse (Int_t level=0) const
	Clone elements and recurse 'level' deep over children.

virtual void	CopyVizParams (const REveElement *el)
	Copy visualization parameters from element el.

virtual void	CopyVizParamsFromDB ()
	Copy visualization parameters from the model-element fVizModel.

void	CSCApplyMainColorToAllChildren ()

void	CSCApplyMainColorToMatchingChildren ()

void	CSCApplyMainTransparencyToAllChildren ()

void	CSCApplyMainTransparencyToMatchingChildren ()

void	CSCImplySelectAllChildren ()

void	CSCTakeMotherAsMaster ()

void	DecDenyDestroy ()
	Decreases the deny-destroy count of the element.

void	DecImpliedSelected ()

virtual void	Destroy ()
	Destroy this element.

virtual void	DestroyElements ()
	Destroy all children of this element.

virtual void	DestroyMainTrans ()
	Destroy the main transformation matrix, it will always be taken as identity.

virtual void	DestroyOrWarn ()
	Destroy this element. Prints a warning if deny-destroy is in force.

void	DisableListElements (Bool_t rnr_self=kFALSE, Bool_t rnr_children=kFALSE)
	Disable rendering of children and their list contents.

void	EnableListElements (Bool_t rnr_self=kTRUE, Bool_t rnr_children=kTRUE)
	Enable rendering of children and their list contents.

virtual void	ExportToInterpreter (const char *var_name)
	Export render-element to CINT with variable name var_name.

virtual void	FillExtraSelectionData (nlohmann::json &, const std::set< int > &) const

virtual void	FillImpliedSelectedSet (Set_t &impSelSet, const std::set< int > &)
	Populate set impSelSet with derived / dependant elements.

REveElement *	FindChild (const TString &name, const TClass *cls=nullptr)
	Find the first child with given name.

REveElement *	FindChild (TPRegexp &regexp, const TClass *cls=nullptr)
	Find the first child whose name matches regexp.

Int_t	FindChildren (List_t &matches, const TString &name, const TClass *cls=nullptr)
	Find all children with given name and append them to matches list.

Int_t	FindChildren (List_t &matches, TPRegexp &regexp, const TClass *cls=nullptr)
	Find all children whose name matches regexp and append them to matches list.

REveElement *	FirstChild () const
	Returns the first child element or 0 if the list is empty.

UChar_t	GetChangeBits () const

TClass *	GetChildClass () const

const char *	GetCName () const

REveCompound *	GetCompound ()

const char *	GetCTitle () const

Int_t	GetDenyDestroy () const
	Returns the number of times deny-destroy has been requested on the element.

Bool_t	GetDestroyOnZeroRefCnt () const
	Returns state of flag determining if the element will be destroyed when reference count reaches zero.

ElementId_t	GetElementId () const

virtual std::string	GetHighlightTooltip (const std::set< int > &) const

int	GetImpliedSelected ()

virtual Color_t	GetMainColor () const

Color_t *	GetMainColorPtr () const

virtual Char_t	GetMainTransparency () const

REveElement *	GetMother ()

const std::string &	GetName () const

REveRenderData *	GetRenderData () const

virtual Bool_t	GetRnrAnything () const

virtual Bool_t	GetRnrChildren () const

virtual Bool_t	GetRnrSelf () const

virtual Bool_t	GetRnrState () const

REveScene *	GetScene ()

virtual REveElement *	GetSelectionMaster ()
	Returns the master element - that is:

const std::string &	GetTitle () const

void *	GetUserData () const

REveElement *	GetVizModel () const

const TString &	GetVizTag () const

Bool_t	HasAunts () const

Bool_t	HasChild (REveElement *el)
	Check if element el is a child of this element.

Bool_t	HasChildren () const

virtual Bool_t	HasMainColor () const

virtual Bool_t	HasMainTrans () const

bool	HasMother ()

bool	HasScene ()

void	IncDenyDestroy ()
	Increases the deny-destroy count of the element.

void	IncImpliedSelected ()

virtual void	InitMainTrans (Bool_t can_edit=kTRUE)
	Initialize the main transformation to identity matrix.

TClass *	IsA () const
	Return class for this element Return REveElement class in case dicitonary is not exisiting.

Bool_t	IsPickable () const

REveElement *	LastChild () const
	Returns the last child element or 0 if the list is empty.

virtual void	NameTitleChanged ()
	Virtual function called when a name or title of the element has been changed.

Int_t	NumAunts () const

Int_t	NumChildren () const

virtual void	ProjectAllChildren (Bool_t same_depth=kTRUE)
	If this is a projectable, loop over all projected replicas and add the projected image of all children there.

virtual void	ProjectChild (REveElement *el, Bool_t same_depth=kTRUE)
	If this is a projectable, loop over all projected replicas and add the projected image of child 'el' there.

virtual void	PropagateMainColorToProjecteds (Color_t color, Color_t old_color)
	Propagate color to projected elements.

virtual void	PropagateMainTransparencyToProjecteds (Char_t t, Char_t old_t)
	Propagate transparency to projected elements.

virtual void	PropagateRnrStateToProjecteds ()
	Propagate render state to the projected replicas of this element.

virtual void	PropagateVizParamsToChildren (REveElement *el=nullptr)
	Propagate visualization parameters from element el (defaulting to this) to all children.

virtual void	PropagateVizParamsToProjecteds ()
	Propagate visualization parameters to dependent elements.

virtual REveTrans *	PtrMainTrans (Bool_t create=kTRUE)
	Return pointer to main transformation.

void	RecheckImpliedSelections ()
	Call this if it is possible that implied-selection or highlight has changed for this element or for implied-selection this element is member of and you want to maintain consistent selection state.

AuntList_t &	RefAunts ()

const AuntList_t &	RefAunts () const

List_t &	RefChildren ()

const List_t &	RefChildren () const

virtual REveTrans &	RefMainTrans ()
	Return reference to main transformation.

virtual void	RemoveAunt (REveAunt *au)
	Remove el from the list of aunts.

virtual void	RemoveElement (REveElement *el)
	Remove el from the list of children.

virtual void	RemoveElements ()
	Remove all elements.

virtual bool	RequiresExtraSelectionData () const

void	ResetAllCSCBits ()

void	ResetCSCBits (UChar_t f)

void	SaveVizParams (std::ostream &out, const TString &tag, const TString &var)
	Save visualization parameters for this element with given tag.

void	SetChildClass (TClass *c)

void	SetCompound (REveCompound *c)

void	SetCSCBits (UChar_t f)

void	SetDestroyOnZeroRefCnt (Bool_t d)
	Sets the state of flag determining if the element will be destroyed when reference count reaches zero.

void	SetEditMainColor (Bool_t x)

void	SetEditMainTransparency (Bool_t x)

void	SetMainAlpha (Float_t alpha)
	Set main-transparency via float alpha variable.

virtual void	SetMainColor (Color_t color)
	Set main color of the element.

void	SetMainColorPixel (Pixel_t pixel)
	Convert pixel to Color_t and call SetMainColor().

void	SetMainColorPtr (Color_t *colptr)

void	SetMainColorRGB (Float_t r, Float_t g, Float_t b)
	Convert RGB values to Color_t and call SetMainColor.

void	SetMainColorRGB (UChar_t r, UChar_t g, UChar_t b)
	Convert RGB values to Color_t and call SetMainColor.

virtual void	SetMainTransparency (Char_t t)
	Set main-transparency.

void	SetName (const std::string &name)
	Set name of an element.

void	SetNameTitle (const std::string &name, const std::string &title)
	Set name and title of an element.

void	SetPickable (Bool_t p)

void	SetPickableRecursively (Bool_t p)
	Set pickable state on the element and all its children.

virtual Bool_t	SetRnrChildren (Bool_t rnr)
	Set render state of this element's children, i.e.

virtual Bool_t	SetRnrSelf (Bool_t rnr)
	Set render state of this element, i.e.

virtual Bool_t	SetRnrSelfChildren (Bool_t rnr_self, Bool_t rnr_children)
	Set state for rendering of this element and its children.

virtual Bool_t	SetRnrState (Bool_t rnr)
	Set render state of this element and of its children to the same value.

void	SetSelectionMaster (REveElement *el)

void	SetTitle (const std::string &title)
	Set title of an element.

virtual void	SetTransMatrix (const TGeoMatrix &mat)
	Set transformation matrix from TGeo's matrix.

virtual void	SetTransMatrix (Double_t *carr)
	Set transformation matrix from column-major array.

void	SetupDefaultColorAndTransparency (Color_t col, Bool_t can_edit_color, Bool_t can_edit_transparency)
	Set up element to use built-in main color and set flags allowing editing of main color and transparency.

void	SetUserData (void *ud)

void	SetVizModel (REveElement *model)
	Set visualization-parameter model element.

Bool_t	SetVizModelByTag ()
	Find model element in VizDB that corresponds to previously assigned fVizTag and set fVizModel accordingly.

void	SetVizTag (const TString &tag)

virtual Bool_t	SingleRnrState () const

void	Stamp ()

void	StampColorSelection ()

void	StampElementAdded ()

void	StampObjProps ()

void	StampTransBBox ()

void	StampVisibility ()

Bool_t	TestCSCBits (UChar_t f) const

void	VizDB_Apply (const std::string &tag)
	Set visual parameters for this object for given tag.

void	VizDB_Insert (const std::string &tag, Bool_t replace=kTRUE, Bool_t update=kTRUE)
	Create a replica of element and insert it into VizDB with given tag.

void	VizDB_Reapply ()
	Reset visual parameters for this object from VizDB.

void	VizDB_UpdateModel (Bool_t update=kTRUE)
	Copy visual parameters from this element to viz-db model.

virtual void	WriteVizParams (std::ostream &out, const TString &var)
	Write-out visual parameters for this object.

Private Member Functions
	REveViewer (const REveViewer &)=delete

REveViewer &	operator= (const REveViewer &)=delete

Private Attributes
EAxesType	fAxesType {kAxesNone}

bool	fBlackBackground {false}

ECameraType	fCameraType {kCameraPerspXOZ}

bool	fMandatory {true}

std::string	fPostStreamFlag

Additional Inherited Members
Protected Types inherited from ROOT::Experimental::REveElement
enum	ECompoundSelectionColorBits { kCSCBImplySelectAllChildren = (1ULL << ( 0 )) , kCSCBTakeMotherAsMaster = (1ULL << ( 1 )) , kCSCBApplyMainColorToAllChildren = (1ULL << ( 2 )) , kCSCBApplyMainColorToMatchingChildren = (1ULL << ( 3 )) , kCSCBApplyMainTransparencyToAllChildren = (1ULL << ( 4 )) , kCSCBApplyMainTransparencyToMatchingChildren = (1ULL << ( 5 )) }

enum	EDestruct { kNone , kStandard , kAnnihilate }

Protected Member Functions inherited from ROOT::Experimental::REveElement
virtual void	AnnihilateRecursively ()
	Protected member function called from REveElement::Annihilate().

void	assign_element_id_recurisvely ()

void	assign_scene_recursively (REveScene *s)

ElementId_t	get_mother_id () const

ElementId_t	get_scene_id () const

virtual void	PreDeleteElement ()
	Vertex / normal / triangle index information for rendering.

virtual void	RemoveElementsInternal ()
	Remove all elements.

Static Protected Member Functions inherited from ROOT::Experimental::REveElement
static void	AppendMirErrorString (std::string_view err_str)

static void	ClearMirContext ()

static void	SetMirContext (REveElement *el)

static void	SetMirError (int error, std::string_view err_str="")

static const std::string &	ToString (Bool_t b)
	Convert Bool_t to string - kTRUE or kFALSE.

Protected Attributes inherited from ROOT::Experimental::REveElement
AuntList_t	fAunts

Bool_t	fCanEditMainColor {kFALSE}

Bool_t	fCanEditMainTrans {kFALSE}

Bool_t	fCanEditMainTransparency {kFALSE}

UChar_t	fChangeBits {0}

TClass *	fChildClass {nullptr}

List_t	fChildren

REveCompound *	fCompound {nullptr}

UChar_t	fCSCBits {0}

Color_t	fDefaultColor {kPink}

Int_t	fDenyDestroy {0}

Bool_t	fDestroyOnZeroRefCnt {kTRUE}
	Deny-destroy count.

Char_t	fDestructing {kNone}

Short_t	fImpliedSelected {0}

Color_t *	fMainColorPtr {nullptr}

std::unique_ptr< REveTrans >	fMainTrans

Char_t	fMainTransparency {0}

REveElement *	fMother {nullptr}

std::string	fName

Bool_t	fPickable {false}

std::unique_ptr< REveRenderData >	fRenderData
	Externally assigned and controlled user data.

Bool_t	fRnrChildren {kTRUE}

Bool_t	fRnrSelf {kTRUE}

REveScene *	fScene {nullptr}

REveElement *	fSelectionMaster {nullptr}

std::string	fTitle

void *	fUserData {nullptr}

REveElement *	fVizModel {nullptr}

TString	fVizTag
	Element used as model from VizDB.

Static Protected Attributes inherited from ROOT::Experimental::REveElement
static thread_local REveElement *	stlMirAlpha = nullptr

static thread_local int	stlMirError = 0

static thread_local std::string	stlMirErrorString

#include <ROOT/REveViewer.hxx>

Inheritance diagram for ROOT::Experimental::REveViewer:

[legend]

Member Enumeration Documentation

◆ EAxesType

enum ROOT::Experimental::REveViewer::EAxesType

Enumerator
kAxesNone
kAxesOrigin
kAxesEdge

Definition at line 31 of file REveViewer.hxx.

◆ ECameraType

enum ROOT::Experimental::REveViewer::ECameraType

Enumerator
kCameraPerspXOZ
kCameraOrthoXOY

Definition at line 30 of file REveViewer.hxx.

Constructor & Destructor Documentation

◆ REveViewer() [1/2]

ROOT::Experimental::REveViewer::REveViewer ( const REveViewer & )

privatedelete

◆ REveViewer() [2/2]

REveViewer::REveViewer	(	const std::string &	n = `"REveViewer"`,
		const std::string &	t = `""`
	)

Constructor.

Definition at line 34 of file REveViewer.cxx.

◆ ~REveViewer()

REveViewer::~REveViewer ( )

override

Destructor.

Definition at line 43 of file REveViewer.cxx.

Member Function Documentation

◆ AddScene()

void REveViewer::AddScene ( REveScene * scene )

virtual

Add 'scene' to the list of scenes.

Definition at line 58 of file REveViewer.cxx.

◆ ConnectClient()

void REveViewer::ConnectClient ( )

Function called from MIR when user wants to stream unsubscribed view.

Definition at line 151 of file REveViewer.cxx.

◆ DisconnectClient()

void REveViewer::DisconnectClient ( )

Function called from MIR when user closes one of the viewer window.

Definition at line 144 of file REveViewer.cxx.

◆ GetCameraType()

ECameraType ROOT::Experimental::REveViewer::GetCameraType ( ) const

inline

Definition at line 54 of file REveViewer.hxx.

◆ GetMandatory()

bool ROOT::Experimental::REveViewer::GetMandatory ( )

inline

Definition at line 63 of file REveViewer.hxx.

◆ operator=()

REveViewer & ROOT::Experimental::REveViewer::operator= ( const REveViewer & )

privatedelete

◆ Redraw()

void REveViewer::Redraw ( Bool_t resetCameras = kFALSE )

Redraw viewer immediately.

Definition at line 49 of file REveViewer.cxx.

◆ RemoveElementLocal()

void REveViewer::RemoveElementLocal ( REveElement * el )

overridevirtual

Remove element 'el' from the list of children and also remove appropriate GLScene from GLViewer's list of scenes.

Virtual from REveElement.

Reimplemented from ROOT::Experimental::REveElement.

Definition at line 80 of file REveViewer.cxx.

◆ RemoveElementsLocal()

void REveViewer::RemoveElementsLocal ( )

overridevirtual

Remove all children, forwarded to GLViewer.

Virtual from REveElement.

Reimplemented from ROOT::Experimental::REveElement.

Definition at line 91 of file REveViewer.cxx.

◆ SetAxesType()

void REveViewer::SetAxesType ( int at )

Definition at line 106 of file REveViewer.cxx.

◆ SetBlackBackground()

void REveViewer::SetBlackBackground ( bool x )

Definition at line 114 of file REveViewer.cxx.

◆ SetCameraType()

void ROOT::Experimental::REveViewer::SetCameraType ( ECameraType t )

inline

Definition at line 53 of file REveViewer.hxx.

◆ SetMandatory()

void REveViewer::SetMandatory ( bool x )

Definition at line 159 of file REveViewer.cxx.

◆ WriteCoreJson()

int REveViewer::WriteCoreJson	(	nlohmann::json &	j,
		Int_t	rnr_offset
	)

overridevirtual

Stream Camera Info.

Virtual from REveElement.

Reimplemented from ROOT::Experimental::REveElement.

Definition at line 123 of file REveViewer.cxx.

Member Data Documentation

◆ fAxesType

EAxesType ROOT::Experimental::REveViewer::fAxesType {kAxesNone}

private

Definition at line 38 of file REveViewer.hxx.

◆ fBlackBackground

bool ROOT::Experimental::REveViewer::fBlackBackground {false}

private

Definition at line 39 of file REveViewer.hxx.

◆ fCameraType

ECameraType ROOT::Experimental::REveViewer::fCameraType {kCameraPerspXOZ}

private

Definition at line 37 of file REveViewer.hxx.

◆ fMandatory

bool ROOT::Experimental::REveViewer::fMandatory {true}

private

Definition at line 41 of file REveViewer.hxx.

◆ fPostStreamFlag

std::string ROOT::Experimental::REveViewer::fPostStreamFlag

private

Definition at line 42 of file REveViewer.hxx.

Libraries for ROOT::Experimental::REveViewer:

[legend]

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

graf3d/eve7/inc/ROOT/REveViewer.hxx
graf3d/eve7/src/REveViewer.cxx

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ EAxesType

◆ ECameraType

Constructor & Destructor Documentation

◆ REveViewer() [1/2]

◆ REveViewer() [2/2]

◆ ~REveViewer()

Member Function Documentation

◆ AddScene()

◆ ConnectClient()

◆ DisconnectClient()

◆ GetCameraType()

◆ GetMandatory()

◆ operator=()

◆ Redraw()

◆ RemoveElementLocal()

◆ RemoveElementsLocal()

◆ SetAxesType()

◆ SetBlackBackground()

◆ SetCameraType()

◆ SetMandatory()

◆ WriteCoreJson()

Member Data Documentation

◆ fAxesType

◆ fBlackBackground

◆ fCameraType

◆ fMandatory

◆ fPostStreamFlag