Holds an area where drawing on user coordinate-system can be performed.

Authors: Axel Naumann axel@.nosp@m.cern.nosp@m..ch Sergey Linev s.lin.nosp@m.ev@g.nosp@m.si.de

Date: 2017-09-26

Warning: This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback is welcome!

Definition at line 38 of file RFrame.hxx.

Classes
class	RUserRanges
class	RZoomRequest

Public Types
using	Version_t = uint64_t

Public Member Functions
	RFrame (TRootIOCtor *)
void	ClearStyle ()
void	GetClientRanges (unsigned connid, RUserRanges &ranges)
	Return ranges configured for the client.
const std::string &	GetCssClass () const
const char *	GetCssType () const
const std::string &	GetId () const
void	SetCssClass (const std::string &cl)
void	SetId (const std::string &id)
virtual void	UseStyle (const std::shared_ptr< RStyle > &style)

Public Attributes
RAttrBorder	border {this, "border"}
	! frame border attributes
RAttrValue< bool >	drawAxes {this, "drawAxes", false}
	! draw axes by frame
RAttrFill	fill {this, "fill"}
	! frame fill attributes
RAttrValue< bool >	gridX {this, "gridX", false}
	! show grid for X axis
RAttrValue< bool >	gridY {this, "gridY", false}
	! show grid for Y axis
RAttrMargins	margins {this, "margins"}
	! frame margins relative to pad
RAttrValue< bool >	swapX {this, "swapX", false}
	! swap position of X axis
RAttrValue< bool >	swapY {this, "swapY", false}
	! swap position of Y axis
RAttrValue< int >	ticksX {this, "ticksX", 1}
	! X ticks drawing: 0 - off, 1 - normal, 2 - both sides, 3 - both sides with labels
RAttrValue< int >	ticksY {this, "ticksY", 1}
	! Y ticks drawing: 0 - off, 1 - normal, 2 - both sides, 3 - both sides with labels
RAttrAxis	x {this, "x"}
	! drawing attributes for X axis
RAttrAxis	x2 {this, "x2"}
	! drawing attributes for X2 axis
RAttrAxis	y {this, "y"}
	! drawing attributes for Y axis
RAttrAxis	y2 {this, "y2"}
	! drawing attributes for Y2 axis
RAttrAxis	z {this, "z"}
	! drawing attributes for Z axis

Protected Member Functions
void	AssignZoomRange (unsigned ndim, RAttrAxis &axis, const RUserRanges &ranges)
	Internal - assign client zoomed range to specified axis.
virtual void	CollectShared (Internal::RIOSharedVector_t &)
virtual std::unique_ptr< RDisplayItem >	Display (const RDisplayContext &)
	Creates display item for drawable By default item contains drawable data itself.
virtual void	Execute (const std::string &)
RAttrMap &	GetAttrMap ()
const RAttrMap &	GetAttrMap () const
void	GetAxisRanges (unsigned ndim, const RAttrAxis &axis, RUserRanges &ranges) const
	Internal - extract range for specified axis.
Version_t	GetVersion () const
virtual bool	IsFrameRequired () const
bool	MatchSelector (const std::string &selector) const
	Preliminary method which checks if drawable matches with given selector Following selector are allowed: "type" or "#id" or ".class_name" Here type is drawable kind like 'rect' or 'pad' id is drawable identifier, specified with RDrawable::SetId() method class_name is drawable class name, specified with RDrawable::SetCssClass() method.
virtual void	OnDisplayItemDestroyed (RDisplayItem *) const
void	PopulateMenu (RMenuItems &) override
	Provide context menu items.
void	SetCssType (const char *csstype)
virtual void	SetDrawableVersion (Version_t vers)

Private Member Functions
	RFrame ()
	RFrame (const RFrame &)=delete
RFrame &	operator= (const RFrame &)=delete
void	SetClientRanges (unsigned connid, const RUserRanges &ranges, bool ismainconn)
	Remember client range, can be used for drawing or stats box calculations.

Private Attributes
RAttrMap	fAttr
	attributes values
std::map< unsigned, RUserRanges >	fClientRanges
	! individual client ranges
std::string	fCssClass
	user-defined CSS class, used for RStyle
