vtf-logo

geom::Circle3< T > Class Template Reference

A circle in 3-dimensional space. More...

#include <Circle3.h>

List of all members.

Public Types

typedef T Number
 The number type.
typedef ads::FixedArray<
3, Number > 
Point
 The representation of a point.

Public Member Functions

Constructors etc.
 Circle3 ()
 Default constructor. Uninitialized memory.
 Circle3 (const Point &center, const Point &normal, const Number radius)
 Construct from the center, normal, and radius.
 Circle3 (const Circle3 &other)
 Copy constructor.
Circle3 & operator= (const Circle3 &other)
 Assignment operator.
 ~Circle3 ()
 Trivial destructor.
void make (const Point &center, const Point &normal, const Number radius)
 Make from the center, normal, and radius.
Accesors.
const Point & getCenter () const
 Return the center.
const Point & getNormal () const
 Return the normal.
Number getRadius () const
 Return the radius.
Manipulators.
void setCenter (const Point &center)
 Set the center.
void setNormal (const Point &normal)
 Set the normal.
void setRadius (const Number radius)
 Set the radius.
Translations.
Circle3 & operator+= (const Point &x)
 Translate by p.
Circle3 & operator-= (const Point &x)
 Translate by -p.
Validity.
bool isValid () const
 Return true if the circle is valid.

Related Functions

(Note that these are not member functions.)

bool operator== (const Circle3< T > &x, const Circle3< T > &y)
 Return true if the balls are equal.
bool operator!= (const Circle3< T > &x, const Circle3< T > &y)
 Return true if the balls are not equal.
Circle3< T > operator+ (const Circle3< T > &circle, const typename Circle3< T >::Point &vector)
 Return a circle translated by the vector.
Circle3< T > operator- (const Circle3< T > &circle, const typename Circle3< T >::Point &vector)
 Return a circle translated by the negative of the vector.
std::istream & operator>> (std::istream &in, Circle3< T > &x)
 Read a circle.
std::ostream & operator<< (std::ostream &out, const Circle3< T > &x)
 Write the circle.


Detailed Description

template<typename T = double>
class geom::Circle3< T >

A circle in 3-dimensional space.

Parameters:
T is the number type. By default it is double.
A circle in 3-D is defined by a center, a normal, and a radius.


The documentation for this class was generated from the following file:
Generated on Fri Aug 24 12:56:00 2007 for Computational Geometry Package by  doxygen 1.4.7