Torus

[ DockingLib | Source | Keywords | Summary | Ancestors | All Members | Descendants ]

Quick Index

KEYWORD
AUTHORS
CHANGES LOG
GOALS
USAGE

Class Summary

class Torus
{
public:
// construction
Torus(const Vector3& ai, const Vector3& aj, const float ri, const float rj, const float rp);
void computeTorus(const Vector3& ai, const Vector3& aj, const float ri, const float rj, const float rp);
void computeCuspPoints(const float rp);
// queries
const Vector3& getCenter() const ;
const Vector3& getAxis() const ;
float getRadius() const ;
const Vector3& getCusp1() const ;
const Vector3& getCusp2() const ;
bool isSingular() const ;
unsigned int sampleArc(const Vector3& p1, const Vector3& p2, const float delta, const float rp, vector< Vector3>& samplePoints) const;
friend ostream& operator<<(ostream& s, const Torus& t) ;
protected:
Vector3 center;
Vector3 axis;
float radius;
Vector3 cusp1, cusp2;
bool singular;
}; // Torus

Back to the top of Torus

KEYWORD

Back to the top of Torus

AUTHORS

Back to the top of Torus

CHANGES LOG

Back to the top of Torus

GOALS

Back to the top of Torus

USAGE

Back to the top of Torus

Torus(const Vector3& ai, const Vector3& aj, const float ri, const float rj, const float rp);

  Torus(const Vector3& ai, const Vector3& aj, const float ri, const float rj, const float rp);

Back to the top of Torus

void computeTorus(const Vector3& ai, const Vector3& aj, const float ri, const float rj, const float rp);

  void computeTorus(const Vector3& ai, const Vector3& aj, const float ri, const float rj, const float rp);

Back to the top of Torus

void computeCuspPoints(const float rp);

  void computeCuspPoints(const float rp);

Back to the top of Torus

const Vector3& getCenter() const ;

Torus center 

  const Vector3& getCenter() const                   
;

Function is currently defined inline.


Back to the top of Torus

const Vector3& getAxis() const ;

Torus axis: unit vector between two atoms 

  const Vector3& getAxis() const                 
;

Function is currently defined inline.


Back to the top of Torus

float getRadius() const ;

Torus radius 

  float getRadius() const                   
;

Function is currently defined inline.


Back to the top of Torus

const Vector3& getCusp1() const ;

Cusp points in case when torus radius < probe radius 

  const Vector3& getCusp1() const                  
;

Function is currently defined inline.


Back to the top of Torus

const Vector3& getCusp2() const ;

  const Vector3& getCusp2() const                  
;

Function is currently defined inline.


Back to the top of Torus

bool isSingular() const ;

  bool isSingular() const                     
;

Function is currently defined inline.


Back to the top of Torus

unsigned int sampleArc(const Vector3& p1, const Vector3& p2, const float delta, const float rp, vector< Vector3>& samplePoints) const;

  unsigned int sampleArc(const Vector3& p1, const Vector3& p2,
			 const float delta, const float rp, vector< Vector3>& samplePoints) const;

Back to the top of Torus

friend ostream& operator<<(ostream& s, const Torus& t) ;

  friend ostream& operator<<(ostream& s, const Torus& t)                                                                                           
;

Function is currently defined inline.


Back to the top of Torus

Vector3 center;

  Vector3 center;

Back to the top of Torus

Vector3 axis;

  Vector3 axis;

Back to the top of Torus

float radius;

  float radius;

Back to the top of Torus

Vector3 cusp1, cusp2;

  Vector3 cusp1, cusp2;

Back to the top of Torus

bool singular;

  bool singular;

Back to the top of Torus

All Members

public:
// construction
void computeTorus(const Vector3& ai, const Vector3& aj, const float ri, const float rj, const float rp);
void computeCuspPoints(const float rp);
// queries
const Vector3& getCenter() const ;
const Vector3& getAxis() const ;
float getRadius() const ;
const Vector3& getCusp1() const ;
const Vector3& getCusp2() const ;
bool isSingular() const ;
unsigned int sampleArc(const Vector3& p1, const Vector3& p2, const float delta, const float rp, vector< Vector3>& samplePoints) const;
friend ostream& operator<<(ostream& s, const Torus& t) ;
protected:
Vector3 center;
Vector3 axis;
float radius;
Vector3 cusp1, cusp2;
bool singular;

Back to the top of Torus

Ancestors

Class does not inherit from any other class.

Back to the top of Torus

Descendants

Class is not inherited by any others.

Back to the top of Torus

Generated from source by the Cocoon utilities on Mon Dec 21 12:00:25 2009 .

Report problems to jkotula@unimax.com