BALL::VIEW::TwoColoredTube Class Reference
[Geometric Objects]

TwoColoredTube class. More...

#include <twoColoredTube.h>

Inheritance diagram for BALL::VIEW::TwoColoredTube:
Inheritance graph
[legend]

List of all members.


Public Member Functions

Constructors
TwoColoredTube ()
Default Constructor.
TwoColoredTube (const TwoColoredTube &two_colored_tube)
Copy constructor with cloning facility.
Destructors
virtual ~TwoColoredTube ()
Destructor.
virtual void clear ()
Explicit default initialization.
Assignment methods
void set (const TwoColoredTube &two_colored_tube)
Assignment.
const TwoColoredTube & operator= (const TwoColoredTube &two_colored_tube)
Assignment operator.
void swap (TwoColoredTube &two_colored_tube)
Swapping of two_colored_tube's.
Accessors: inspectors and mutators
float getLength () const
Inspection of the length of the tube.
Vector3 getMiddleVertex () const
Inspection of the middle vector.
debuggers and diagnostics
virtual bool isValid () const
Internal state and consistency self-validation.
virtual void dump (std::ostream &s=std::cout, Size depth=0) const
Internal value dump.
Storers
float getRadius () const
Get the radius.
void setRadius (float radius)
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

BALL::VIEW::TwoColoredTube::TwoColoredTube ( )

Default Constructor.

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

BALL::VIEW::TwoColoredTube::TwoColoredTube ( const TwoColoredTube & two_colored_tube )

Copy constructor with cloning facility.

See also:
GeometricObject

ColorExtension2

Vertex2

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

Destructor.

Default destruction of this twoColoredTube.


Member Function Documentation

virtual void BALL::VIEW::TwoColoredTube::clear ( ) [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 BALL::VIEW::ColorExtension2.

virtual void BALL::VIEW::TwoColoredTube::dump ( std::ostream & s = std::cout,
Size depth = 0
) const [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 BALL::VIEW::ColorExtension2.

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

Inspection of the length of the tube.

Access the length of this tube.

Returns:
float the length of this tube

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

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:
Three-dimensional vector.

virtual bool BALL::VIEW::TwoColoredTube::isValid ( ) const [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 BALL::VIEW::Vertex2.

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

Assignment operator.

See also:
set

void BALL::VIEW::TwoColoredTube::set ( const TwoColoredTube & two_colored_tube )

Assignment.

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


Generated on Thu Aug 6 18:30:59 2009 for BALL by doxygen 1.5.8