VRS - The Virtual Rendering System

version 3.3

knot.h

Go to the documentation of this file.

/******************************************************************************
 * VRS - The Virtual Rendering System
 * Copyright (C) 2003 Computer Graphics Systems Group at the 
 * Hasso-Plattner-Institute (HPI), Potsdam, Germany.
 *
 * This  library  is  free  software; you can redistribute it and/or  modify it
 * under the terms of the GNU Lesser General Public  License  as  published  by
 * the  Free  Software  Foundation;  either  version 2.1 of the License, or (at
 * your option) any later version. This library  is  distributed  in  the  hope
 * that  it will be useful, but  WITHOUT ANY WARRANTY; without even the implied
 * warranty of  MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE.  See  the
 * GNU Lesser General Public License for more details. You should have received
 * a copy of the GNU Lesser+ General Public License along with this library; if
 * not, write to the FreeSoftware Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA, 02111-1307, USA.
 ******************************************************************************/

// $Id: knot.h 4633 2005-01-03 01:43:11Z klimetschek $
// $Date: 2005-01-03 02:43:11 +0100 (Mon, 03 Jan 2005) $
// $Revision: 4633 $
// $State$
// $Author: klimetschek $
//
// $Log$
// Revision 1.5  2005/01/03 01:43:08  klimetschek
// - modified win32 project layout, splitted vrs.vcproj into vrs_container, vrs_core, vrs_sg, vrs_image, vrs_opengl and vrs_io
// - removed vrs.vcproj
// minor things:
// - added all glutexamples to vrs4glut.sln
// - fixed some problems in glutexamples
// - removed all project references from all VS projects (using solution wide project dependencies instead)
//
// Revision 1.4  2004/11/05 13:58:09  basch
// Class comment changed (Doxygen style)
//

#ifndef VRS_KNOT_H
#define VRS_KNOT_H

#include <vrs/shape.h>

namespace VRS {

class VRS_CORE_API Knot:public Shape { 

public:
  Knot(
    double innerRad = 0.75,
    double rotRat = 0.25,
    double thickness = 0.125,
    const Vector& center = Vector(0,0,0),
    double phiMin = 0,
    double phiMax = 360,
    double theta = 360,
    double q = 3,
    double p = 2
  );
  /* a (p, q)-torus knot is obtained by looping a string through the hole of a 
     torus p times with q revolutions before joining its ends, where p and q 
     are relatively prime, means gcd(p,q)=1. */

  void setCenter(const Vector&);
  Vector getCenter() const;

  void setInnerRad(double);
  void setRotRad(double);
  void setThickness(double);
  double getInnerRad() const;
  double getRotRad() const;
  double getThickness() const;
  void setPhi(double minphi, double maxphi);
  double getPhiMin() const;
  double getPhiMax() const;
  void setTheta(double);
  double getTheta() const;
  void setP(double);
  void setQ(double);
  double getP() const;
  double getQ() const;
  virtual Bounds boundingBox() const;
  
  VRS_TYPEINFO(Knot, Shape);  
  VRS_SERIALIZABLE(Knot);
 
  private: 
      Vector center_;
      double innerRad_;
      double rotRad_;
      double thickness_;
      double phiMin_;
      double phiMax_;
      double theta_;
      double p_;
      double q_;
};

inline Vector Knot::getCenter() const { return center_;}
inline double Knot::getInnerRad() const { return innerRad_; }
inline double Knot::getRotRad() const { return rotRad_; }
inline double Knot::getThickness() const { return thickness_; }
inline double Knot::getPhiMin() const { return phiMin_; }
inline double Knot::getPhiMax() const { return phiMax_; }
inline double Knot::getTheta() const { return theta_; }
inline double Knot::getP() const { return p_; }
inline double Knot::getQ() const { return q_; }

} // namespace VRS

#endif // VRS_KNOT_H

---

Generated on Wed May 23 06:00:13 2012 by Doxygen 1.5.6

© 2001-2010 Hasso-Plattner-Institut | Impressum | Contact