pfTorusSurface(3pf) OpenGL Performer 3.2.2 libpf C++ Reference Pages
NAMEpfTorusSurface - A parametric torus
FUNCTION SPECIFICATION
#include <Performer/pf/pfTorusSurface.h>
static pfType * pfTorusSurface::getClassType(void);
pfTorusSurface::pfTorusSurface();
pfTorusSurface::pfTorusSurface(pfReal minorRadius,
pfReal majorRadius);
void pfTorusSurface::setMajorRadius(pfReal majorRadiusVal);
void pfTorusSurface::setMinorRadius(pfReal minorRadiusVal);
pfReal pfTorusSurface::getMajorRadius();
pfReal pfTorusSurface::getMinorRadius();
void pfTorusSurface::evalPt(pfReal u, pfReal v,
pfVec3& pnt);
void pfTorusSurface::evalNorm(pfReal u, pfReal v,
pfVec3& norm);
PARENT CLASS FUNCTIONS
The OpenGL Performer class pfTorusSurface is derived from the parent
class pfParaSurface, so each of these member functions of class
pfParaSurface are also directly usable with objects of class
pfTorusSurface. This is also true for ancestor classes of class
pfParaSurface.
void pfParaSurface::setBeginU(pfReal u);
void pfParaSurface::setEndU(pfReal u);
void pfParaSurface::setBeginV(pfReal v);
void pfParaSurface::setEndV(pfReal v);
void pfParaSurface::setSolidId(int solidId);
void pfParaSurface::setTopoId(int topoId);
void pfParaSurface::setSurfaceId(int surfaceId);
pfReal pfParaSurface::getBeginU(pfParaSurface* surf);
pfReal pfParaSurface::getEndU(pfParaSurface* surf);
pfReal pfParaSurface::getBeginV(pfParaSurface* surf);
pfReal pfParaSurface::getEndV(pfParaSurface* surf);
int pfParaSurface::getTrimLoopCount(pfParaSurface* surf);
pfLoop pfParaSurface::getTrimLoopClosed(int loopNum);
int pfParaSurface::getTrimCurveCount(int loopNum);
pfEdge* pfParaSurface::getTrimCurve(int loopNum, int curveNum);
pfTopo* pfParaSurface::getTopo();
Page 1
pfTorusSurface(3pf) OpenGL Performer 3.2.2 libpf C++ Reference Pages
int pfParaSurface::getTopoId();
int pfParaSurface::getSolidId();
int pfParaSurface::getSurfaceId();
void pfParaSurface::getHandednessHint(pfBool _clockWise);
pfBool pfParaSurface::getHandednessHint();
void pfParaSurface::insertTrimCurve(int loopNum, pfCurve2d *c,
pfDisCurve2d *d);
void pfParaSurface::addTrimCurve(int loopNum, pfCurve2d *c,
pfDisCurve2d *d);
void pfParaSurface::setTrimLoopClosed(int loopNum,
pfLoop closed);
void pfParaSurface::evalPt(pfReal u, pfReal v, pfVec3& pnt);
void pfParaSurface::evalDu(pfReal u, pfReal v, pfVec3& Du);
void pfParaSurface::evalDv(pfReal u, pfReal v, pfVec3& Dv);
void pfParaSurface::evalDuu(pfReal u, pfReal v, pfVec3& Duu);
void pfParaSurface::evalDvv(pfReal u, pfReal v, pfVec3& Dvv);
void pfParaSurface::evalDuv(pfReal u, pfReal v, pfVec3& Duv);
void pfParaSurface::evalNorm(pfReal u, pfReal v, pfVec3& norm);
void pfParaSurface::evalD(pfReal u, pfReal v, pfReal theta,
pfVec3& D);
void pfParaSurface::evalDD(pfReal u, pfReal v, pfReal theta,
pfVec3& DD);
int pfParaSurface::setGState(pfGeoState *gState);
pfGeoState* pfParaSurface::getGState();
void pfParaSurface::clearTessellation();
Since the class pfParaSurface is itself derived from the parent class
pfGeode, objects of class pfTorusSurface can also be used with these
functions designed for objects of class pfGeode.
void pfRep::setOrigin(const pfVec3 *origin);
void pfRep::setOrient(const pfMatrix *mat);
void pfRep::getOrigin(pfVec3& origin);
void pfRep::getOrient(pfMatrix& matrix);
Since the class pfGeode is itself derived from the parent class pfGeode,
objects of class pfTorusSurface can also be used with these functions
designed for objects of class pfGeode.
int pfGeode::addGSet(pfGeoSet* gset);
int pfGeode::removeGSet(pfGeoSet* gset);
int pfGeode::insertGSet(int index, pfGeoSet* gset);
int pfGeode::replaceGSet(pfGeoSet* old, pfGeoSet* new);
pfGeoSet * pfGeode::getGSet(int index);
int pfGeode::getNumGSets(void);
Since the class pfGeode is itself derived from the parent class pfNode,
objects of class pfTorusSurface can also be used with these functions
designed for objects of class pfNode.
Page 2
pfTorusSurface(3pf) OpenGL Performer 3.2.2 libpf C++ Reference Pages
pfGroup * pfNode::getParent(int i);
int pfNode::getNumParents(void);
void pfNode::setBound(pfSphere *bsph, int mode);
int pfNode::getBound(pfSphere *bsph);
pfNode* pfNode::clone(int mode);
pfNode* pfNode::bufferClone(int mode, pfBuffer *buf);
int pfNode::flatten(int mode);
int pfNode::setName(const char *name);
const char * pfNode::getName(void);
pfNode* pfNode::find(const char *pathName, pfType *type);
pfNode* pfNode::lookup(const char *name, pfType* type);
int pfNode::isect(pfSegSet *segSet, pfHit **hits[]);
void pfNode::setTravMask(int which, uint mask, int setMode,
int bitOp);
uint pfNode::getTravMask(int which);
void pfNode::setTravFuncs(int which, pfNodeTravFuncType pre,
pfNodeTravFuncType post);
void pfNode::getTravFuncs(int which, pfNodeTravFuncType *pre,
pfNodeTravFuncType *post);
void pfNode::setTravData(int which, void *data);
void * pfNode::getTravData(int which);
void pfNode::setTravMode(int which, int mode, int val);
int pfNode::getTravMode(int which, int mode) const;
Since the class pfNode is itself derived from the parent class pfObject,
objects of class pfTorusSurface can also be used with these functions
designed for objects of class pfObject.
void* pfObject::operator new(size_t);
void* pfObject::operator new(size_t, pfFluxMemory *fmem);
void pfObject::setUserData(void *data);
void pfObject::setUserData(int slot, void *data);
void* pfObject::getUserData(pfObject *obj);
void* pfObject::getUserData(pfObject *obj, int slot);
int pfObject::getNumUserData();
Since the class pfObject is itself derived from the parent class
pfMemory, objects of class pfTorusSurface can also be used with these
functions designed for objects of class pfMemory.
void* pfMemory::getData(const void *ptr);
pfType * pfMemory::getType();
int pfMemory::isOfType(pfType *type);
int pfMemory::isExactType(pfType *type);
const char * pfMemory::getTypeName();
int pfMemory::copy(pfMemory *src);
int pfMemory::compare(const pfMemory *mem);
void pfMemory::print(uint which, uint verbose, char *prefix,
FILE *file);
Page 3
pfTorusSurface(3pf) OpenGL Performer 3.2.2 libpf C++ Reference Pages
int pfMemory::getArena(void *ptr);
void* pfMemory::getArena();
int pfMemory::ref();
int pfMemory::unref();
int pfMemory::unrefDelete();
int pfMemory::unrefGetRef();
int pfMemory::getRef();
int pfMemory::checkDelete();
int pfMemory::isFluxed();
void * pfMemory::getArena();
int pfMemory::getSize();
DESCRIPTION
A torus is a parametric surface defined by taking a circle in the x/z
plane and sweeping it circularly, a fixed distance away from and about
the z-axis. The radius of the circle is called the minor radius. The
fixed distance about the z-axis is called the major radius.
The surface is defined as:
x(u,v) = (majorRadius + minorRadius*cos(v))*cos(u)
y(u,v) = (majorRadius + minorRadius*cos(v))*sin(u)
z(u,v) = minorRadius*sin(v)
The "u" parameter maps to the longitudinal or the sweeping direction. The
"v" parameter maps to the cross sectional circle. Both are given in
radians from 0 to 2*Pi, with 0 for "u" and "v" aligning with the x-axis.
To obtain an arbitrarily oriented torus, set the orientation matrix by
using the appropriate superclass, pfRep, member function.
pfTorusSurface::getClassType returns the pfType* for the class
pfTorusSurface. The pfType* returned by pfTorusSurface::getClassType is
the same as the pfType* returned by invoking the virtual function getType
on any instance of class pfTorusSurface. Because OpenGL Performer allows
subclassing of built-in types, when decisions are made based on the type
of an object, it is usually better to use the member function isOfType
to test if an object is of a type derived from a Performer type rather
than to test for strict equality of the pfType*'s.
pfTorusSurface::pfTorusSurface creates an instance of pfTorusSurface with
a cross sectional radius of 1.0 and a ring radius of 2.0.
pfTorusSurface::pfTorusSurface(pfReal majorRadius,pfReal minorRadius)
creates an instance of a pfTorusSurface with a cross sectional radius of
minorRadius and a ring radius of majorRadius
pfTorus::setMajorRadius sets the major radius.
pfTorus::setMinorRadius sets the minor radius.
pfTorus::getMajorRadius returns the current major radius.
Page 4
pfTorusSurface(3pf) OpenGL Performer 3.2.2 libpf C++ Reference Pages
pfTorus::getMinorRadius returns the current minor radius.
pfTorusSurface::evalPt evaluates the surface value of the torus at
parametric values u and v and stores the result pnt. Values of u and v
are assumed to be in the domain [0..2*pi]x[0..2*pi]. Values outside this
domain may produce undefined results.
pfTorusSurface::evalNorm evaluates the normal value of the torus at
parametric values u and v and stores the result pnt. Values of u and v
are assumed to be in the domain [0..2*pi]x[0..2*pi]. Values outside this
domain may produce undefined results.
SEE ALSO
pfRep, pfGeode, pfParaSurface
Page 5
