VRS::Knot Class Reference

Torus knot. More...

#include <vrs/knot.h>

Inheritance diagram for VRS::Knot:

List of all members.

Public Member Functions
	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)
void	setCenter (const Vector &)
Vector	getCenter () const
	Specifies the center of the torus knot.
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
	Bounding Box of the knot.
	VRS_TYPEINFO (Knot, Shape)
	VRS_SERIALIZABLE (Knot)

---

Detailed Description

Torus knot.

---

Constructor & Destructor Documentation

VRS::Knot::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
	)

---

Member Function Documentation

void VRS::Knot::setCenter

(

const Vector &

)

Vector VRS::Knot::getCenter

(

)

const [inline]

Specifies the center of the torus knot.

void VRS::Knot::setInnerRad

(

double

)

void VRS::Knot::setRotRad

(

double

)

void VRS::Knot::setThickness

(

double

)

double VRS::Knot::getInnerRad

(

)

const [inline]

double VRS::Knot::getRotRad

(

)

const [inline]

double VRS::Knot::getThickness

(

)

const [inline]

innerRad defines how far the center of the rotation curve is away from the center, RotRad defines the radius of the ring, and thickness is the value that defines how thick the knot is.

void VRS::Knot::setPhi	(	double	minphi,
		double	maxphi
	)

double VRS::Knot::getPhiMin

(

)

const [inline]

double VRS::Knot::getPhiMax

(

)

const [inline]

phiMin and phiMax defining the start and end angle of the knotcreating process usually PhiMax is set to 720, so that the knot is closed for n=3 (trefoil knot) phiMin must be smaller than phiMax

void VRS::Knot::setTheta

(

double

)

double VRS::Knot::getTheta

(

)

const [inline]

Theta defines the circle segment that is used for making the knot. its usually set to 360 degrees. greater values are not useful but lower ones are possible.

void VRS::Knot::setP

(

double

)

void VRS::Knot::setQ

(

double

)

double VRS::Knot::getP

(

)

const [inline]

double VRS::Knot::getQ

(

)

const [inline]

p,q difining the type of the knot.

virtual Bounds VRS::Knot::boundingBox

(

)

const [virtual]

Bounding Box of the knot.

Implements VRS::Shape.

VRS::Knot::VRS_TYPEINFO	(	Knot	,
		Shape
	)

VRS::Knot::VRS_SERIALIZABLE

(

Knot

)

---

The documentation for this class was generated from the following file:

• knot.h