/usr/include/BALL/VIEW/PRIMITIVES/label.h is in libballview1.4-dev 1.4.3~beta1-3.
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 | // -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//
#ifndef BALL_VIEW_PRIMITIV_LABEL_H
#define BALL_VIEW_PRIMITIV_LABEL_H
#ifndef BALL_VIEW_KERNEL_GEOMETRICOBJECT_H
# include <BALL/VIEW/KERNEL/geometricObject.h>
#endif
#ifndef BALL_VIEW_DATATYPE_VERTEX1_H
# include <BALL/VIEW/DATATYPE/vertex1.h>
#endif
#include <QtGui/QFont>
namespace BALL
{
namespace VIEW
{
/** Label class.
An instance of Label represents an instance of the geometric representation "label".
A label is an information text that can be pinned to another Composite or
GeometricObject. A label is both visible in the dynamic and static render
mode of the Scene.
A label has the following properties.
- color - the color of the label
- text - the text of the label
- vertex - the position of the label
\par
Labels support special text tags, that allows for automaticaly
created text:
<ul>
<li>%N Name
<li>%I Residue Id
<li>%T Atom type
<li>%C Atom charge
<li>%E Atom element
<li>%Y Atom type name
</ul>
\ingroup ViewPrimitives
*/
class BALL_VIEW_EXPORT Label
: public GeometricObject,
public Vertex
{
public:
BALL_CREATE(Label)
/** @name Constructors
*/
//@{
/** Default Constructor.
Construct new label.
The properties of this label are set to:
- color - to the color black
- text - to the text "unkown"
- vertex - to the vector (0,0,0)
\par
\return Label new constructed label
\see GeometricObject
\see Vertex
*/
Label();
/** Copy constructor with cloning facility.
\param label the label to be copied (cloned)
\see GeometricObject
\see Vertex
*/
Label(const Label& label);
//@}
/** @name Destructors */
//@{
/** Destructor.
*/
virtual ~Label();
/** Explicit default initialization.
Calls GeometricObject::clear
Calls Vertex::clear
\see GeometricObject::clear
\see Vertex::clear
*/
virtual void clear();
//@}
/** @name Assignment methods */
//@{
/** Assignment.
Assign the label <b> label</b> to this label.
\param label the label to be copied
*/
void set(const Label& label);
/** Assignment operator.
Calls set.
*/
const Label& operator = (const Label& label);
/** Swapping of label's.
*/
void swap(Label& label);
//@}
/** @name Inspectors, Mutators, Accessors */
//@{
/** Change the text of the label.
*/
void setText(const String& text)
{text_ = text;}
/** Inspection of the text of the label.
*/
String getText() const
{ return text_;}
/** Inspection of the expanded text of the label.
*/
String getExpandedText() const;
///
const QFont& getFont() const { return font_;}
///
void setFont(const QFont& font) { font_ = font;}
///
void setFontSize(Size size) { font_.setPixelSize(size);}
//@}
/** @name debuggers and diagnostics */
//@{
/** Internal state and consistency self-validation.
Initiate self-validation of the internal state and data structure consistencies
of this label.
If the internal state of this label is correct (self-validated) and
consistent <tt> true</tt> is returned, <tt> false</tt> otherwise.
Calls GeometricObject::isValid.
Calls Vertex::isValid.
\return bool <tt> true</tt> if the internal state of this label is correct
(self-validated) and consistent, <tt> false</tt> otherwise
\see GeometricObject::isValid
\see Vertex::isValid
*/
virtual bool isValid() const;
/** Internal value dump.
Dump the current value of this label to
the output ostream <b> s</b> with dumping depth <b> depth</b>.
Calls GeometricObject::dump.
Calls Vertex::dump.
\param s output stream where to output the value of this label
\param depth the dumping depth
\see GeometricObject::dump
\see Vertex::dump
*/
virtual void dump(std::ostream& s = std::cout, Size depth = 0) const;
// Method to get all vertices from a geometric object
virtual void getVertices(vector<Vector3>& vertices) const;
protected:
String text_;
QFont font_;
//@}
};
} // namespace VIEW
} // namespace BALL
#endif // BALL_VIEW_PRIMITIV_LABEL_H
|