BALL::TCircle3

BALL::TCircle3< T > Class Template Reference
[Generic three-dimensional circle.]

#include <BALL/MATHS/circle3.h>

List of all members.


Public Member Functions

Constructors and Destructors
 TCircle3 ()
 TCircle3 (const TCircle3 &circle)
 TCircle3 (const TVector3< T > &point, const TVector3< T > &normal, const T &radius)
virtual ~TCircle3 ()
virtual void clear ()
Assignment
void swap (TCircle3 &circle)
void set (const TCircle3 &circle)
void set (const TVector3< T > &point, const TVector3< T > &normal, const T &rad)
TCircle3 & operator= (const TCircle3 &circle)
void get (TCircle3 &circle) const
void get (TVector3< T > &point, TVector3< T > &normal, T &rhs) const
Predicates
bool operator== (const TCircle3 &circle) const
bool operator!= (const TCircle3 &circle) const
bool has (const TVector3< T > &point, bool on_surface=false) const
Debugging and Diagnostics
bool isValid () const
void dump (std::ostream &s=std::cout, Size depth=0) const

Public Attributes

Attributes
TVector3< T > p
TVector3< T > n
T radius

Detailed Description

template<typename T>
class BALL::TCircle3< T >

Generic Circle in Three-Dimensional Space.

Constructor & Destructor Documentation

template<typename T>
BALL::TCircle3< T >::TCircle3 (  )  [inline]

Default constructor. This method creates a new TCircle3 object. The three components are initialized to 0.

template<typename T>
BALL::TCircle3< T >::TCircle3 ( const TCircle3< T > &  circle  )  [inline]

Copy constructor. Create a new TCircle3 object from another.

Parameters:
circle the TCircle3 object to be copied
template<typename T>
BALL::TCircle3< T >::TCircle3 ( const TVector3< T > &  point,
const TVector3< T > &  normal,
const T &  radius 
) [inline]

Detailed constructor. Create a new TCircle3 object from the central point, the normal and a radius.

Parameters:
point assigned to the point
normal assigned to the normal
radius assigned tp the radius
template<typename T>
virtual BALL::TCircle3< T >::~TCircle3 (  )  [inline, virtual]

Destructor. Destructs the TCircle3 object. As there are no dynamic data structures, nothing happens.

Member Function Documentation

template<typename T>
virtual void BALL::TCircle3< T >::clear (  )  [inline, virtual]

Clear method. The values are set to 0.

Reimplemented in BALL::VIEW::Disc.

template<typename T>
void BALL::TCircle3< T >::dump ( std::ostream &  s = std::cout,
Size  depth = 0 
) const [inline]

Internal state dump. Dump the current internal state of {*this} to the output ostream s with dumping depth depth .

Parameters:
s - output stream where to output the internal state of {*this}
depth - the dumping depth

Reimplemented in BALL::VIEW::Disc.

template<typename T>
void BALL::TCircle3< T >::get ( TVector3< T > &  point,
TVector3< T > &  normal,
T &  rhs 
) const [inline]

Assign to two variables of type TVector3 and one T value.

Parameters:
point the center point
normal the circle normal
rhs the radius
template<typename T>
void BALL::TCircle3< T >::get ( TCircle3< T > &  circle  )  const [inline]

Assign to another TCircle3. Assigns the components to another circle.

Parameters:
circle the circle to be assigned to
template<typename T>
bool BALL::TCircle3< T >::has ( const TVector3< T > &  point,
bool  on_surface = false 
) const [inline]

Test if a given point is a member of the circle. Optional it can be testet, if the point lies on the surface.

Parameters:
point the point to be tested
on_surface true to test the surface (default = false)
Returns:
bool, true or false
template<typename T>
bool BALL::TCircle3< T >::isValid (  )  const [inline]

Test if instance is valid. Always returns true

Returns:
bool true

Reimplemented in BALL::VIEW::Disc.

template<typename T>
bool BALL::TCircle3< T >::operator!= ( const TCircle3< T > &  circle  )  const [inline]

Inequality operator.

Returns:
bool, false if all components are equal, true otherwise
template<typename T>
TCircle3& BALL::TCircle3< T >::operator= ( const TCircle3< T > &  circle  )  [inline]

Assignment operator. Assign the components from another circle.

Parameters:
circle the circle to assign from
template<typename T>
bool BALL::TCircle3< T >::operator== ( const TCircle3< T > &  circle  )  const [inline]

Equality operator.

Returns:
bool, true if all components are equal, false otherwise
template<typename T>
void BALL::TCircle3< T >::set ( const TVector3< T > &  point,
const TVector3< T > &  normal,
const T &  rad 
) [inline]

Assign the circle components.

Parameters:
point assigned to the point
normal assigned to the normal
rad assigned to the radius
template<typename T>
void BALL::TCircle3< T >::set ( const TCircle3< T > &  circle  )  [inline]

Assign from another TCircle3.

Parameters:
circle the TCirce3 object to assign from

Referenced by BALL::GetIntersection().

template<typename T>
void BALL::TCircle3< T >::swap ( TCircle3< T > &  circle  )  [inline]

Swap the contents of two circles.

Parameters:
circle the circle to swap contents with

Member Data Documentation

template<typename T>
TVector3<T> BALL::TCircle3< T >::n

Normal vector. This vector is orthogonal to the circle's plane.

Referenced by BALL::TCircle3< float >::clear(), BALL::TCircle3< float >::dump(), BALL::TCircle3< float >::get(), BALL::GetIntersection(), BALL::TCircle3< float >::has(), BALL::TCircle3< float >::operator!=(), BALL::TCircle3< float >::operator=(), BALL::TCircle3< float >::operator==(), BALL::operator>>(), BALL::TCircle3< float >::set(), and BALL::TCircle3< float >::swap().

template<typename T>
TVector3<T> BALL::TCircle3< T >::p

Circle Center. This point describes the center of the circle.

Referenced by BALL::TCircle3< float >::clear(), BALL::TCircle3< float >::dump(), BALL::TCircle3< float >::get(), BALL::GetIntersection(), BALL::TCircle3< float >::has(), BALL::TCircle3< float >::operator!=(), BALL::TCircle3< float >::operator=(), BALL::TCircle3< float >::operator==(), BALL::operator>>(), BALL::TCircle3< float >::set(), and BALL::TCircle3< float >::swap().

template<typename T>
T BALL::TCircle3< T >::radius

Radius. The radius of the circle.

Referenced by BALL::TCircle3< float >::clear(), BALL::TCircle3< float >::dump(), BALL::TCircle3< float >::get(), BALL::GetIntersection(), BALL::TCircle3< float >::has(), BALL::TCircle3< float >::operator!=(), BALL::TCircle3< float >::operator=(), BALL::TCircle3< float >::operator==(), BALL::operator>>(), BALL::TCircle3< float >::set(), and BALL::TCircle3< float >::swap().