Partial implementation of the TreeDrawing interface. More...

#include <Bpp/Phyl/Graphics/AbstractTreeDrawing.h>

Inheritance diagram for bpp::AbstractTreeDrawing:

Collaboration diagram for bpp::AbstractTreeDrawing:

Public Member Functions
	AbstractTreeDrawing ()

	AbstractTreeDrawing (const AbstractTreeDrawing &atd)

AbstractTreeDrawing &	operator= (const AbstractTreeDrawing &atd)

virtual	~AbstractTreeDrawing ()

bool	hasTree () const override

const Tree &	tree () const override

const TreeTemplate< INode > &	treeTemplate () const

void	setTree (const Tree &tree) override

Point2D< double >	getNodePosition (int nodeId) const override
	Get the position of a node. More...

int	getNodeAt (const Point2D< double > &position) const override
	Get the node corresponding to a position on the device. More...

bool	belongsTo (const Point2D< double > &p1, const Point2D< double > &p2) const
	Utilitary function, telling if a point belongs to a specified area. More...

virtual void	drawAtNode (GraphicDevice &gDevice, const INode &node, const std::string &text, double xOffset=0, double yOffset=0, short hpos=GraphicDevice::TEXT_HORIZONTAL_LEFT, short vpos=GraphicDevice::TEXT_VERTICAL_CENTER, double angle=0) const
	Draw some text at a particular node position. More...

virtual void	drawAtBranch (GraphicDevice &gDevice, const INode &node, const std::string &text, double xOffset=0, double yOffset=0, short hpos=GraphicDevice::TEXT_HORIZONTAL_LEFT, short vpos=GraphicDevice::TEXT_VERTICAL_CENTER, double angle=0) const
	Draw some text at a particular branch position. More...

void	setDisplaySettings (std::shared_ptr< const TreeDrawingSettings > tds) override
	Global drawing settings. More...

const TreeDrawingSettings &	displaySettings () const override

double	getXUnit () const override

double	getYUnit () const override

void	setXUnit (double xu) override
	Set the 'horizontal' expansion unit. More...

void	setYUnit (double yu) override
	Set the 'vertical' expansion unit. More...

void	collapseNode (int nodeId, bool yn) override
	Properties to draw. More...

bool	isNodeCollapsed (int nodeId) const override

void	addTreeDrawingListener (TreeDrawingListener *listener) override
	Add a drawing listener to this instance. More...

void	removeTreeDrawingListener (TreeDrawingListener *listener) override
	Remove a drawing listener from this instance. More...

virtual void	treeHasChanged ()=0
	Method to implement to deal with redrawing when the underlying tree has been modified. More...

TreeDrawing *	clone () const =0

virtual std::string	getName () const =0

virtual double	getWidth () const =0

virtual double	getHeight () const =0

virtual void	plot (GraphicDevice &gDevice) const =0
	Plot the tree onto the specified device. More...

Static Public Attributes
static std::shared_ptr< const TreeDrawingSettings >	DEFAULT_SETTINGS = std::make_shared<const TreeDrawingSettings>()

Protected Member Functions
void	fireBeforeTreeEvent_ (const DrawTreeEvent &event) const

void	fireAfterTreeEvent_ (const DrawTreeEvent &event) const

void	fireBeforeNodeEvent_ (const DrawINodeEvent &event) const

void	fireAfterNodeEvent_ (const DrawINodeEvent &event) const

void	fireBeforeBranchEvent_ (const DrawIBranchEvent &event) const

void	fireAfterBranchEvent_ (const DrawIBranchEvent &event) const

Protected Attributes
std::unique_ptr< TreeTemplate< INode > >	tree_

double	xUnit_

double	yUnit_

std::shared_ptr< const TreeDrawingSettings >	settings_

std::vector< TreeDrawingListener * >	listeners_

Detailed Description

Partial implementation of the TreeDrawing interface.

This basic implementation uses a dedicated NodeInfo structure in combination with the NodeTemplate class. This structures stores the current coordinates of all nodes, so that it is easy to annotate the tree drawing.

Definition at line 114 of file AbstractTreeDrawing.h.

Constructor & Destructor Documentation

◆ AbstractTreeDrawing() [1/2]

bpp::AbstractTreeDrawing::AbstractTreeDrawing ( )

inline

Definition at line 125 of file AbstractTreeDrawing.h.

◆ AbstractTreeDrawing() [2/2]

bpp::AbstractTreeDrawing::AbstractTreeDrawing ( const AbstractTreeDrawing & atd )

