include/geometry/sphere.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2006 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
/******************************************************************************
** $RCSfile: sphere.h,v $ $Revision: 1.1 $ $State: Exp $
******************************************************************************/
#ifndef sphere_H_
#define sphere_H_

#include "geometry/geometryDefines.h"
#include "geometry/point.h"
#include "geometry/tdbextent.h"

//
// \file sphere.h
// \brief DtSphere
//

// \brief Representation of a simple mathematical sphere. 
// \note The radius component of the center point is \b always greater than zero.
class DT_DLL_geometry DtSphere
{
public:
   DtSphere(DtPoint newCenter, double newRadius);

   virtual ~DtSphere();

   // This class is copyable and assignable.  Because the implementations are so
   // simple, the compiler generated ones are sufficient.
   //   DtSphere(const DtSphere& original);
   //   const DtSphere& operator=(const DtSphere& original);

   double radius() const;
   bool setRadius(double newRadius);

   DtPoint center() const;
   void setCenter(DtPoint& newCenter);

protected:

   bool testInvariant() const;

private:

   double myRadius;
   DtPoint myCenter;
};

// \return The extent of the provided sphere.
DT_DLL_geometry DtExtent extentOfSphere(const DtSphere& sphere);

#endif