BALL  1.4.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members
BALL::VIEW::Disc Class Reference

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

Inheritance diagram for BALL::VIEW::Disc:
BALL::VIEW::GeometricObject BALL::TCircle3< T >

Public Member Functions

Constructors
 Disc ()
 
 Disc (const Disc &disc)
 
 Disc (const Circle3 &circle)
 
Destructors
virtual ~Disc ()
 
virtual void clear ()
 
Assignment methods
void set (const Disc &Disc)
 
const Discoperator= (const Disc &Disc)
 
void swap (Disc &Disc)
 
void setCircle (const Circle3 &circle)
 
const Circle3getCircle () 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
 
- 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...
 

Additional Inherited Members

- Protected Member Functions inherited from BALL::TCircle3< T >
 TCircle3 ()
 
 TCircle3 (const TCircle3 &circle)
 
 TCircle3 (const TVector3< T > &point, const TVector3< T > &normal, const T &radius)
 
virtual ~TCircle3 ()
 
void swap (TCircle3 &circle)
 
void set (const TCircle3 &circle)
 
void set (const TVector3< T > &point, const TVector3< T > &normal, const T &rad)
 
TCircle3operator= (const TCircle3 &circle)
 
void get (TCircle3 &circle) const
 
void get (TVector3< T > &point, TVector3< T > &normal, T &rhs) const
 
bool operator== (const TCircle3 &circle) const
 
bool operator!= (const TCircle3 &circle) const
 
bool has (const TVector3< T > &point, bool on_surface=false) const
 
bool isValid () const
 
void dump (std::ostream &s=std::cout, Size depth=0) const
 
- Protected Attributes inherited from BALL::TCircle3< T >
TVector3< T > p
 
TVector3< T > n
 
radius
 

Detailed Description

Disc class. An instance of Disc represents an instance of the geometric representation "Disc". The class Disc is derived from the classes GeometricObject and Disc3. See these classes for further information concerning interface and additional methods.

Definition at line 29 of file disc.h.

Constructor & Destructor Documentation

BALL::VIEW::Disc::Disc ( )

Default Constructor.

BALL::VIEW::Disc::Disc ( const Disc disc)

Copy constructor

BALL::VIEW::Disc::Disc ( const Circle3 circle)
virtual BALL::VIEW::Disc::~Disc ( )
virtual

Destructor. Default destruction of this Disc.

Member Function Documentation

virtual void BALL::VIEW::Disc::clear ( )
virtual

Explicit default initialization.

See Also
GeometricObject::clear
Disc3::clear

Reimplemented from BALL::TCircle3< T >.

virtual void BALL::VIEW::Disc::dump ( std::ostream &  s = std::cout,
Size  depth = 0 
) const
virtual

Internal value dump. Dump the current value of this Disc to the output ostream s with dumping depth depth. Calls GeometricObject::dump. Calls Disc3::dump.

Parameters
soutput stream where to output the value of this Disc
depththe dumping depth
See Also
GeometricObject::dump
Disc3::dump

Reimplemented from BALL::VIEW::GeometricObject.

const Circle3& BALL::VIEW::Disc::getCircle ( ) const
inline

Definition at line 87 of file disc.h.

virtual void BALL::VIEW::Disc::getVertices ( vector< Vector3 > &  vertices) const
virtual

Reimplemented from BALL::VIEW::GeometricObject.

virtual bool BALL::VIEW::Disc::isValid ( ) const
virtual

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

Returns
bool true if the internal state of this Disc is correct (self-validated) and consistent, false otherwise
See Also
GeometricObject::isValid

Reimplemented from BALL::VIEW::GeometricObject.

const Disc& BALL::VIEW::Disc::operator= ( const Disc Disc)

Assignment operator.

void BALL::VIEW::Disc::set ( const Disc Disc)

Assignment.

void BALL::VIEW::Disc::setCircle ( const Circle3 circle)
void BALL::VIEW::Disc::swap ( Disc Disc)

Swapping of Disc's. Swap the value of this Disc with the Disc Disc.