BALL  1.4.79
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members
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

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. More...
 
void setRadius (float radius)
 Set the radius. More...
 
virtual void getVertices (vector< Vector3 > &vertices) const
 
- Public Member Functions inherited from BALL::VIEW::GeometricObject
 GeometricObject ()
 
 GeometricObject (const GeometricObject &object)
 
virtual ~GeometricObject ()
 
void set (const GeometricObject &object)
 
GeometricObjectoperator= (const GeometricObject &object)
 
void swap (GeometricObject &object)
 
void setComposite (const Composite *composite)
 
const CompositegetComposite () const
 
void setColor (const ColorRGBA &color)
 
void setColor (const ColorUnit &red, const ColorUnit &green, const ColorUnit &blue, const ColorUnit &alpha=(float) 1)
 
const ColorRGBAgetColor () const
 
ColorRGBAgetColor ()
 
void getColor (ColorUnit &red, ColorUnit &green, ColorUnit &blue, ColorUnit &alpha) const
 
void getColors (HashSet< String > &colors)
 Insert the colors of this object into the hashset. More...
 
bool operator== (const GeometricObject &object) const
 Needed for MSVC. More...
 
bool operator< (const GeometricObject &object) const
 Needed for MSVC. More...
 
- Public Member Functions inherited from BALL::VIEW::ColorExtension2
 ColorExtension2 ()
 
 ColorExtension2 (const ColorExtension2 &color_extension)
 
virtual ~ColorExtension2 ()
 
void set (const ColorExtension2 &color_extension)
 
const ColorExtension2operator= (const ColorExtension2 &color_extension)
 
void swap (ColorExtension2 &color_extension)
 
void setColor2 (const ColorRGBA &color)
 
ColorRGBAgetColor2 ()
 
const ColorRGBAgetColor2 () const
 
void getColor2 (ColorRGBA &color) const
 
- Public Member Functions inherited from BALL::VIEW::Vertex2
 Vertex2 ()
 
 Vertex2 (const Vertex2 &vertex)
 
virtual ~Vertex2 ()
 
void set (const Vertex2 &vertex)
 
const Vertex2operator= (const Vertex2 &vertex)
 
void swap (Vertex2 &vertex)
 
void setVertex1 (const Vector3 &v)
 
void setVertex1 (const float x, const float y, const float z)
 
Vector3getVertex1 ()
 
const Vector3getVertex1 () const
 
void getVertex1 (Vector3 &v) const
 
void getVertex1 (float &x, float &y, float &z) const
 
void setVertex1Address (const Vector3 &v)
 
void setDefaultVertex1Address ()
 
Vector3getVertex1Address () const
 
void setVertex2 (const Vector3 &v)
 
void setVertex2 (const float x, const float y, const float z)
 
Vector3getVertex2 ()
 
const Vector3getVertex2 () const
 
void getVertex2 (Vector3 &v) const
 
void getVertex2 (float &x, float &y, float &z) const
 
void setVertex2Address (const Vector3 &v)
 
void setDefaultVertex2Address ()
 
Vector3getVertex2Address () const
 
void setVertices (const Vector3 &vertex1, const Vector3 &vertex2)
 
void setVertices (const float vertex1_x, const float vertex1_y, const float vertex1_z, const float vertex2_x, const float vertex2_y, const float vertex2_z)
 
void setVertexAddresses (const Vector3 &vertex1, const Vector3 &vertex2)
 
void getVertices (Vector3 &vertex1, Vector3 &vertex2)
 
void getVertices (float &vertex1_x, float &vertex1_y, float &vertex1_z, float &vertex2_x, float &vertex2_y, float &vertex2_z)
 
void setDefaultVertexAddresses ()
 
bool isDefaultVertex1Address () const
 
bool isDefaultVertex2Address () const
 
bool isDefaultVertexAddresses () 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.

Definition at line 45 of file twoColoredTube.h.

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.

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.