Graphic container for RDrawable-s.

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

Date: 2017-07-06

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

Definition at line 25 of file RPad.hxx.

Public Member Functions
	RPad ()=default
	Create a topmost, non-paintable pad.

	RPad (RPadBase *parent, const RPadPos &pos, const RPadExtent &size)
	Create a child pad.

virtual	~RPad ()
	Destructor to have a vtable.

RAttrLine &	AttrLine ()

const RAttrLine &	GetAttrLine () const

const RCanvas *	GetCanvas () const override
	Access to the top-most canvas (const version).

RCanvas *	GetCanvas () override
	Access to the top-most canvas (non-const version).

RPadBase *	GetParent ()
	Access to the parent pad (non-const version).

const RPadBase *	GetParent () const
	Access to the parent pad (const version).

const RPadPos &	GetPos () const
	Get the position of the pad in parent (!) coordinates.

const RPadExtent &	GetSize () const
	Get the size of the pad in parent (!) coordinates.

std::array< RPadLength::Normal, 2 >	PixelsToNormal (const std::array< RPadLength::Pixel, 2 > &pos) const override
	Convert a `Pixel` position to Canvas-normalized positions.

RPad &	SetAttrLine (const RAttrLine &attr)

void	SetPos (const RPadPos &p)
	Set position.

void	SetSize (const RPadExtent &sz)
	Set the size of the pad in parent (!) coordinates.

std::array< RPadLength::Normal, 2 >	ToNormal (const RPadPos &pos) const
	Convert a RPadPos to [x, y] of normalized coordinates.

Public Member Functions inherited from ROOT::Experimental::RPadBase
virtual	~RPadBase ()

void	AssignAutoColors ()
	Method collect existing colors and assign new values if required.

std::vector< std::vector< std::shared_ptr< RPad > > >	Divide (int nHoriz, int nVert, const RPadExtent &padding={})
	Divide this pad into a grid of subpads with padding in between.

template<class T , class... ARGS>
auto	Draw (ARGS... args)
	Create drawable of specified class T.

template<class T , class... ARGS>
auto	Draw (const std::shared_ptr< T > &what, ARGS... args)
	Add object to be painted.

auto	Draw (std::shared_ptr< RDrawable > &&drawable)
	Add existing drawable instance to canvas.

const RPadBase *	FindPadForPrimitiveWithDisplayId (const std::string &display_id) const
	Find subpad which contains primitive with given display id.

std::shared_ptr< RDrawable >	FindPrimitive (const std::string &id) const
	Find primitive with specified id.

std::shared_ptr< RDrawable >	FindPrimitiveByDisplayId (const std::string &display_id) const
	Find primitive with unique id, produce for RDisplayItem Such id used for client-server identification of objects.

RPadUserAxisBase *	GetAxis (size_t dimension) const
	Get a pad axis from the RFrame.

std::shared_ptr< RFrame >	GetFrame ()
	Get a frame object if exists.

const std::shared_ptr< RFrame >	GetFrame () const
	Get a frame object if exists.

RPadUserAxisBase *	GetOrCreateAxis (size_t dimension)
	Get a pad axis from the RFrame.

std::shared_ptr< RFrame >	GetOrCreateFrame ()
	Get a frame object for the pad.

std::shared_ptr< RDrawable >	GetPrimitive (unsigned num) const
	returns primitive of given number

auto	GetPrimitives () const
	Get all primitives contained in the pad.

unsigned	NumPrimitives () const
	returns number of primitives in the pad

bool	Remove (const std::shared_ptr< RDrawable > &drawable)
	Remove drawable from list of primitives.

bool	Remove (const std::string &id)
	Remove an object from the list of primitives.

bool	RemoveAt (unsigned indx)
	Remove drawable at specified position.

void	SetAllAxisAutoBounds ()
	Set the range of an axis as bound kind and bound (up or down).

void	SetAllAxisBound (const std::vector< BoundKindAndValue > &vecBoundAndKind)
	Set the range of an axis as bound kind and bound (up or down).

