Main Page | Modules | Namespace List | Class Hierarchy | Class List | Namespace Members | Class Members

VIEW::TwoColoredTube Class Reference
[Geometric Objects]

TwoColoredTube class. More...

#include <twoColoredTube.h>

Inheritance diagram for VIEW::TwoColoredTube:

VIEW::GeometricObject VIEW::ColorExtension2 VIEW::Vertex2 List of all members.

Public Member Functions

Constructors
 TwoColoredTube () throw ()
 Default Constructor.
 TwoColoredTube (const TwoColoredTube &two_colored_tube) throw ()
 Copy constructor with cloning facility.
Destructors
virtual ~TwoColoredTube () throw ()
 Destructor.
virtual void clear () throw ()
 Explicit default initialization.
Assignment methods
void set (const TwoColoredTube &two_colored_tube) throw ()
 Assignment.
const TwoColoredTubeoperator= (const TwoColoredTube &two_colored_tube) throw ()
 Assignment operator.
void swap (TwoColoredTube &two_colored_tube) throw ()
 Swapping of two_colored_tube's.
Accessors: inspectors and mutators
float getLength () const throw ()
 Inspection of the length of the tube.
Vector3 getMiddleVertex () const throw ()
 Inspection of the middle vector.
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.
Storers
float getRadius () const throw ()
 Get the radius.
void setRadius (float radius) throw ()
 Set the radius.
virtual void getVertices (vector< Vector3 > &vertices) const

Detailed Description

TwoColoredTube class.

An instance of TwoColoredTube represents an instance of the geometric representation of a two colored "tube". A twoColoredTube has the following properties.


Constructor & Destructor Documentation

VIEW::TwoColoredTube::TwoColoredTube  )  throw ()
 

Default Constructor.

Construct new twoColoredTube. The properties of this twoColoredTube are set to:

VIEW::TwoColoredTube::TwoColoredTube const TwoColoredTube two_colored_tube  )  throw ()
 

Copy constructor with cloning facility.

See also:
GeometricObject

ColorExtension2

Vertex2

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

Destructor.

Default destruction of this twoColoredTube.


Member Function Documentation

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

Explicit default initialization.

Calls GeometricObject::clear. Calls ColorExtension2::clear. Calls Vertex2::clear.

See also:
GeometricObject::clear

ColorExtension2::clear

Radius::clear

Vertex2::clear

Reimplemented from VIEW::ColorExtension2.

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

Internal value dump.

Dump the current value of this twoColoredTube to the output ostream s with dumping depth depth. Calls GeometricObject::dump. Calls ColorExtension2::dump. Calls Radius::dump. Calls Vertex2::dump.

Parameters:
s output stream where to output the value of this twoColoredTube
depth the dumping depth
See also:
GeometricObject::dump

ColorExtension2::dump

Radius::dump

Vertex2::dump

Reimplemented from VIEW::ColorExtension2.

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

Inspection of the length of the tube.

Access the length of this tube.

Returns:
float the length of this tube

Vector3 VIEW::TwoColoredTube::getMiddleVertex  )  const throw ()
 

Inspection of the middle vector.

Access the geometric middle vertex between vertex1 and vertex2 of this twoColoredTube.

Returns:
. Vector3 the middle vertex between vertex1 and vertex 2.
See also:
Vector3

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

Internal state and consistency self-validation.

Initiate self-validation of the internal state and data structure consistencies of this twoColoredTube. If the internal state of this twoColoredTube is correct (self-validated) and consistent true is returned, false otherwise. Calls {GeometricObject::isValid}.

Returns:
bool true if the internal state of this twoColoredTube is correct (self-validated) and consistent, false otherwise
See also:
GeometricObject::isValid

Reimplemented from VIEW::Vertex2.

const TwoColoredTube& VIEW::TwoColoredTube::operator= const TwoColoredTube two_colored_tube  )  throw ()
 

Assignment operator.

See also:
set

void VIEW::TwoColoredTube::set const TwoColoredTube two_colored_tube  )  throw ()
 

Assignment.

Calls GeometricObject::set. Calls ColorExtension2::set. Calls Vertex2::set.

void VIEW::TwoColoredTube::swap TwoColoredTube two_colored_tube  )  throw ()
 

Swapping of two_colored_tube's.