BALL::VIEW::TwoColoredLine Class Reference

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

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

List of all members.

Public Member Functions

Constructors
 TwoColoredLine ()
 TwoColoredLine (const TwoColoredLine &two_colored_line)
Destructors
virtual ~TwoColoredLine ()
virtual void clear ()
Assignment methods
void set (const TwoColoredLine &two_colored_line)
const TwoColoredLineoperator= (const TwoColoredLine &two_colored_line)
void swap (TwoColoredLine &two_colored_line)
Accessors: inspectors and mutators
Vector3 getMiddleVertex () const
debuggers and diagnostics
virtual bool isValid () const
virtual void dump (std::ostream &s=std::cout, Size depth=0) const
virtual void getVertices (vector< Vector3 > &vertices) const

Detailed Description

TwoColoredLine class. An instance of TwoColoredLine represents an instance of the geometric representation of a two colored "line". A twoColoredLine has the following properties.

  • color1 - the color for the first vertex of the line
  • color2 - the color for the second vertex of the line
  • vertex1 - the first vertex of the line
  • vertex2 - the second vertex of the line
    The class TwoColoredLine is a line that is half colored in the color 1 and in color 2. The line 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 TwoColoredLine is derived from the classes GeometricObject, ColorExtension2 and Vertex2. See these classes for further information concerning interface and additional methods.

Constructor & Destructor Documentation

BALL::VIEW::TwoColoredLine::TwoColoredLine ( )

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

BALL::VIEW::TwoColoredLine::TwoColoredLine ( const TwoColoredLine two_colored_line)

Copy constructor with cloning facility.

See also:
GeometricObject
ColorExtension2
Vertex2
virtual BALL::VIEW::TwoColoredLine::~TwoColoredLine ( ) [virtual]

Destructor. Default destruction of this twoColoredLine.


Member Function Documentation

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

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

Parameters:
soutput stream where to output the value of this twoColoredLine
depththe dumping depth
See also:
GeometricObject::dump
ColorExtension2::dump
Vertex2::dump

Reimplemented from BALL::VIEW::ColorExtension2.

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

Inspection of the middle vector. Access the geometric middle vertex between vertex1 and vertex2 of this twoColoredLine.

Returns:
. Vector3 the middle vertex between vertex1 and vertex 2.
See also:
Vector3
virtual void BALL::VIEW::TwoColoredLine::getVertices ( vector< Vector3 > &  vertices) const [virtual]

Reimplemented from BALL::VIEW::GeometricObject.

virtual bool BALL::VIEW::TwoColoredLine::isValid ( ) const [virtual]

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

Returns:
bool true if the internal state of this twoColoredLine is correct
See also:
GeometricObject::isValid

Reimplemented from BALL::VIEW::Vertex2.

const TwoColoredLine& BALL::VIEW::TwoColoredLine::operator= ( const TwoColoredLine two_colored_line)

Assignment operator. Calls set.

void BALL::VIEW::TwoColoredLine::set ( const TwoColoredLine two_colored_line)
void BALL::VIEW::TwoColoredLine::swap ( TwoColoredLine two_colored_line)

Swapping of two_colored_line's.