bpp-phyl  2.2.0
bpp::DrawBranchEvent Class Referenceabstract

Event class used by TreeDrawing classes. More...

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

+ Inheritance diagram for bpp::DrawBranchEvent:
+ Collaboration diagram for bpp::DrawBranchEvent:

Public Member Functions

 DrawBranchEvent (const TreeDrawing *source, GraphicDevice *gd, int nodeId, const Cursor &cursor)
 
 DrawBranchEvent (const DrawBranchEvent &dne)
 
DrawBranchEventoperator= (const DrawBranchEvent &dne)
 
virtual ~DrawBranchEvent ()
 
virtual const TreeDrawinggetTreeDrawing () const
 
virtual GraphicDevice * getGraphicDevice () const
 
virtual int getNodeId () const
 
virtual const CursorgetCursor () const
 
virtual Cursor getBranchCursor (double position) const =0
 

Private Attributes

const TreeDrawingtd_
 
GraphicDevice * gd_
 
int id_
 
Cursor cursor_
 

Detailed Description

Event class used by TreeDrawing classes.

Definition at line 165 of file TreeDrawing.h.

Constructor & Destructor Documentation

◆ DrawBranchEvent() [1/2]

bpp::DrawBranchEvent::DrawBranchEvent ( const TreeDrawing source,
GraphicDevice *  gd,
int  nodeId,
const Cursor cursor 
)
inline

Definition at line 174 of file TreeDrawing.h.

◆ DrawBranchEvent() [2/2]

bpp::DrawBranchEvent::DrawBranchEvent ( const DrawBranchEvent dne)
inline

Definition at line 178 of file TreeDrawing.h.

◆ ~DrawBranchEvent()

virtual bpp::DrawBranchEvent::~DrawBranchEvent ( )
inlinevirtual

Definition at line 191 of file TreeDrawing.h.

Member Function Documentation

◆ getBranchCursor()

virtual Cursor bpp::DrawBranchEvent::getBranchCursor ( double  position) const
pure virtual
Returns
The coordinate of a point on the branch.
Parameters
positionThe position of the point on the branch, as a proportion of the total branch length.

Implemented in bpp::CladogramDrawBranchEvent, and bpp::PhylogramDrawBranchEvent.

◆ getCursor()

virtual const Cursor& bpp::DrawBranchEvent::getCursor ( ) const
inlinevirtual

◆ getGraphicDevice()

virtual GraphicDevice* bpp::DrawBranchEvent::getGraphicDevice ( ) const
inlinevirtual

Definition at line 195 of file TreeDrawing.h.

References gd_.

◆ getNodeId()

virtual int bpp::DrawBranchEvent::getNodeId ( ) const
inlinevirtual

◆ getTreeDrawing()

virtual const TreeDrawing* bpp::DrawBranchEvent::getTreeDrawing ( ) const
inlinevirtual

Definition at line 194 of file TreeDrawing.h.

References td_.

Referenced by bpp::PhylogramDrawBranchEvent::getBranchCursor().

◆ operator=()

DrawBranchEvent& bpp::DrawBranchEvent::operator= ( const DrawBranchEvent dne)
inline

Definition at line 182 of file TreeDrawing.h.

References cursor_, gd_, id_, and td_.

Referenced by bpp::DrawIBranchEvent::operator=().

Member Data Documentation

◆ cursor_

Cursor bpp::DrawBranchEvent::cursor_
private

Definition at line 171 of file TreeDrawing.h.

Referenced by getCursor(), and operator=().

◆ gd_

GraphicDevice* bpp::DrawBranchEvent::gd_
private

Definition at line 169 of file TreeDrawing.h.

Referenced by getGraphicDevice(), and operator=().

◆ id_

int bpp::DrawBranchEvent::id_
private

Definition at line 170 of file TreeDrawing.h.

Referenced by getNodeId(), and operator=().

◆ td_

const TreeDrawing* bpp::DrawBranchEvent::td_
private

Definition at line 168 of file TreeDrawing.h.

Referenced by getTreeDrawing(), and operator=().


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