pfPlaneSurface(3pf) OpenGL Performer 3.2.2 libpf C Reference Pages
NAME
pfGetPlaneSurfaceClassType, pfNewPlaneSurface, pfPlaneSurfacePoint1,
pfGetPlaneSurfacePoint1, pfPlaneSurfacePoint2, pfGetPlaneSurfacePoint2,
pfPlaneSurfacePoint3, pfGetPlaneSurfacePoint3, pfPlaneSurfaceEvalPt,
pfPlaneSurfaceEvalDu, pfPlaneSurfaceEvalDv, pfPlaneSurfaceEvalNorm - A
parametric plane.
FUNCTION SPECIFICATION
#include <Performer/pf.h>
pfType * pfGetPlaneSurfaceClassType(void);
pfPlaneSurface* pfNewPlaneSurface(void *arena);
void pfPlaneSurfacePoint1(pfPlaneSurface *plane, pfReal x1,
pfReal y1, pfReal z1, pfReal u1, pfReal v1);
void pfGetPlaneSurfacePoint1(pfPlaneSurface *plane,
pfReal *x1, pfReal *x2, pfReal *u1, pfReal *v1);
void pfPlaneSurfacePoint2(pfPlaneSurface *plane, pfReal x2,
pfReal y2, pfReal z2, pfReal u2);
void pfGetPlaneSurfacePoint2(pfPlaneSurface *plane,
pfReal *x2, pfReal *y2, pfReal *z2, pfReal *u2);
void pfPlaneSurfacePoint3(pfPlaneSurface *plane, pfReal x3,
pfReal y3, pfReal z3, pfReal v3);
void pfGetPlaneSurfacePoint3(pfPlaneSurface *plane,
pfReal *x3, pfReal *y3, pfReal *z3, pfReal *v3);
void pfPlaneSurfaceEvalPt(pfPlaneSurface *plane, pfReal u,
pfReal v, pfVec3 pnt);
void pfPlaneSurfaceEvalDu(pfPlaneSurface *plane, pfReal u,
pfReal v, pfReal Du);
void pfPlaneSurfaceEvalDv(pfPlaneSurface *plane, pfReal u,
pfReal v, pfReal Du);
void pfPlaneSurfaceEvalNorm(pfPlaneSurface *plane, pfReal u,
pfReal v, pfVec3 norm);
PARENT CLASS FUNCTIONS
The OpenGL Performer class pfPlaneSurface is derived from the parent
class pfParaSurface, so each of these member functions of class
pfParaSurface are also directly usable with objects of class
pfPlaneSurface. Casting an object of class pfPlaneSurface 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.
Page 1
pfPlaneSurface(3pf) OpenGL Performer 3.2.2 libpf C Reference Pages
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);
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);
Page 2
pfPlaneSurface(3pf) OpenGL Performer 3.2.2 libpf C Reference Pages
pfGeoState* pfGetParaSurfaceGState(pfParaSurface* surf);
void pfParaSurfaceClearTessellation(pfParaSurface* surf);
Since the class pfParaSurface is itself derived from the parent class
pfGeode, objects of class pfPlaneSurface 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 pfPlaneSurface can also be used with these functions
designed for objects of class pfGeode.
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 pfPlaneSurface 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);
Page 3
pfPlaneSurface(3pf) OpenGL Performer 3.2.2 libpf C Reference Pages
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 pfPlaneSurface 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);
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 pfPlaneSurface 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 plane is a special type of parametric surface and is represented as a
mapping from UV to XYZ space. The parameterization is defined as follows.
A plane is defined by 3 points (which are not colinear) A, B, C
(corresponding to members pu, orig, and pv, respectively). If we denote
vector BA = A-B and vector BC = C-B, then any point on the plane can be
represented as B + u * BA + v * BC for some (u,v). In addition, we
reparameterize (u,v) by translation and scaling. More precisely, given a
Page 4
pfPlaneSurface(3pf) OpenGL Performer 3.2.2 libpf C Reference Pages
(u,v), the point on the plane is defined as B + ((u-uBias)/uScale) * BA +
((v-vBias)/vScale) * BC.
In addition to the three points and the translation and scaling
information, the class also caches the directions
uDirection = pu - orig;
vDirection = pv - orig;
and the normal norm.
pfGetPlaneSurfaceClassType returns the pfType* for the class
pfPlaneSurface. The pfType* returned by pfGetPlaneSurfaceClassType is
the same as the pfType* returned by invoking pfGetType on any instance of
class pfPlaneSurface. 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 a type
derived from a Performer type rather than to test for strict equality of
the pfType*'s.
pfNewPlaneSurface creates an instance of pfPlaneSurface with orig set to
(0,0,0), pu set to (1,0,0), pv set to (0,1,0), uScale set to 1, vScale
set to 1, uBias set to 0, vBias set to 0. uDirection and vDirection are
computed accordingly.
The domain [beginU,endU]X[beginV,endV], which are inherited members from
pfParaSurface, is set to [0, 1] X [0, 1].
pfPlaneSurfacePoint1 sets orig to be (x1, y1, z1). Sets uBias to u1 and
vBias to v1. All the other members are updated as in the constructor.
pfPlaneSurfaceacePoint2 sets pu to be (x2, y2, z2). Sets uScale to be u2
- uBias. All the other members are updated as in the constructor.
pfPlaneSurfaceacePoint3 sets pv to be (x3, y3, z3). Sets vScale to be v3
- vBias. All the other members are updated as in the constructor.
pfGetPlaneSurfacePoint1 sets (x1, y1, z1) to be orig. Sets u1 to be uBias
and v1 to be vBias.
pfGetPlaneSurfacePoint2 sets (x2, y2, z2) to be pu. Sets u2 to be uBias +
uScale.
pfGetPlaneSurfacePoint3 sets (x3, y3, z3) to be pv. Sets v3 to be vBias +
vScale.
SEE ALSO
pfRep, pfGeode, pfParaSurface
Page 5