const char *	fCssType {nullptr}
	! drawable type, not stored in the root file, must be initialized in constructor
std::string	fId
	user-defined CSS id, used for RStyle
std::weak_ptr< RStyle >	fStyle
	! style applied for RDrawable, not stored when canvas is saved
Version_t	fVersion {1}
	! drawable version, changed from the canvas

Friends
class	RPadBase

#include <ROOT/RFrame.hxx>

Inheritance diagram for ROOT::Experimental::RFrame:

Member Typedef Documentation

◆ Version_t

using ROOT::Experimental::RDrawable::Version_t = uint64_t

inherited

Definition at line 123 of file RDrawable.hxx.

Constructor & Destructor Documentation

◆ RFrame() [1/3]

ROOT::Experimental::RFrame::RFrame ( const RFrame & )

privatedelete

◆ RFrame() [2/3]

ROOT::Experimental::RFrame::RFrame ( )

inlineprivate

Definition at line 153 of file RFrame.hxx.

◆ RFrame() [3/3]

ROOT::Experimental::RFrame::RFrame ( TRootIOCtor * )

inline

Definition at line 196 of file RFrame.hxx.

Member Function Documentation

◆ AssignZoomRange()

void RFrame::AssignZoomRange	(	unsigned	ndim,
		RAttrAxis &	axis,
		const RUserRanges &	ranges )

protected

Internal - assign client zoomed range to specified axis.

Definition at line 36 of file RFrame.cxx.

◆ ClearStyle()

void ROOT::Experimental::RDrawable::ClearStyle ( )

inlineinherited

Definition at line 213 of file RDrawable.hxx.

◆ CollectShared()

virtual void ROOT::Experimental::RDrawable::CollectShared ( Internal::RIOSharedVector_t & )

inlineprotectedvirtualinherited

Reimplemented in ROOT::Experimental::RPadBase, and ROOT::Experimental::TObjectDrawable.

Definition at line 181 of file RDrawable.hxx.

◆ Display()

std::unique_ptr< RDisplayItem > RDrawable::Display ( const RDisplayContext & ctxt )

protectedvirtualinherited

Creates display item for drawable By default item contains drawable data itself.

Reimplemented in ROOT::Experimental::RPad, and ROOT::Experimental::TObjectDrawable.

Definition at line 68 of file RDrawable.cxx.

◆ Execute()

void RDrawable::Execute ( const std::string & exec )

protectedvirtualinherited

Reimplemented in ROOT::Experimental::TObjectDrawable.

Definition at line 40 of file RDrawable.cxx.

◆ GetAttrMap() [1/2]

RAttrMap & ROOT::Experimental::RDrawable::GetAttrMap ( )

inlineprotectedinherited

Definition at line 185 of file RDrawable.hxx.

◆ GetAttrMap() [2/2]

const RAttrMap & ROOT::Experimental::RDrawable::GetAttrMap ( ) const

inlineprotectedinherited

Definition at line 186 of file RDrawable.hxx.

◆ GetAxisRanges()

void RFrame::GetAxisRanges	(	unsigned	ndim,
		const RAttrAxis &	axis,
		RUserRanges &	ranges ) const

protected

Internal - extract range for specified axis.

Definition at line 24 of file RFrame.cxx.

◆ GetClientRanges()

void RFrame::GetClientRanges	(	unsigned	connid,
		RUserRanges &	ranges )

Return ranges configured for the client.

Definition at line 94 of file RFrame.cxx.

◆ GetCssClass()

const std::string & ROOT::Experimental::RDrawable::GetCssClass ( ) const

inlineinherited

Definition at line 218 of file RDrawable.hxx.

◆ GetCssType()

const char * ROOT::Experimental::RDrawable::GetCssType ( ) const

inlineinherited

Definition at line 215 of file RDrawable.hxx.

◆ GetId()

const std::string & ROOT::Experimental::RDrawable::GetId ( ) const

inlineinherited

Definition at line 221 of file RDrawable.hxx.

◆ GetVersion()

Version_t ROOT::Experimental::RDrawable::GetVersion ( ) const

inlineprotectedinherited

Definition at line 197 of file RDrawable.hxx.

◆ IsFrameRequired()

virtual bool ROOT::Experimental::RDrawable::IsFrameRequired ( ) const

