bpp-phyl3  3.0.0
Public Member Functions | Private Attributes | List of all members
bpp::Cursor Class Reference

Data structure describing a plotting direction. More...

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

Public Member Functions

 Cursor (double x, double y, double angle=0, short hpos=GraphicDevice::TEXT_HORIZONTAL_CENTER, short vpos=GraphicDevice::TEXT_VERTICAL_CENTER)
 
double getX () const
 
double getY () const
 
double getAngle () const
 
short getHPos () const
 
short getVPos () const
 
double addX (double increment)
 
double addY (double increment)
 
Cursor getTranslation (double x, double y) const
 

Private Attributes

double x_
 
double y_
 
double angle_
 
short hpos_
 
short vpos_
 

Detailed Description

Data structure describing a plotting direction.

Definition at line 52 of file TreeDrawing.h.

Constructor & Destructor Documentation

◆ Cursor()

bpp::Cursor::Cursor ( double  x,
double  y,
double  angle = 0,
short  hpos = GraphicDevice::TEXT_HORIZONTAL_CENTER,
short  vpos = GraphicDevice::TEXT_VERTICAL_CENTER 
)
inline

Definition at line 62 of file TreeDrawing.h.

Member Function Documentation

◆ addX()

double bpp::Cursor::addX ( double  increment)
inline

Definition at line 71 of file TreeDrawing.h.

References x_.

Referenced by getTranslation().

◆ addY()

double bpp::Cursor::addY ( double  increment)
inline

Definition at line 72 of file TreeDrawing.h.

References y_.

Referenced by getTranslation().

◆ getAngle()

double bpp::Cursor::getAngle ( ) const
inline

Definition at line 68 of file TreeDrawing.h.

References angle_.

Referenced by bpp::BranchLengthsTreeDrawingListener::afterDrawBranch(), bpp::BootstrapValuesTreeDrawingListener::afterDrawBranch(), bpp::NodesIdTreeDrawingListener::afterDrawNode(), bpp::LeafNamesTreeDrawingListener::afterDrawNode(), bpp::LabelInnerNodesTreeDrawingListener::afterDrawNode(), and bpp::LabelCollapsedNodesTreeDrawingListener::afterDrawNode().

◆ getHPos()

short bpp::Cursor::getHPos ( ) const
inline

Definition at line 69 of file TreeDrawing.h.

References hpos_.

Referenced by bpp::BootstrapValuesTreeDrawingListener::afterDrawBranch(), bpp::NodesIdTreeDrawingListener::afterDrawNode(), bpp::LeafNamesTreeDrawingListener::afterDrawNode(), bpp::LabelInnerNodesTreeDrawingListener::afterDrawNode(), and bpp::LabelCollapsedNodesTreeDrawingListener::afterDrawNode().

◆ getTranslation()

Cursor bpp::Cursor::getTranslation ( double  x,
double  y 
) const
inline

Definition at line 74 of file TreeDrawing.h.

References addX(), and addY().

Referenced by bpp::CladogramDrawBranchEvent::getBranchCursor(), and bpp::PhylogramDrawBranchEvent::getBranchCursor().

◆ getVPos()

short bpp::Cursor::getVPos ( ) const
inline

Definition at line 70 of file TreeDrawing.h.

References vpos_.

Referenced by bpp::NodesIdTreeDrawingListener::afterDrawNode(), bpp::LeafNamesTreeDrawingListener::afterDrawNode(), bpp::LabelInnerNodesTreeDrawingListener::afterDrawNode(), and bpp::LabelCollapsedNodesTreeDrawingListener::afterDrawNode().

◆ getX()

double bpp::Cursor::getX ( ) const
inline

Definition at line 66 of file TreeDrawing.h.

References x_.

Referenced by bpp::BranchLengthsTreeDrawingListener::afterDrawBranch(), bpp::BootstrapValuesTreeDrawingListener::afterDrawBranch(), bpp::NodesIdTreeDrawingListener::afterDrawNode(), bpp::LeafNamesTreeDrawingListener::afterDrawNode(), bpp::LabelInnerNodesTreeDrawingListener::afterDrawNode(), and bpp::LabelCollapsedNodesTreeDrawingListener::afterDrawNode().

◆ getY()

double bpp::Cursor::getY ( ) const
inline

Definition at line 67 of file TreeDrawing.h.

References y_.

Referenced by bpp::BranchLengthsTreeDrawingListener::afterDrawBranch(), bpp::BootstrapValuesTreeDrawingListener::afterDrawBranch(), bpp::NodesIdTreeDrawingListener::afterDrawNode(), bpp::LeafNamesTreeDrawingListener::afterDrawNode(), bpp::LabelInnerNodesTreeDrawingListener::afterDrawNode(), and bpp::LabelCollapsedNodesTreeDrawingListener::afterDrawNode().

Member Data Documentation

◆ angle_

double bpp::Cursor::angle_
private

Definition at line 57 of file TreeDrawing.h.

Referenced by getAngle().

◆ hpos_

short bpp::Cursor::hpos_
private

Definition at line 58 of file TreeDrawing.h.

Referenced by getHPos().

◆ vpos_

short bpp::Cursor::vpos_
private

Definition at line 59 of file TreeDrawing.h.

Referenced by getVPos().

◆ x_

double bpp::Cursor::x_
private

Definition at line 55 of file TreeDrawing.h.

Referenced by addX(), and getX().

◆ y_

double bpp::Cursor::y_
private

Definition at line 56 of file TreeDrawing.h.

Referenced by addY(), and getY().

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