inline

Definition at line 127 of file AbstractTreeDrawing.h.

References listeners_.

◆ ~AbstractTreeDrawing()

virtual bpp::AbstractTreeDrawing::~AbstractTreeDrawing ( )

inlinevirtual

Definition at line 162 of file AbstractTreeDrawing.h.

References listeners_.

Member Function Documentation

◆ addTreeDrawingListener()

void bpp::AbstractTreeDrawing::addTreeDrawingListener ( TreeDrawingListener * listener )

inlineoverridevirtual

Add a drawing listener to this instance.

Parameters

listener a pointer toward an object implementing the TreeDrawingListener interface. This object will then be owned by the class and copied and deleted if/when needed, unless it is autonomous.

See also: TreeDrawingListener

Implements bpp::TreeDrawing.

Definition at line 281 of file AbstractTreeDrawing.h.

References listeners_.

◆ belongsTo()

bool AbstractTreeDrawing::belongsTo	(	const Point2D< double > &	p1,
		const Point2D< double > &	p2
	)		const

Utilitary function, telling if a point belongs to a specified area.

This method is used internally to get a node coordinates.

Parameters

p1	Point to look for.
p2	Second point defining the center of the area.

Returns: True if p1 belongs to the area defined by p2.

Definition at line 47 of file AbstractTreeDrawing.cpp.

References bpp::Point2D< class >::getX(), bpp::Point2D< class >::getY(), and settings_.

Referenced by getNodeAt().

◆ clone()

TreeDrawing * bpp::TreeDrawing::clone ( ) const

pure virtualinherited

Implements bpp::Clonable.

Implemented in bpp::CladogramPlot, and bpp::PhylogramPlot.

◆ collapseNode()

void bpp::AbstractTreeDrawing::collapseNode	(	int	nodeId,
		bool	yn
	)

inlineoverridevirtual

Properties to draw.

Collapsing nodes

Implements bpp::TreeDrawing.

Definition at line 269 of file AbstractTreeDrawing.h.

References tree_.

◆ displaySettings()

const TreeDrawingSettings & bpp::AbstractTreeDrawing::displaySettings ( ) const

inlineoverridevirtual

Implements bpp::TreeDrawing.

Definition at line 259 of file AbstractTreeDrawing.h.

References settings_.

Referenced by bpp::AbstractDendrogramPlot::plot().

◆ drawAtBranch()

void AbstractTreeDrawing::drawAtBranch	(	GraphicDevice &	gDevice,
		const INode &	node,
		const std::string &	text,
		double	xOffset = `0`,
		double	yOffset = `0`,
		short	hpos = `GraphicDevice::TEXT_HORIZONTAL_LEFT`,
		short	vpos = `GraphicDevice::TEXT_VERTICAL_CENTER`,
		double	angle = `0`
	)		const

virtual

Draw some text at a particular branch position.

Parameters

gDevice	The GraphicDevice object on which to draw.
node	The node of interest.
text	The text to draw.
xOffset	Horizontal offset.
yOffset	Vertical offset.
hpos	The way the text should be aligned horizontally (see GraphicDevice).
vpos	The way the text should be aligned vertically (see GraphicDevice).
angle	The rotation value of the text.

Definition at line 58 of file AbstractTreeDrawing.cpp.

References bpp::GraphicDevice::drawText(), bpp::NodeTemplate< NodeInfos >::getFather(), bpp::NodeTemplate< NodeInfos >::getInfos(), bpp::Node::hasFather(), xUnit_, and yUnit_.

◆ drawAtNode()

void AbstractTreeDrawing::drawAtNode	(	GraphicDevice &	gDevice,
		const INode &	node,
		const std::string &	text,
		double	xOffset = `0`,
		double	yOffset = `0`,
		short	hpos = `GraphicDevice::TEXT_HORIZONTAL_LEFT`,
		short	vpos = `GraphicDevice::TEXT_VERTICAL_CENTER`,
		double	angle = `0`
	)		const

virtual

Draw some text at a particular node position.

Parameters

gDevice	The GraphicDevice object on which to draw.
node	The node of interest.
text	The text to draw.
xOffset	Horizontal offset.
yOffset	Vertical offset.
hpos	The way the text should be aligned horizontally (see GraphicDevice).
vpos	The way the text should be aligned vertically (see GraphicDevice).
angle	The rotation value of the text.

Definition at line 53 of file AbstractTreeDrawing.cpp.