void	SetAllAxisBounds (const std::vector< std::array< double, 2 > > &vecBeginAndEnd)
	Set the range of an axis as bound kind and bound (up or down).

void	SetAxisAutoBounds (int dimension)
	Set the range of an axis as bound kind and bound (up or down).

void	SetAxisBound (int dimension, RPadUserAxisBase::EAxisBoundsKind boundsKind, double bound)
	Set the range of an axis as bound kind and bound (up or down).

void	SetAxisBounds (int dimension, double begin, double end)
	Set the range of an axis as begin, end.

std::array< RPadLength::Normal, 2 >	UserToNormal (const std::array< RPadLength::User, 2 > &pos) const
	Convert user coordinates to normal coordinates.

void	UseStyle (const std::shared_ptr< RStyle > &style) override
	Use provided style for pad and all primitives inside.

void	Wipe ()
	Wipe the pad by clearing the list of primitives.

Public Member Functions inherited from ROOT::Experimental::RDrawable
	RDrawable (const std::string &type)

virtual	~RDrawable ()

void	ClearStyle ()

const std::string &	GetCssClass () const

const std::string &	GetCssType () const

const std::string &	GetId () const

void	SetCssClass (const std::string &cl)

void	SetId (const std::string &id)

Protected Member Functions
std::unique_ptr< RDisplayItem >	Display (const RDisplayContext &) final
	Create pad display item.

Protected Member Functions inherited from ROOT::Experimental::RPadBase
	RPadBase ()
	Allow derived classes to default construct a RPadBase.

void	CollectShared (Internal::RIOSharedVector_t &) override
	Collect all shared items to resolve shared_ptr after IO.

void	DisplayPrimitives (RPadBaseDisplayItem &paditem, RDisplayContext &ctxt)
	Create display items for all primitives in the pad Each display item gets its special id, which used later for client-server communication Second parameter is version id which already delivered to the client.

void	SetDrawableVersion (Version_t vers) override
	Assign drawable version - for pad itself and all primitives.

Protected Member Functions inherited from ROOT::Experimental::RDrawable
	RDrawable (const RDrawable &)=delete

virtual void	Execute (const std::string &)

RAttrMap &	GetAttrMap ()

const RAttrMap &	GetAttrMap () const

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

RDrawable &	operator= (const RDrawable &)=delete

virtual void	PopulateMenu (RMenuItems &)

Private Attributes
RAttrLine	fAttrLine {this, "border"}
	! border attributes

RPadBase *	fParent {nullptr}
	Pad containing this pad as a sub-pad.

RPadPos	fPos
	pad position

RPadExtent	fSize
	pad size

Additional Inherited Members
Public Types inherited from ROOT::Experimental::RPadBase
using	Primitives_t = std::vector< std::shared_ptr< RDrawable > >

Public Types inherited from ROOT::Experimental::RDrawable
using	Version_t = uint64_t

#include <ROOT/RPad.hxx>

Inheritance diagram for ROOT::Experimental::RPad:

[legend]

Constructor & Destructor Documentation

◆ RPad() [1/2]

ROOT::Experimental::RPad::RPad ( )

default

Create a topmost, non-paintable pad.

◆ RPad() [2/2]

ROOT::Experimental::RPad::RPad	(	RPadBase *	parent,
		const RPadPos &	pos,
		const RPadExtent &	size
	)

inline

Create a child pad.

Definition at line 44 of file RPad.hxx.

◆ ~RPad()

ROOT::Experimental::RPad::~RPad ( )

virtualdefault

Destructor to have a vtable.

Member Function Documentation

◆ AttrLine()

RAttrLine & ROOT::Experimental::RPad::AttrLine ( )

inline

Definition at line 75 of file RPad.hxx.

◆ Display()

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

finalprotectedvirtual

Create pad display item.

Reimplemented from ROOT::Experimental::RDrawable.

Definition at line 27 of file RPad.cxx.

◆ GetAttrLine()

const RAttrLine & ROOT::Experimental::RPad::GetAttrLine ( ) const

inline

