pfCylinderSurface(3pf) OpenGL Performer 3.2.2 libpf C Reference Pages
NAME
pfGetCylinderSurfaceClassType, pfNewCylinderSurface,
pfCylinderSurfaceRadius, pfGetCylinderSurfaceRadius,
pfCylinderSurfaceEvalPt, pfCylinderSurfaceEvalNorm - A parametric
cylinder
FUNCTION SPECIFICATION
#include <Performer/pf.h>
pfType * pfGetCylinderSurfaceClassType(void);
pfCylinderSurface* pfNewCylinderSurface(void *arena);
void pfCylinderSurfaceRadius(pfCylinderSurface *sphere,
pfReal radiusVal);
pfReal -
pfGetCylinderSurfaceRadius(pfCylinderSurface *sphere);
void pfCylinderSurfaceEvalPt(pfCylinderSurface *sphere,
pfReal u, pfReal v, pfVec3 pnt);
void pfCylinderSurfaceEvalNorm(pfCylinderSurface *sphere,
pfReal u, pfReal v, pfVec3 norm);
PARENT CLASS FUNCTIONS
The OpenGL Performer class pfCylinderSurface is derived from the parent
class pfParaSurface, so each of these member functions of class
pfParaSurface are also directly usable with objects of class
pfCylinderSurface. Casting an object of class pfCylinderSurface to an
object of class pfParaSurface is taken care of automatically. This is
also true for casts to objects of ancestor classes of class
pfParaSurface.
void pfParaSurfaceBeginU(pfParaSurface* surf, pfReal u);
void pfParaSurfaceEndU(pfParaSurface* surf, pfReal u);
void pfParaSurfaceBeginV(pfParaSurface* surf, pfReal v);
void pfParaSurfaceEndV(pfParaSurface* surf, pfReal v);
void pfParaSurfaceSolidId(pfParaSurface* surf, int solidId);
void pfParaSurfaceTopoId(pfParaSurface* surf, int topoId);
void pfParaSurfaceSurfaceId(pfParaSurface* surf, int surfaceId);
pfReal pfGetParaSurfaceBeginU(pfParaSurface* surf);
pfReal pfGetParaSurfaceEndU(pfParaSurface* surf);
pfReal pfGetParaSurfaceBeginV(pfParaSurface* surf);
pfReal pfGetParaSurfaceEndV(pfParaSurface* surf);
int pfGetParaSurfaceTrimLoopCount(pfParaSurface* surf);
pfLoop pfGetParaSurfaceTrimLoopClosed(pfParaSurface* surf,
int loopNum);
int pfGetParaSurfaceTrimCurveCount(pfParaSurface* surf,
int loopNum);
Page 1
pfCylinderSurface(3pf) OpenGL Performer 3.2.2 libpf C Reference Pages
pfEdge* pfGetParaSurfaceTrimCurve(pfParaSurface* surf, int loopNum,
int curveNum);
pfTopo* pfGetParaSurfaceTopo(pfParaSurface* surf);
int pfGetParaSurfaceTopoId(pfParaSurface* surf);
int pfGetParaSurfaceSolidId(pfParaSurface* surf);
int pfGetParaSurfaceSurfaceId(pfParaSurface* surf);
void pfParaSurfaceHandednessHint(pfParaSurface* surf,
pfBool _clockWise);
pfBool pfGetParaSurfaceHandednessHint(pfParaSurface* surf);
void pfParaSurfaceInsertTrimCurve(pfParaSurface* surf,
int loopNum, pfCurve2d *c, pfDisCurve2d *d);
void pfParaSurfaceAddTrimCurve(pfParaSurface* surf, int loopNum,
pfCurve2d *c, pfDisCurve2d *d);
void pfParaSurfaceTrimLoopClosed(pfParaSurface* surf,
int loopNum, pfLoop closed);
void pfParaSurfaceEvalPt(pfParaSurface* surf, pfReal u,
pfReal v, pfVec3 pnt);
void pfParaSurfaceEvalDu(pfParaSurface* surf, pfReal u,
pfReal v, pfVec3 Du);
void pfParaSurfaceEvalDv(pfParaSurface* surf, pfReal u,
pfReal v, pfVec3 Dv);
void pfParaSurfaceEvalDuu(pfParaSurface* surf, pfReal u,
pfReal v, pfVec3 Duu);
void pfParaSurfaceEvalDvv(pfParaSurface* surf, pfReal u,
pfReal v, pfVec3 Dvv);
void pfParaSurfaceEvalDuv(pfParaSurface* surf, pfReal u,
pfReal v, pfVec3 Duv);
void pfParaSurfaceEvalNorm(pfParaSurface* surf, pfReal u,
pfReal v, pfVec3 norm);
void pfParaSurfaceEvalD(pfParaSurface* surf, pfReal u, pfReal v,
pfReal theta, pfVec3 D);
void pfParaSurfaceEvalDD(pfParaSurface* surf, pfReal u,
pfReal v, pfReal theta, pfVec3 DD);
int pfParaSurfaceGState(pfParaSurface* surf,
pfGeoState *gState);
pfGeoState* pfGetParaSurfaceGState(pfParaSurface* surf);
void pfParaSurfaceClearTessellation(pfParaSurface* surf);
Since the class pfParaSurface is itself derived from the parent class
pfGeode, objects of class pfCylinderSurface can also be used with these
functions designed for objects of class pfGeode.
void pfRepOrigin(pfRep *rep, const pfVec3 origin);
void pfRepOrient(pfRep *rep, const pfMatrix mat);
void pfGetRepOrigin(pfRep *rep, pfVec3* origin);
void pfGetRepOrient(pfRep *rep, pfMatrix *mat);
Since the class pfGeode is itself derived from the parent class pfGeode,
objects of class pfCylinderSurface can also be used with these functions
designed for objects of class pfGeode.
Page 2
pfCylinderSurface(3pf) OpenGL Performer 3.2.2 libpf C Reference Pages
int pfAddGSet(pfGeode* geode, pfGeoSet* gset);
int pfRemoveGSet(pfGeode* geode, pfGeoSet* gset);
int pfInsertGSet(pfGeode* geode, int index, pfGeoSet* gset);
int pfReplaceGSet(pfGeode* geode, pfGeoSet* old, pfGeoSet* new);
pfGeoSet * pfGetGSet(const pfGeode* geode, int index);
int pfGetNumGSets(const pfGeode* geode);
Since the class pfGeode is itself derived from the parent class pfNode,
objects of class pfCylinderSurface can also be used with these functions
designed for objects of class pfNode.
pfGroup * pfGetParent(const pfNode *node, int i);
int pfGetNumParents(const pfNode *node);
void pfNodeBSphere(pfNode *node, pfSphere *bsph, int mode);
int pfGetNodeBSphere(pfNode *node, pfSphere *bsph);
pfNode* pfClone(pfNode *node, int mode);
pfNode* pfBufferClone(pfNode *node, int mode, pfBuffer *buf);
int pfFlatten(pfNode *node, int mode);
int pfNodeName(pfNode *node, const char *name);
const char * pfGetNodeName(const pfNode *node);
pfNode* pfFindNode(pfNode *node, const char *pathName,
pfType *type);
pfNode* pfLookupNode(const char *name, pfType* type);
int pfNodeIsectSegs(pfNode *node, pfSegSet *segSet,
pfHit **hits[]);
void pfNodeTravMask(pfNode *node, int which, uint mask,
int setMode, int bitOp);
uint pfGetNodeTravMask(const pfNode *node, int which);
void pfNodeTravFuncs(pfNode* node, int which,
pfNodeTravFuncType pre, pfNodeTravFuncType post);
void pfGetNodeTravFuncs(const pfNode* node, int which,
pfNodeTravFuncType *pre, pfNodeTravFuncType *post);
void pfNodeTravData(pfNode *node, int which, void *data);
void * pfGetNodeTravData(const pfNode *node, int which);
void pfNodeTravMode(pfNode* node, int which, int mode,
int val);
int pfGetNodeTravMode(const pfNode* node, int which,
int mode);
Since the class pfNode is itself derived from the parent class pfObject,
objects of class pfCylinderSurface can also be used with these functions
designed for objects of class pfObject.
void pfUserDataSlot(pfObject *obj, int slot, void *data);
void pfUserData(pfObject *obj, void *data);
void* pfGetUserDataSlot(pfObject *obj, int slot);
void* pfGetUserData(pfObject *obj);
int pfGetNumUserData(pfObject *obj);
Page 3
pfCylinderSurface(3pf) OpenGL Performer 3.2.2 libpf C Reference Pages
int pfGetNamedUserDataSlot(const char *name);
const char* pfGetUserDataSlotName(int slot);
int pfGetNumNamedUserDataSlots(void);
int pfDeleteGLHandle(pfObject *obj);
Since the class pfObject is itself derived from the parent class
pfMemory, objects of class pfCylinderSurface can also be used with these
functions designed for objects of class pfMemory.
pfType * pfGetType(const void *ptr);
int pfIsOfType(const void *ptr, pfType *type);
int pfIsExactType(const void *ptr, pfType *type);
const char * pfGetTypeName(const void *ptr);
int pfRef(void *ptr);
int pfUnref(void *ptr);
int pfUnrefDelete(void *ptr);
int pfUnrefGetRef(void *ptr);
int pfGetRef(const void *ptr);
int pfCopy(void *dst, void *src);
int pfDelete(void *ptr);
int pfIsFluxed(void *ptr);
int pfCompare(const void *ptr1, const void *ptr2);
void pfPrint(const void *ptr, uint which, uint verbose,
FILE *file);
void * pfGetArena(void *ptr);
DESCRIPTION
A cylinder is a parametric surface defined by taking a circle in the x/y
plane and sweeping it a fixed distance along the z-axis in the positive
and negative directions. The radius of the circle defines the radius of
the cylinder. The sweeping distance is referred to as the half height of
the cylinder. Since the cylinder is centered at the origin, the total
height twice the sweeping distance.
The surface is defined as:
x(u,v) = radius * cos(u)
y(u,v) = radius * sin(u)
z(u,v) = v
The u parameter is mapped radially about the cylinder and has a domain of
0 to 2*PI. The v parameter is mapped to the height (from -height/2 to
height/2). To obtain an arbitrarily oriented cylinder, use the pfRep
orientation matrix.
pfGetCylinderSurfaceClassType returns the pfType* for the class
pfCylinderSurface. The pfType* returned by pfGetCylinderSurfaceClassType
is the same as the pfType* returned by invoking pfGetType on any instance
of class pfCylinderSurface. 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 pfIsOfType to test if an object is of
Page 4
pfCylinderSurface(3pf) OpenGL Performer 3.2.2 libpf C Reference Pages
a type derived from a Performer type rather than to test for strict
equality of the pfType*'s.
pfNewCylinderSurface creates an instance of pfCylinderSurface with radius
set to radius and a length specified by height. The default value for the
height is 2 and 1 for the radius.
pfCylinderSurfaceRadius sets the cylinder's radius.
pfCylinderSurfaceHeight sets the cylinder's length.
pfGetCylinderSurfaceRadius returns the cylinder's radius.
pfGetCylinderSurfaceHeight returns the cylinder's height.
pfCylinderSurfaceEvalPt evaluates the surface value of the cylinder at
parametric values u and v and stores the result in pnt. The value of u is
assumed to be in radians with a domain of 0 to 2*PI. Values outside of
this domain may produce undefined results.
pfCylinderSurfaceEvalNorm evaluates the normal of the cylinder at
parametric values u and v stores the result in norm. The value of u is
assumed to be assumed to be in radians with a domain of 0 to 2*PI. Values
outside this domain may produce undefined results.
The normal is defined as the right hand rule cross product of
<du/dx,du/dy,du/dz> and <dv/dx,dv/dy,dv/dz>.
SEE ALSO
pfRep, pfGeode, pfParaSurface
Page 5
