chord.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2005 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: chord.h,v $ $Revision: 1.13 $ $State: Exp $
*******************************************************************************/
#ifndef chord_H_
#define chord_H_

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





class DT_DLL_geometry DtChord
{
public:
   DtChord();

   DtChord(const DtPoint& endpoint0, const DtPoint& endpoint1);

   virtual ~DtChord();

   DtChord(const DtChord& orig);

   DtChord& operator=(const DtChord& orig);


   const DtPoint& endpoint0() const;

   const DtPoint& endpoint1() const;

   double directedXComponent() const;

   double directedYComponent() const;

   double directedZComponent() const;

   const DtExtent& extent() const;

   virtual DtPoint computePoint(const double t) const; 

   virtual bool isCollinear(const DtPoint& p) const;

   virtual bool parallelToXYPlane() const;

   virtual bool inPlaneZEquals(const double c) const;

   virtual bool intersectsPlaneZEqualsAtPoint(const double c, 
      double& tvalue) const; 

   virtual bool collinearPointLiesWithin(const DtPoint& pt) const;

   // \return The length of the chord.  
   // \note Slower than lengthSquared().
   double length() const;

   // \return The squared length of the chord.
   double lengthSquared() const;

protected:

   virtual double   minZ() const;

   virtual double   maxZ() const;

public:
//- -------------- deprecated access/manipulate routines -----------------
   double lengthOnX() const;

   double lengthOnY() const;

   double lengthOnZ() const;

   //debugging aid
   virtual  void dump(void) const;

//- -------------- end deprecated access/manipulate routines -----------------

private:
   DtPoint  myFirstEndpoint; 
   DtPoint  mySecondEndpoint; 


   double   myA;  //length of chord along x-axis
   double   myB;  //length of chord along y-axis
   double   myC;  //length of chord along z-axis

   DtExtent myExtent;
};


inline const DtExtent& DtChord::extent() const
{
  return myExtent;
}

inline const DtPoint& DtChord::endpoint0() const
{
  return myFirstEndpoint;
}

inline const DtPoint& DtChord::endpoint1() const
{
  return mySecondEndpoint;
}
 
inline double DtChord::directedXComponent() const
{
  return myA;
}

inline double DtChord::directedYComponent() const
{
  return myB;
}

inline double DtChord::directedZComponent() const
{
  return myC;
}
//- -------------- deprecated access/manipulate routines -----------------
inline double DtChord::lengthOnX() const
{
  return myA;
}

inline double DtChord::lengthOnY() const
{
  return myB;
}

inline double DtChord::lengthOnZ() const
{
  return myC;
}
//- -------------- end deprecated access/manipulate routines -----------------

#endif