VIEW::Tube Class Reference
[Geometric Objects]

Tube class. More...

#include <tube.h>

Inheritance diagram for VIEW::Tube:

List of all members.

Public Member Functions
Constructors
	Tube () throw ()
	Default Constructor.
	Tube (const Tube &tube) throw ()
	Copy constructor with cloning facility.
Destructors
virtual	~Tube () throw ()
	Destructor.
virtual void	clear () throw ()
	Explicit default initialization.
Assignment methods
void	set (const Tube &tube) throw ()
	Assignment.
const Tube &	operator= (const Tube &tube) throw ()
	Assignment operator.
void	swap (Tube &tube) throw ()
	Swapping of tube's.
Accessors: inspectors and mutators
float	getLength () const throw ()
	Inspection of the length of the tube.
float	getSquareLength () const throw ()
	Inspection of the square length of the tube.
debuggers and diagnostics
virtual bool	isValid () const throw ()
	Internal state and consistency self-validation.
virtual void	dump (std::ostream &s=std::cout, Size depth=0) const throw ()
	Internal value dump.
virtual void	getVertices (vector< Vector3 > &vertices) const
Storers
float	getRadius () const throw ()
	Get the radius.
void	setRadius (float radius) throw ()
	Set the radius.

---

Detailed Description

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

  The class Tube is derived from the classes GeometricObject Radius and Vertex2. See these classes for further information concerning interface and additional methods.

---

Constructor & Destructor Documentation

VIEW::Tube::Tube (   )  throw ()

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) Returns: Tube new constructed tube See also: GeometricObject Radius Vertex2

VIEW::Tube::Tube (  const Tube &  tube  )  throw ()

Copy constructor with cloning facility. See also: GeometricObject Radius Vertex2

virtual VIEW::Tube::~Tube (   )  throw () [virtual]

Destructor. Default destruction of this tube.

---

Member Function Documentation

virtual void VIEW::Tube::clear (   )  throw () [virtual]

Explicit default initialization. Calls GeometricObject::clear Calls Radius::clear Calls Vertex2::clear See also: GeometricObject::clear Radius::clear Vertex2::clear Reimplemented from VIEW::Vertex2.

virtual void VIEW::Tube::dump (  std::ostream &  s = std::cout, Size  depth = 0 )  const throw () [virtual]

Internal value dump. Dump the current value of this tube to the output ostream s with dumping depth depth. Calls GeometricObject::dump. Calls Radius::dump. Calls Vertex2::dump. Parameters: s  output stream where to output the value of this tube depth  the dumping depth See also: GeometricObject::dump Radius::dump Vertex2::dump Reimplemented from VIEW::Vertex2.

float VIEW::Tube::getLength (   )  const throw ()

Inspection of the length of the tube. Access the length of this tube. Returns: float the length of this tube

float VIEW::Tube::getRadius (   )  const throw ()

Get the radius.

float VIEW::Tube::getSquareLength (   )  const throw ()

Inspection of the square length of the tube. Access the square length of this tube. Returns: float the square length of this tube

virtual bool VIEW::Tube::isValid (   )  const throw () [virtual]

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 true is returned, false otherwise. Calls GeometricObject::isValid. Calls Vertex2::isValid. Returns: bool true if the internal state of this tube is correct (self-validated) and consistent, false otherwise See also: GeometricObject::isValid Vertex2::isValid Reimplemented from VIEW::Vertex2.

const Tube& VIEW::Tube::operator= (  const Tube &  tube  )  throw ()

Assignment operator. Calls set.

void VIEW::Tube::set (  const Tube &  tube  )  throw ()

Assignment. Parameters: tube  the tube to be copied See also: Tube

void VIEW::Tube::setRadius (  float  radius  )  throw ()

Set the radius.

void VIEW::Tube::swap (  Tube &  tube  )  throw ()

Swapping of tube's. Swap the value of this tube with the tube tube. Parameters: tube  the tube being swapped with this tube