inlineprotectedvirtualinherited

Reimplemented in ROOT::Experimental::RPaletteDrawable.

Definition at line 183 of file RDrawable.hxx.

◆ MatchSelector()

bool RDrawable::MatchSelector ( const std::string & selector ) const

protectedinherited

Preliminary method which checks if drawable matches with given selector Following selector are allowed: "type" or "#id" or ".class_name" Here type is drawable kind like 'rect' or 'pad' id is drawable identifier, specified with RDrawable::SetId() method class_name is drawable class name, specified with RDrawable::SetCssClass() method.

Definition at line 59 of file RDrawable.cxx.

◆ OnDisplayItemDestroyed()

virtual void ROOT::Experimental::RDrawable::OnDisplayItemDestroyed ( RDisplayItem * ) const

inlineprotectedvirtualinherited

Definition at line 194 of file RDrawable.hxx.

◆ operator=()

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

privatedelete

◆ PopulateMenu()

void RFrame::PopulateMenu ( RMenuItems & )

overrideprotectedvirtual

Provide context menu items.

Reimplemented from ROOT::Experimental::RDrawable.

Definition at line 52 of file RFrame.cxx.

◆ SetClientRanges()

void RFrame::SetClientRanges	(	unsigned	connid,
		const RUserRanges &	ranges,
		bool	ismainconn )

private

Remember client range, can be used for drawing or stats box calculations.

Definition at line 72 of file RFrame.cxx.

◆ SetCssClass()

void ROOT::Experimental::RDrawable::SetCssClass ( const std::string & cl )

inlineinherited

Definition at line 217 of file RDrawable.hxx.

◆ SetCssType()

void ROOT::Experimental::RDrawable::SetCssType ( const char * csstype )

inlineprotectedinherited

Definition at line 192 of file RDrawable.hxx.

◆ SetDrawableVersion()

virtual void ROOT::Experimental::RDrawable::SetDrawableVersion ( Version_t vers )

inlineprotectedvirtualinherited

Reimplemented in ROOT::Experimental::RPadBase.

Definition at line 196 of file RDrawable.hxx.

◆ SetId()

void ROOT::Experimental::RDrawable::SetId ( const std::string & id )

inlineinherited

Definition at line 220 of file RDrawable.hxx.

◆ UseStyle()

virtual void ROOT::Experimental::RDrawable::UseStyle ( const std::shared_ptr< RStyle > & style )

inlinevirtualinherited

Reimplemented in ROOT::Experimental::RPadBase.

Definition at line 212 of file RDrawable.hxx.

◆ RPadBase

friend class RPadBase

friend

Definition at line 40 of file RFrame.hxx.

Member Data Documentation

◆ border

RAttrBorder ROOT::Experimental::RFrame::border {this, "border"}

! frame border attributes

Definition at line 181 of file RFrame.hxx.

◆ drawAxes

RAttrValue<bool> ROOT::Experimental::RFrame::drawAxes {this, "drawAxes", false}

! draw axes by frame

Definition at line 188 of file RFrame.hxx.

◆ fAttr

RAttrMap ROOT::Experimental::RDrawable::fAttr

privateinherited

attributes values

Definition at line 172 of file RDrawable.hxx.

◆ fClientRanges

std::map<unsigned, RUserRanges> ROOT::Experimental::RFrame::fClientRanges

private

! individual client ranges

Definition at line 147 of file RFrame.hxx.

◆ fCssClass

std::string ROOT::Experimental::RDrawable::fCssClass

privateinherited

user-defined CSS class, used for RStyle

Definition at line 175 of file RDrawable.hxx.

◆ fCssType

const char* ROOT::Experimental::RDrawable::fCssType {nullptr}

privateinherited

! drawable type, not stored in the root file, must be initialized in constructor

Definition at line 174 of file RDrawable.hxx.

◆ fId

std::string ROOT::Experimental::RDrawable::fId

privateinherited

user-defined CSS id, used for RStyle

Definition at line 176 of file RDrawable.hxx.

◆ fill

RAttrFill ROOT::Experimental::RFrame::fill {this, "fill"}

! frame fill attributes

Definition at line 182 of file RFrame.hxx.

◆ fStyle

std::weak_ptr<RStyle> ROOT::Experimental::RDrawable::fStyle

