BALL  1.4.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines
Private Attributes
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.

Definition at line 45 of file twoColoredTube.h.


Constructor & Destructor Documentation

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

Copy constructor with cloning facility.

See also:
GeometricObject
ColorExtension2
Vertex2

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.

Inspection of the length of the tube. Access the length of this tube.

Returns:
float the length of this tube

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

Get the radius.

Definition at line 179 of file twoColoredTube.h.

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.

Definition at line 183 of file twoColoredTube.h.

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

Swapping of two_colored_tube's.


Member Data Documentation

Definition at line 193 of file twoColoredTube.h.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines