BALL::VIEW::TwoColoredTube Class Reference

#include <BALL/VIEW/PRIMITIVES/twoColoredTube.h>

Inheritance diagram for BALL::VIEW::TwoColoredTube:
BALL::VIEW::GeometricObject BALL::VIEW::ColorExtension2 BALL::VIEW::Vertex2

List of all members.

Public Member Functions

Constructors
 TwoColoredTube ()
 TwoColoredTube (const TwoColoredTube &two_colored_tube)
Destructors
virtual ~TwoColoredTube ()
virtual void clear ()
Assignment methods
void set (const TwoColoredTube &two_colored_tube)
const TwoColoredTubeoperator= (const TwoColoredTube &two_colored_tube)
void swap (TwoColoredTube &two_colored_tube)
Accessors: inspectors and mutators
float getLength () const
Vector3 getMiddleVertex () const
debuggers and diagnostics
virtual bool isValid () const
virtual void dump (std::ostream &s=std::cout, Size depth=0) const
Storers
float getRadius () const
 Get the radius.
void setRadius (float radius)
 Set the radius.
virtual void getVertices (vector< Vector3 > &vertices) const

Private Attributes

float radius_

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.

  • color1 - the color for the first vertex of the tube
  • color2 - the color for the second vertex of the tube
  • vertex1 - the first vertex of the tube
  • vertex2 - the second vertex of the tube
    The class TwoColoredTube is a tube that is half colored in the color 1 and in color 2. The tube is exactly divided in the middle. One half (starting from vertex1 til middle vertex) is colored by the color1 and the other half (starting from middle vertex to vertex2) is colored by color2. The class TwoColoredTube is derived from the classes GeometricObject, ColorExtension2, Radius and Vertex2. See these classes for further information concerning interface and additional methods.

Constructor & Destructor Documentation

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

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

  • color1 - set to the color black
  • color2 - set to the color black
  • radius - set to 1
  • vertex1 - set to the vector (0,0,0)
  • vertex2 - set to the vector (0,0,0)
    Returns:
    TwoColoredTube new constructed twoColoredTube
    See also:
    GeometricObject
    ColorExtension2
    Vertex2
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:
soutput stream where to output the value of this twoColoredTube
depththe 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:
Vector3
float BALL::VIEW::TwoColoredTube::getRadius ( ) const [inline]

Get the radius.

virtual void BALL::VIEW::TwoColoredTube::getVertices ( vector< Vector3 > &  vertices) const [virtual]

Reimplemented from BALL::VIEW::GeometricObject.

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.

void BALL::VIEW::TwoColoredTube::setRadius ( float  radius) [inline]

Set the radius.

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

Swapping of two_colored_tube's.


Member Data Documentation