privateinherited

! style applied for RDrawable, not stored when canvas is saved

Definition at line 173 of file RDrawable.hxx.

◆ fVersion

Version_t ROOT::Experimental::RDrawable::fVersion {1}

privateinherited

! drawable version, changed from the canvas

Definition at line 177 of file RDrawable.hxx.

◆ gridX

RAttrValue<bool> ROOT::Experimental::RFrame::gridX {this, "gridX", false}

! show grid for X axis

Definition at line 189 of file RFrame.hxx.

◆ gridY

RAttrValue<bool> ROOT::Experimental::RFrame::gridY {this, "gridY", false}

! show grid for Y axis

Definition at line 190 of file RFrame.hxx.

◆ margins

RAttrMargins ROOT::Experimental::RFrame::margins {this, "margins"}

! frame margins relative to pad

Definition at line 180 of file RFrame.hxx.

◆ swapX

RAttrValue<bool> ROOT::Experimental::RFrame::swapX {this, "swapX", false}

! swap position of X axis

Definition at line 191 of file RFrame.hxx.

◆ swapY

RAttrValue<bool> ROOT::Experimental::RFrame::swapY {this, "swapY", false}

! swap position of Y axis

Definition at line 192 of file RFrame.hxx.

◆ ticksX

RAttrValue<int> ROOT::Experimental::RFrame::ticksX {this, "ticksX", 1}

! X ticks drawing: 0 - off, 1 - normal, 2 - both sides, 3 - both sides with labels

Definition at line 193 of file RFrame.hxx.

◆ ticksY

RAttrValue<int> ROOT::Experimental::RFrame::ticksY {this, "ticksY", 1}

! Y ticks drawing: 0 - off, 1 - normal, 2 - both sides, 3 - both sides with labels

Definition at line 194 of file RFrame.hxx.

◆ x

RAttrAxis ROOT::Experimental::RFrame::x {this, "x"}

! drawing attributes for X axis

Definition at line 183 of file RFrame.hxx.

◆ x2

RAttrAxis ROOT::Experimental::RFrame::x2 {this, "x2"}

! drawing attributes for X2 axis

Definition at line 186 of file RFrame.hxx.

◆ y

RAttrAxis ROOT::Experimental::RFrame::y {this, "y"}

! drawing attributes for Y axis

Definition at line 184 of file RFrame.hxx.

◆ y2

RAttrAxis ROOT::Experimental::RFrame::y2 {this, "y2"}

! drawing attributes for Y2 axis

Definition at line 187 of file RFrame.hxx.

◆ z

RAttrAxis ROOT::Experimental::RFrame::z {this, "z"}

! drawing attributes for Z axis

Definition at line 185 of file RFrame.hxx.

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

graf2d/gpadv7/inc/ROOT/RFrame.hxx
graf2d/gpadv7/src/RFrame.cxx

Classes

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Member Typedef Documentation

◆ Version_t

Constructor & Destructor Documentation

◆ RFrame() [1/3]

◆ RFrame() [2/3]

◆ RFrame() [3/3]

Member Function Documentation

◆ AssignZoomRange()

◆ ClearStyle()

◆ CollectShared()

◆ Display()

◆ Execute()

◆ GetAttrMap() [1/2]

◆ GetAttrMap() [2/2]

◆ GetAxisRanges()

◆ GetClientRanges()

◆ GetCssClass()

◆ GetCssType()

◆ GetId()

◆ GetVersion()

◆ IsFrameRequired()

◆ MatchSelector()

◆ OnDisplayItemDestroyed()

◆ operator=()

◆ PopulateMenu()

◆ SetClientRanges()

◆ SetCssClass()

◆ SetCssType()

◆ SetDrawableVersion()

◆ SetId()

◆ UseStyle()

Friends And Related Symbol Documentation

◆ RPadBase

Member Data Documentation

◆ border

◆ drawAxes

◆ fAttr

◆ fClientRanges

◆ fCssClass

◆ fCssType

◆ fId

◆ fill

◆ fStyle

◆ fVersion

◆ gridX

◆ gridY

◆ margins

◆ swapX

◆ swapY

◆ ticksX

◆ ticksY

◆ x

◆ x2

◆ y

◆ y2

◆ z