References bpp::GraphicDevice::drawText(), bpp::NodeTemplate< NodeInfos >::getInfos(), xUnit_, and yUnit_.

◆ fireAfterBranchEvent_()

void bpp::AbstractTreeDrawing::fireAfterBranchEvent_ ( const DrawIBranchEvent & event ) const

inlineprotected

Definition at line 349 of file AbstractTreeDrawing.h.

References listeners_.

Referenced by bpp::CladogramPlot::recursivePlot_(), and bpp::PhylogramPlot::recursivePlot_().

◆ fireAfterNodeEvent_()

void bpp::AbstractTreeDrawing::fireAfterNodeEvent_ ( const DrawINodeEvent & event ) const

inlineprotected

Definition at line 331 of file AbstractTreeDrawing.h.

References listeners_.

Referenced by bpp::CladogramPlot::recursivePlot_(), and bpp::PhylogramPlot::recursivePlot_().

◆ fireAfterTreeEvent_()

void bpp::AbstractTreeDrawing::fireAfterTreeEvent_ ( const DrawTreeEvent & event ) const

inlineprotected

Definition at line 313 of file AbstractTreeDrawing.h.

References listeners_.

Referenced by bpp::CladogramPlot::drawDendrogram_(), and bpp::PhylogramPlot::drawDendrogram_().

◆ fireBeforeBranchEvent_()

void bpp::AbstractTreeDrawing::fireBeforeBranchEvent_ ( const DrawIBranchEvent & event ) const

inlineprotected

Definition at line 340 of file AbstractTreeDrawing.h.

References listeners_.

Referenced by bpp::CladogramPlot::recursivePlot_(), and bpp::PhylogramPlot::recursivePlot_().

◆ fireBeforeNodeEvent_()

void bpp::AbstractTreeDrawing::fireBeforeNodeEvent_ ( const DrawINodeEvent & event ) const

inlineprotected

Definition at line 322 of file AbstractTreeDrawing.h.

References listeners_.

Referenced by bpp::CladogramPlot::recursivePlot_(), and bpp::PhylogramPlot::recursivePlot_().

◆ fireBeforeTreeEvent_()

void bpp::AbstractTreeDrawing::fireBeforeTreeEvent_ ( const DrawTreeEvent & event ) const

inlineprotected

Definition at line 304 of file AbstractTreeDrawing.h.

References listeners_.

Referenced by bpp::CladogramPlot::drawDendrogram_(), and bpp::PhylogramPlot::drawDendrogram_().

◆ getHeight()

virtual double bpp::TreeDrawing::getHeight ( ) const

pure virtualinherited

Returns: The total height of the drawing, in Y units.

Implemented in bpp::CladogramPlot, and bpp::PhylogramPlot.

◆ getName()

virtual std::string bpp::TreeDrawing::getName ( ) const

pure virtualinherited

Returns: A string describing this drawing algorithm.

Implemented in bpp::CladogramPlot, and bpp::PhylogramPlot.

◆ getNodeAt()

int AbstractTreeDrawing::getNodeAt ( const Point2D< double > & position ) const

overridevirtual

Get the node corresponding to a position on the device.

Parameters

position A position in the coordinates system of the last GraphicDevice used.

Returns: The corresponding node identifier if available.

Exceptions

NodeNotFoundException If the node does not correspond to a node in the tree.

Implements bpp::TreeDrawing.

Definition at line 33 of file AbstractTreeDrawing.cpp.

References belongsTo(), and tree_.

◆ getNodePosition()

Point2D< double > AbstractTreeDrawing::getNodePosition ( int nodeId ) const

overridevirtual

Get the position of a node.

Parameters

nodeId The identifier of the node.

Returns: The localization of the node using the coordinate system of the last GraphicDevice used.

Exceptions

NodeNotFoundException If the node does not correspond to a node in the tree.

Implements bpp::TreeDrawing.

Definition at line 20 of file AbstractTreeDrawing.cpp.

References bpp::TextTools::toString(), and tree_.

◆ getWidth()

virtual double bpp::TreeDrawing::getWidth ( ) const

pure virtualinherited

Returns: The total width of the drawing, in X units.

Implemented in bpp::CladogramPlot, and bpp::PhylogramPlot.

◆ getXUnit()

double bpp::AbstractTreeDrawing::getXUnit ( ) const

inlineoverridevirtual

Returns: The horizontal unit length.

Implements bpp::TreeDrawing.

Definition at line 261 of file AbstractTreeDrawing.h.

References xUnit_.