Definition at line 73 of file RPad.hxx.

◆ GetCanvas() [1/2]

const RCanvas * ROOT::Experimental::RPad::GetCanvas ( ) const

inlineoverridevirtual

Access to the top-most canvas (const version).

Implements ROOT::Experimental::RPadBase.

Definition at line 56 of file RPad.hxx.

◆ GetCanvas() [2/2]

RCanvas * ROOT::Experimental::RPad::GetCanvas ( )

inlineoverridevirtual

Access to the top-most canvas (non-const version).

Implements ROOT::Experimental::RPadBase.

Definition at line 59 of file RPad.hxx.

◆ GetParent() [1/2]

RPadBase * ROOT::Experimental::RPad::GetParent ( )

inline

Access to the parent pad (non-const version).

Definition at line 53 of file RPad.hxx.

◆ GetParent() [2/2]

const RPadBase * ROOT::Experimental::RPad::GetParent ( ) const

inline

Access to the parent pad (const version).

Definition at line 50 of file RPad.hxx.

◆ GetPos()

const RPadPos & ROOT::Experimental::RPad::GetPos ( ) const

inline

Get the position of the pad in parent (!) coordinates.

Definition at line 62 of file RPad.hxx.

◆ GetSize()

const RPadExtent & ROOT::Experimental::RPad::GetSize ( ) const

inline

Get the size of the pad in parent (!) coordinates.

Definition at line 65 of file RPad.hxx.

◆ PixelsToNormal()

std::array< RPadLength::Normal, 2 > ROOT::Experimental::RPad::PixelsToNormal ( const std::array< RPadLength::Pixel, 2 > & pos ) const

inlineoverridevirtual

Convert a Pixel position to Canvas-normalized positions.

Implements ROOT::Experimental::RPadBase.

Definition at line 78 of file RPad.hxx.

◆ SetAttrLine()

RPad & ROOT::Experimental::RPad::SetAttrLine ( const RAttrLine & attr )

inline

Definition at line 74 of file RPad.hxx.

◆ SetPos()

void ROOT::Experimental::RPad::SetPos ( const RPadPos & p )

inline

Set position.

Definition at line 71 of file RPad.hxx.

◆ SetSize()

void ROOT::Experimental::RPad::SetSize ( const RPadExtent & sz )

inline

Set the size of the pad in parent (!) coordinates.

Definition at line 68 of file RPad.hxx.

◆ ToNormal()

std::array< RPadLength::Normal, 2 > ROOT::Experimental::RPad::ToNormal ( const RPadPos & pos ) const

inline

Convert a RPadPos to [x, y] of normalized coordinates.

Definition at line 92 of file RPad.hxx.

Member Data Documentation

◆ fAttrLine

RAttrLine ROOT::Experimental::RPad::fAttrLine {this, "border"}

private

! border attributes

Definition at line 33 of file RPad.hxx.

◆ fParent

RPadBase* ROOT::Experimental::RPad::fParent {nullptr}

private

Pad containing this pad as a sub-pad.

The parent pad, if this pad has one.

Definition at line 28 of file RPad.hxx.

◆ fPos

RPadPos ROOT::Experimental::RPad::fPos

private

pad position

Definition at line 30 of file RPad.hxx.

◆ fSize

RPadExtent ROOT::Experimental::RPad::fSize

private

pad size

Definition at line 31 of file RPad.hxx.

Libraries for ROOT::Experimental::RPad:

[legend]

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

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

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ RPad() [1/2]

◆ RPad() [2/2]

◆ ~RPad()

Member Function Documentation

◆ AttrLine()

◆ Display()

◆ GetAttrLine()

◆ GetCanvas() [1/2]

◆ GetCanvas() [2/2]

◆ GetParent() [1/2]

◆ GetParent() [2/2]

◆ GetPos()

◆ GetSize()

◆ PixelsToNormal()

◆ SetAttrLine()

◆ SetPos()

◆ SetSize()

◆ ToNormal()

Member Data Documentation

◆ fAttrLine

◆ fParent

◆ fPos

◆ fSize