/usr/include/Bpp/Phyl/Graphics/TreeDrawingListener.h is in libbpp-phyl-dev 2.1.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 | //
// File: TreeDrawingListener.h
// Created by: Julien Dutheil
// Created on: Tue May 18 10:33 2010
//
/*
Copyright or © or Copr. Bio++ Development Team, (2010)
This software is a computer program whose purpose is to provide
graphic components to develop bioinformatics applications.
This software is governed by the CeCILL license under French law and
abiding by the rules of distribution of free software. You can use,
modify and/ or redistribute the software under the terms of the CeCILL
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info".
As a counterpart to the access to the source code and rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty and the software's author, the holder of the
economic rights, and the successive licensors have only limited
liability.
In this respect, the user's attention is drawn to the risks associated
with loading, using, modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean that it is complicated to manipulate, and that also
therefore means that it is reserved for developers and experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or
data to be ensured and, more generally, to use and operate it in the
same conditions as regards security.
The fact that you are presently reading this means that you have had
knowledge of the CeCILL license and that you accept its terms.
*/
#ifndef _TREEDRAWINGLISTENER_H_
#define _TREEDRAWINGLISTENER_H_
#include "TreeDrawing.h"
#include <Bpp/Clonable.h>
namespace bpp {
/**
* @brief Interface allowing to capture drawing events.
*
* Implementing this interface allows you to easily and efficiently tune a plot,
* and/or add elements to it.
*/
class TreeDrawingListener :
public virtual Clonable
{
public:
#ifndef NO_VIRTUAL_COV
TreeDrawingListener*
#else
Clonable*
#endif
clone() const = 0;
virtual void beforeDrawTree(const DrawTreeEvent& event) = 0;
virtual void afterDrawTree(const DrawTreeEvent& event) = 0;
virtual void beforeDrawNode(const DrawNodeEvent& event) = 0;
virtual void afterDrawNode(const DrawNodeEvent& event) = 0;
virtual void beforeDrawBranch(const DrawBranchEvent& event) = 0;
virtual void afterDrawBranch(const DrawBranchEvent& event) = 0;
/**
* @brief Tells if the listener is autonomous. If so, it
* will never be hard-copied or deleted.
*/
virtual bool isAutonomous() const = 0;
virtual bool isEnabled() const = 0;
virtual void enable(bool tf) = 0;
};
/**
* @brief An empty implementation of the TreeDrawingListener interface.
*/
class TreeDrawingListenerAdapter :
public virtual TreeDrawingListener
{
private:
bool autonomous_;
bool enabled_;
public:
TreeDrawingListenerAdapter(bool autonomous) : autonomous_(autonomous), enabled_(true) {}
public:
void beforeDrawTree(const DrawTreeEvent& event) {}
void afterDrawTree(const DrawTreeEvent& event) {}
void beforeDrawNode(const DrawNodeEvent& event) {}
void afterDrawNode(const DrawNodeEvent& event) {}
void beforeDrawBranch(const DrawBranchEvent& event) {}
void afterDrawBranch(const DrawBranchEvent& event) {}
bool isAutonomous() const { return autonomous_; }
bool isEnabled() const { return enabled_; }
void enable(bool tf) { enabled_ = tf; }
};
/**
* @brief A TreeDrawingListener implementation that writes nodes id.
*/
class NodesIdTreeDrawingListener :
public TreeDrawingListenerAdapter
{
private:
const TreeDrawingSettings* settings_;
public:
NodesIdTreeDrawingListener(const TreeDrawingSettings* settings, bool autonomous = false) :
TreeDrawingListenerAdapter(autonomous),
settings_(settings)
{}
NodesIdTreeDrawingListener(const NodesIdTreeDrawingListener& lntdl) :
TreeDrawingListenerAdapter(lntdl),
settings_(lntdl.settings_) {}
NodesIdTreeDrawingListener& operator=(const NodesIdTreeDrawingListener& lntdl)
{
TreeDrawingListenerAdapter::operator=(lntdl);
settings_ = lntdl.settings_;
return *this;
}
NodesIdTreeDrawingListener* clone() const { return new NodesIdTreeDrawingListener(*this); }
public :
void afterDrawNode(const DrawNodeEvent& event);
};
/**
* @brief A TreeDrawingListener implementation that write leaf names.
*/
class LeafNamesTreeDrawingListener :
public TreeDrawingListenerAdapter
{
private:
const TreeDrawingSettings* settings_;
public:
LeafNamesTreeDrawingListener(const TreeDrawingSettings* settings, bool autonomous = false) :
TreeDrawingListenerAdapter(autonomous),
settings_(settings)
{}
LeafNamesTreeDrawingListener(const LeafNamesTreeDrawingListener& lntdl) :
TreeDrawingListenerAdapter(lntdl),
settings_(lntdl.settings_)
{}
LeafNamesTreeDrawingListener& operator=(const LeafNamesTreeDrawingListener& lntdl)
{
TreeDrawingListenerAdapter::operator=(lntdl);
settings_ = lntdl.settings_;
return *this;
}
LeafNamesTreeDrawingListener* clone() const { return new LeafNamesTreeDrawingListener(*this); }
public :
void afterDrawNode(const DrawNodeEvent& event);
};
/**
* @brief A TreeDrawingListener implementation that write the branch lengths of inner nodes.
*
* Collapsed nodes are not labelled.
*
* This listener works with TreeDrawing classes, but is more efficient when used with a class that fires DrawINodeEvent events.
*/
class BranchLengthsTreeDrawingListener :
public TreeDrawingListenerAdapter
{
private:
const TreeDrawingSettings* settings_;
public:
BranchLengthsTreeDrawingListener(const TreeDrawingSettings* settings, bool autonomous = false) :
TreeDrawingListenerAdapter(autonomous),
settings_(settings)
{}
BranchLengthsTreeDrawingListener(const BranchLengthsTreeDrawingListener& lntdl) :
TreeDrawingListenerAdapter(lntdl),
settings_(lntdl.settings_)
{}
BranchLengthsTreeDrawingListener& operator=(const BranchLengthsTreeDrawingListener& lntdl)
{
TreeDrawingListenerAdapter::operator=(lntdl);
settings_ = lntdl.settings_;
return *this;
}
BranchLengthsTreeDrawingListener* clone() const { return new BranchLengthsTreeDrawingListener(*this); }
public :
void afterDrawBranch(const DrawBranchEvent& event);
};
/**
* @brief A TreeDrawingListener implementation that write the bootstrap values of inner nodes.
*
* Collapsed nodes are not labelled.
*
* This listener works with TreeDrawing classes, but is more efficient when used with a class that fires DrawINodeEvent events.
*/
class BootstrapValuesTreeDrawingListener :
public TreeDrawingListenerAdapter
{
private:
const TreeDrawingSettings* settings_;
public:
BootstrapValuesTreeDrawingListener(const TreeDrawingSettings* settings, bool autonomous = false) :
TreeDrawingListenerAdapter(autonomous),
settings_(settings)
{}
BootstrapValuesTreeDrawingListener(const BootstrapValuesTreeDrawingListener& lntdl) :
TreeDrawingListenerAdapter(lntdl),
settings_(lntdl.settings_) {}
BootstrapValuesTreeDrawingListener& operator=(const BootstrapValuesTreeDrawingListener& lntdl)
{
TreeDrawingListenerAdapter::operator=(lntdl);
settings_ = lntdl.settings_;
return *this;
}
BootstrapValuesTreeDrawingListener* clone() const { return new BootstrapValuesTreeDrawingListener(*this); }
public :
void afterDrawBranch(const DrawBranchEvent& event);
};
/**
* @brief A TreeDrawingListener implementation that write the names of inner nodes.
*
* Collapsed nodes are not labelled.
*
* This listener works with TreeDrawing classes, but is more efficient when used with a class that fires DrawINodeEvent events.
*/
class LabelInnerNodesTreeDrawingListener :
public TreeDrawingListenerAdapter
{
public:
LabelInnerNodesTreeDrawingListener(bool autonomous = false) :
TreeDrawingListenerAdapter(autonomous) {}
LabelInnerNodesTreeDrawingListener* clone() const { return new LabelInnerNodesTreeDrawingListener(*this); }
public :
void afterDrawNode(const DrawNodeEvent& event);
};
/**
* @brief A TreeDrawingListener implementation that label the collapsed nodes.
*
* This listener works with TreeDrawing classes, but is more efficient when used with a class that fires DrawINodeEvent events.
*/
class LabelCollapsedNodesTreeDrawingListener :
public TreeDrawingListenerAdapter
{
public:
LabelCollapsedNodesTreeDrawingListener(bool autonomous = false) :
TreeDrawingListenerAdapter(autonomous) {}
LabelCollapsedNodesTreeDrawingListener* clone() const { return new LabelCollapsedNodesTreeDrawingListener(*this); }
public :
void afterDrawNode(const DrawNodeEvent& event);
};
} //end of namespace bpp
#endif //_TREEDRAWINGLISTENER_H_
|