Referenced by bpp::CladogramPlot::drawDendrogram_(), bpp::PhylogramPlot::drawDendrogram_(), bpp::CladogramPlot::recursivePlot_(), and bpp::PhylogramPlot::recursivePlot_().

◆ getYUnit()

double bpp::AbstractTreeDrawing::getYUnit ( ) const

inlineoverridevirtual

Returns: The vertical unit length.

Implements bpp::TreeDrawing.

Definition at line 263 of file AbstractTreeDrawing.h.

References yUnit_.

Referenced by bpp::CladogramPlot::recursivePlot_(), and bpp::PhylogramPlot::recursivePlot_().

◆ hasTree()

bool bpp::AbstractTreeDrawing::hasTree ( ) const

inlineoverridevirtual

Returns: 'True' if a tree is attached to this instance.

Implements bpp::TreeDrawing.

Definition at line 172 of file AbstractTreeDrawing.h.

References tree_.

Referenced by bpp::CladogramPlot::drawDendrogram_(), bpp::PhylogramPlot::drawDendrogram_(), bpp::CladogramPlot::setTree(), tree(), bpp::CladogramPlot::treeHasChanged(), bpp::PhylogramPlot::treeHasChanged(), and treeTemplate().

◆ isNodeCollapsed()

bool bpp::AbstractTreeDrawing::isNodeCollapsed ( int nodeId ) const

inlineoverridevirtual

Implements bpp::TreeDrawing.

Definition at line 275 of file AbstractTreeDrawing.h.

References tree_.

◆ operator=()

AbstractTreeDrawing & bpp::AbstractTreeDrawing::operator= ( const AbstractTreeDrawing & atd )

inline

Definition at line 143 of file AbstractTreeDrawing.h.

References listeners_, settings_, tree_, xUnit_, and yUnit_.

◆ plot()

virtual void bpp::TreeDrawing::plot ( GraphicDevice & gDevice ) const

pure virtualinherited

Plot the tree onto the specified device.

Parameters

gDevice An object implementing the GraphicDevice interface.

Implemented in bpp::AbstractDendrogramPlot.

◆ removeTreeDrawingListener()

void bpp::AbstractTreeDrawing::removeTreeDrawingListener ( TreeDrawingListener * listener )

inlineoverridevirtual

Remove a drawing listener from this instance.

Parameters

listener a pointer toward an object implementing the TreeDrawingListener interface. If the listener is autonomous, it will be deleted.

Implements bpp::TreeDrawing.

Definition at line 288 of file AbstractTreeDrawing.h.

References bpp::TreeDrawingListener::isAutonomous(), and listeners_.

◆ setDisplaySettings()

void bpp::AbstractTreeDrawing::setDisplaySettings ( std::shared_ptr< const TreeDrawingSettings > tds )

inlineoverridevirtual

Global drawing settings.

Implements bpp::TreeDrawing.

Definition at line 253 of file AbstractTreeDrawing.h.

References settings_.

◆ setTree()

void bpp::AbstractTreeDrawing::setTree ( const Tree & tree )

inlineoverridevirtual

Parameters

tree	A tree to associate with this drawing. The object will be copied.

Implements bpp::TreeDrawing.

Reimplemented in bpp::CladogramPlot, and bpp::PhylogramPlot.

Definition at line 202 of file AbstractTreeDrawing.h.

References tree(), tree_, and treeHasChanged().

Referenced by bpp::CladogramPlot::setTree(), and bpp::PhylogramPlot::setTree().

◆ setXUnit()

void bpp::AbstractTreeDrawing::setXUnit ( double xu )

inlineoverridevirtual

Set the 'horizontal' expansion unit.

The effect of this expansion factor depends on the implementation of the interface.

Parameters

xu	The horizontal unit length.

Implements bpp::TreeDrawing.

Definition at line 265 of file AbstractTreeDrawing.h.

References xUnit_.

◆ setYUnit()

void bpp::AbstractTreeDrawing::setYUnit ( double yu )

inlineoverridevirtual

Set the 'vertical' expansion unit.

The effect of this expansion factor depends on the implementation of the interface.

Parameters

yu	The vertical unit length.

Implements bpp::TreeDrawing.

Definition at line 267 of file AbstractTreeDrawing.h.

References yUnit_.

◆ tree()

const Tree & bpp::AbstractTreeDrawing::tree ( ) const

inlineoverridevirtual

Returns: A pointer toward the tree associated to this drawing.

Implements bpp::TreeDrawing.

