/usr/include/BALL/VIEW/PRIMITIVES/tube.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 183 184 185 186 187 188 189 190 | // -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//
// $Id: tube.h,v 1.11.16.1 2007-03-25 21:26:12 oliver Exp $
//
#ifndef BALL_VIEW_PRIMITIV_TUBE_H
#define BALL_VIEW_PRIMITIV_TUBE_H
#ifndef BALL_VIEW_KERNEL_GEOMETRICOBJECT_H
# include <BALL/VIEW/KERNEL/geometricObject.h>
#endif
#ifndef BALL_VIEW_DATATYPE_VERTEX2_H
# include <BALL/VIEW/DATATYPE/vertex2.h>
#endif
namespace BALL
{
namespace VIEW
{
/** Tube class.
An instance of Tube represents an instance of the geometric representation "tube".
A tube has the following properties.
- color - the color of the tube
- radius - the radius of the tube
- vertex1 - the first vertex of the tube
- vertex2 - the second vertex of the tube
\par
The class Tube is derived from the classes GeometricObject
Radius and Vertex2.
See these classes for further information concerning
interface and additional methods. \par
\ingroup ViewPrimitives
*/
class BALL_VIEW_EXPORT Tube
: public GeometricObject,
public Vertex2
{
public:
BALL_CREATE(Tube)
/** @name Constructors
*/
//@{
/** Default Constructor.
Construct new tube.
The properties of this tube are set to:
- color - to the color black
- radius - set to 1
- vertex1 - to the vector (0,0,0)
- vertex2 - to the vector (0,0,0)
\par
\return Tube new constructed tube
\see GeometricObject
\see Radius
\see Vertex2
*/
Tube();
/** Copy constructor with cloning facility.
\see GeometricObject
\see Radius
\see Vertex2
*/
Tube(const Tube& tube);
//@}
/** @name Destructors */
//@{
/** Destructor.
Default destruction of this tube.
*/
virtual ~Tube();
/** Explicit default initialization.
Calls GeometricObject::clear
Calls Radius::clear
Calls Vertex2::clear
\see GeometricObject::clear
\see Radius::clear
\see Vertex2::clear
*/
virtual void clear();
//@}
/** @name Assignment methods */
//@{
/** Assignment.
\param tube the tube to be copied
\see Tube
*/
void set(const Tube& tube);
/** Assignment operator.
Calls set.
*/
const Tube& operator = (const Tube& tube);
/** Swapping of tube's.
Swap the value of this tube with the tube <b> tube</b>.
\param tube the tube being swapped with this tube
*/
void swap(Tube& tube);
//@}
/** @name Accessors: inspectors and mutators */
//@{
/** Inspection of the length of the tube.
Access the length of this tube.
\return float the length of this tube
*/
float getLength() const
{return (getVertex1() - getVertex2()).getLength();}
/** Inspection of the square length of the tube.
Access the square length of this tube.
\return float the square length of this tube
*/
float getSquareLength() const
{return (getVertex1() - getVertex2()).getSquareLength();}
//@}
/** @name debuggers and diagnostics */
//@{
/** Internal state and consistency self-validation.
Initiate self-validation of the internal state and data structure consistencies
of this tube.
If the internal state of this tube is correct (self-validated) and
consistent <tt> true</tt> is returned, <tt> false</tt> otherwise.
Calls GeometricObject::isValid.
Calls Vertex2::isValid.
\return bool <tt> true</tt> if the internal state of this tube is correct
(self-validated) and consistent, <tt> false</tt> otherwise
\see GeometricObject::isValid
\see Vertex2::isValid
*/
virtual bool isValid() const;
/** Internal value dump.
Dump the current value of this tube to
the output ostream <b> s</b> with dumping depth <b> depth</b>.
Calls GeometricObject::dump.
Calls Radius::dump.
Calls Vertex2::dump.
\param s output stream where to output the value of this tube
\param depth the dumping depth
\see GeometricObject::dump
\see Radius::dump
\see Vertex2::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;
//@}
/** @name Storers */
//@{
/** Get the radius.
*/
float getRadius() const
{ return radius_;}
/** Set the radius.
*/
void setRadius(float radius)
{ radius_ = radius;}
//@}
private:
float radius_;
};
} // namespace VIEW
} // namespace BALL
#endif // BALL_VIEW_PRIMITIV_TUBE_H
|