Main Page | Modules | Namespace List | Class Hierarchy | Class List | Namespace Members | Class Members

VIEW::TwoColoredLine Class Reference
[Geometric Objects]

TwoColoredLine class. More...

#include <twoColoredLine.h>

Inheritance diagram for VIEW::TwoColoredLine:

VIEW::GeometricObject VIEW::ColorExtension2 VIEW::Vertex2 List of all members.

Public Member Functions

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


Constructor & Destructor Documentation

VIEW::TwoColoredLine::TwoColoredLine  )  throw ()
 

Default Constructor.

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

VIEW::TwoColoredLine::TwoColoredLine const TwoColoredLine two_colored_line  )  throw ()
 

Copy constructor with cloning facility.

See also:
GeometricObject

ColorExtension2

Vertex2

virtual VIEW::TwoColoredLine::~TwoColoredLine  )  throw () [virtual]
 

Destructor.

Default destruction of this twoColoredLine.


Member Function Documentation

virtual void VIEW::TwoColoredLine::clear  )  throw () [virtual]
 

Explicit default initialization.

Calls GeometricObject::clear. Calls ColorExtension2::clear. Calls Vertex2::clear.

See also:
GeometricObject::clear

ColorExtension2::clear

Vertex2::clear

Reimplemented from VIEW::ColorExtension2.

virtual void VIEW::TwoColoredLine::dump std::ostream &  s = std::cout,
Size  depth = 0
const throw () [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:
s output stream where to output the value of this twoColoredLine
depth the dumping depth
See also:
GeometricObject::dump

ColorExtension2::dump

Vertex2::dump

Reimplemented from VIEW::ColorExtension2.

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

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 bool VIEW::TwoColoredLine::isValid  )  const throw () [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 VIEW::Vertex2.

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

Assignment operator.

Calls set.

void VIEW::TwoColoredLine::set const TwoColoredLine two_colored_line  )  throw ()
 

Assignment.

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

See also:
GeometricObject::set

ColorExtension2::set

Vertex2::set

void VIEW::TwoColoredLine::swap TwoColoredLine two_colored_line  )  throw ()
 

Swapping of two_colored_line's.