Definition at line 178 of file AbstractTreeDrawing.h.

References hasTree(), and tree_.

Referenced by setTree(), bpp::CladogramPlot::setTree(), and bpp::PhylogramPlot::setTree().

◆ treeHasChanged()

virtual void bpp::AbstractTreeDrawing::treeHasChanged ( )

pure virtual

Method to implement to deal with redrawing when the underlying tree has been modified.

Implemented in bpp::CladogramPlot, and bpp::PhylogramPlot.

Referenced by setTree().

◆ treeTemplate()

const TreeTemplate< INode > & bpp::AbstractTreeDrawing::treeTemplate ( ) const

inline

Definition at line 190 of file AbstractTreeDrawing.h.

References hasTree(), and tree_.

Member Data Documentation

◆ DEFAULT_SETTINGS

shared_ptr< const TreeDrawingSettings > AbstractTreeDrawing::DEFAULT_SETTINGS = std::make_shared<const TreeDrawingSettings>()

static

Definition at line 359 of file AbstractTreeDrawing.h.

◆ listeners_

std::vector<TreeDrawingListener*> bpp::AbstractTreeDrawing::listeners_

protected

Definition at line 122 of file AbstractTreeDrawing.h.

Referenced by AbstractTreeDrawing(), addTreeDrawingListener(), fireAfterBranchEvent_(), fireAfterNodeEvent_(), fireAfterTreeEvent_(), fireBeforeBranchEvent_(), fireBeforeNodeEvent_(), fireBeforeTreeEvent_(), operator=(), removeTreeDrawingListener(), and ~AbstractTreeDrawing().

◆ settings_

std::shared_ptr<const TreeDrawingSettings> bpp::AbstractTreeDrawing::settings_

protected

Definition at line 121 of file AbstractTreeDrawing.h.

Referenced by belongsTo(), displaySettings(), operator=(), and setDisplaySettings().

◆ tree_

std::unique_ptr<TreeTemplate<INode> > bpp::AbstractTreeDrawing::tree_

protected

Definition at line 118 of file AbstractTreeDrawing.h.

Referenced by collapseNode(), bpp::CladogramPlot::drawDendrogram_(), bpp::PhylogramPlot::drawDendrogram_(), getNodeAt(), getNodePosition(), hasTree(), isNodeCollapsed(), operator=(), setTree(), bpp::CladogramPlot::setTree(), bpp::PhylogramPlot::setTree(), tree(), bpp::CladogramPlot::treeHasChanged(), bpp::PhylogramPlot::treeHasChanged(), and treeTemplate().

◆ xUnit_

double bpp::AbstractTreeDrawing::xUnit_

protected

Definition at line 119 of file AbstractTreeDrawing.h.

Referenced by drawAtBranch(), drawAtNode(), getXUnit(), operator=(), and setXUnit().

◆ yUnit_

double bpp::AbstractTreeDrawing::yUnit_

protected

Definition at line 120 of file AbstractTreeDrawing.h.

Referenced by drawAtBranch(), drawAtNode(), getYUnit(), operator=(), and setYUnit().

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

Bpp/Phyl/Graphics/AbstractTreeDrawing.h
Bpp/Phyl/Graphics/AbstractTreeDrawing.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AbstractTreeDrawing() [1/2]

◆ AbstractTreeDrawing() [2/2]

◆ ~AbstractTreeDrawing()

Member Function Documentation

◆ addTreeDrawingListener()

◆ belongsTo()

◆ clone()

◆ collapseNode()

◆ displaySettings()

◆ drawAtBranch()

◆ drawAtNode()

◆ fireAfterBranchEvent_()

◆ fireAfterNodeEvent_()

◆ fireAfterTreeEvent_()

◆ fireBeforeBranchEvent_()

◆ fireBeforeNodeEvent_()

◆ fireBeforeTreeEvent_()

◆ getHeight()

◆ getName()

◆ getNodeAt()

◆ getNodePosition()

◆ getWidth()

◆ getXUnit()

◆ getYUnit()

◆ hasTree()

◆ isNodeCollapsed()

◆ operator=()

◆ plot()

◆ removeTreeDrawingListener()

◆ setDisplaySettings()

◆ setTree()

◆ setXUnit()

◆ setYUnit()

◆ tree()

◆ treeHasChanged()

◆ treeTemplate()

Member Data Documentation

◆ DEFAULT_SETTINGS

◆ listeners_

◆ settings_

◆ tree_

◆ xUnit_

◆ yUnit_