GEO/GEO_PrimRBezSurf.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Cristin Barghiel
 *      Side Effects Software Inc.
 *      20 Maud St.
 *      Toronto, Ontario,  M5V 2M5
 *      Canada
 *      416-366-4607
 *
 * NAME:        Geometry Library (C++)
 *
 * COMMENTS:
 *      This class implements a piecewise RBezier defined by 
 *      a set of breakpoints, basis functions, and CVs.
 *
 * 
 */

#ifndef __GEO_PrimRBezSurf_h__
#define __GEO_PrimRBezSurf_h__

#include "GEO_API.h"
#include "GEO_TPSurf.h"
#include "GEO_PrimType.h"

class UT_Vector4;

class GEO_API GEO_PrimRBezSurf : public GEO_TPSurf {
public:
    // Constructor that attaches this surface to detail "d". You can optionally
    // specify the number of rows and columns.
    GEO_PrimRBezSurf(GEO_Detail *d, unsigned int m=0, unsigned int n=0)
    : GEO_TPSurf(d, (int)m, (int)n) {}

    // Trivial class destructor, virtual by inheritance. Please read the 
    // comments on the parent class d-tor.
    ~GEO_PrimRBezSurf();

    // Given a domain value (u,v), store all the basis derivatives 
    // (from 0 to du and from 0 to dv inclusive) into ubmatx and vbmatx
    // respectively. Return the min indices of the CVs needed
    // for the linear combination. The indices may exceed the number of
    // vertices if the surface is wrapped, so remember to use modulus (%).
    virtual int         evaluateBasisDerivs(float u, float v,
                                     float ubmatx[][GB_MAXORDER],
                                     float vbmatx[][GB_MAXORDER],
                                     int &rowoffset, int &coloffset,
                                     unsigned du=0, unsigned dv=0,
                                     int uoffset=-1, int voffset=-1) const;

    // Evaluate the basis at the given point in the domain and also return
    // the index of the first CV to linearly combine the basis with. The CV
    // indices may exceed the number of vertices if the surface is wrapped,
    // so remember to use modulus (%).
    virtual int         evaluateBasis(float u, float v, float *ubvals,
                                     float *vbvals, int &rowoffset,
                                     int &coloffset,
                                     unsigned du=0, unsigned dv=0,
                                     int uoffset=-1, int voffset=-1) const;
    virtual int         evaluateUBasis(float u, float *ubvals, int &coloffset,
                                     unsigned du=0, int uoffset=-1) const;
    virtual int         evaluateVBasis(float v, float *vbvals, int &rowoffset,
                                     unsigned dv=0, int voffset=-1) const;

    // Two flavours of a bulk surface evaluator that computes points or
    // derivatives inside a parametric rectangle determined by:
    // a) the u and v values specified in uArr and vArr respectively. The
    // length of the parameter arrays is arrLen.
    // b) uStart, uStop, vStart, and vStop.
    // The functions return  0 if successful, and -1 otherwise.
    virtual int         evaluateMesh(float *uArr, unsigned uArrLen, 
                                     float *vArr, unsigned vArrLen, 
                                     UT_Vector4 *pos,
                                     unsigned du=0, unsigned dv=0) const;
    virtual int         evaluateMesh(float uStart, float uStop, unsigned nu,
                                     float vStart, float vStop, unsigned nv,
                                     UT_Vector4 *pos,
                                     unsigned du=0, unsigned dv=0) const;
    virtual bool        evaluateMesh(float uStart, float uStop, 
                                     unsigned nu, float vStart, float vStop, 
                                     unsigned nv, GEO_Vertex **results,
                                     GEO_AttributeHandleList &hlist,
                                     unsigned du=0, unsigned dv=0) const;
    virtual int         evaluateMeshWAttrib(float uStart, float uStop, 
                                     unsigned nu, float vStart, float vStop, 
                                     unsigned nv, UT_Vector4 *pos,
                                     GB_AttributeData *adata,
                                     const GB_FloatOffsets &foffsets,
                                     unsigned du=0, unsigned dv=0) const;

    // Compute the location of the breakpoint. Return 0 if OK, else -1.
    virtual int         evaluateBreakpoint(int uidx, int vidx,
                                           UT_Vector4 &pos,
                                           int du=0, int dv=0) const;

    // Similar to evaluateMesh(), only it does between breakpoints. 'lod' is
    // the number of points between two breakpoints in u or v. The methods
    // compute the number of spans in v if vspans is -1. The number of isoparms
    // computed in v is returned if OK; else -1. Pass in the bkpoint index of
    // the startidx knot if you know it.
    virtual int         fillBreakMesh(int ustartidx, int ustopidx,
                                    int vstartidx, int vstopidx,
                                    int ulod, int vlod,
                                    UT_Vector4 *pos, int &vspans /* = -1 */,
                                    int vbreakidx = -1,
                                    unsigned du = 0, unsigned dv = 0,
                                    UT_FloatArray *uval = 0,
                                    UT_FloatArray *vval = 0) const;
    virtual int         fillBreakMesh(int ustartidx, int ustopidx,
                                    int vstartidx, int vstopidx,
                                    int ulod, int vlod,
                                    GEO_Vertex **results,
                                    GEO_AttributeHandleList &hlist,
                                    int &vspans /* = -1 */, int vbreakidx = -1,
                                    unsigned du = 0, unsigned dv = 0) const;
    virtual int         fillBreakMeshWAttrib(int ustartidx, int ustopidx,
                                    int vstartidx, int vstopidx,
                                    int ulod, int vlod,
                                    UT_Vector4 *pos, GB_AttributeData *adata,
                                    const GB_FloatOffsets &foffsets,
                                    int &vspans /* = -1 */, int vbreakidx = -1,
                                    unsigned du = 0, unsigned dv = 0) const;

    // Fill pos with isoparametric curves, one curve per breakpoint. It is
    // possible to compute a subpart of each curve by specifying interior
    // knot indices. These methods evaluate across whole spans. They compute
    // the number of spans in the direction of the curve unless given. They
    // will compute the breakpoint index of startidx unless you pass it in.
    // They return the number of spans in the other direction or -1. "lod" 
    // represents the number of points to be evaluated between two breakpoints.
    virtual int         fillUCurves(int ustartidx, int ustopidx,
                                    int vstartidx, int vstopidx, int lod,
                                    UT_Vector4 *pos, int &uspans /* = -1 */,
                                    int ubreakidx = -1,
                                    unsigned du = 0, unsigned dv = 0) const;
    virtual int         fillVCurves(int ustartidx, int ustopidx,
                                    int vstartidx, int vstopidx, int lod,
                                    UT_Vector4 *pos, int &vspans /* = -1 */,
                                    int vbreakidx = -1,
                                    unsigned du = 0, unsigned dv = 0) const;
    virtual int         fillUCurves(int ustartidx, int ustopidx,
                                    int vstartidx, int vstopidx, int lod,
                                    GEO_Vertex **results,
                                    GEO_AttributeHandleList &hlist,
                                    int &uspans /* = -1 */, int ubreakidx = -1,
                                    unsigned du = 0, unsigned dv = 0) const;
    virtual int         fillVCurves(int ustartidx, int ustopidx,
                                    int vstartidx, int vstopidx, int lod,
                                    GEO_Vertex **results,
                                    GEO_AttributeHandleList &hlist,
                                    int &vspans /* = -1 */, int vbreakidx = -1, 
                                    unsigned du = 0, unsigned dv = 0) const;
    virtual int         fillUCurvesWAttrib(int ustartidx, int ustopidx,
                                    int vstartidx, int vstopidx, int lod,
                                    UT_Vector4 *pos, GB_AttributeData *adata,
                                    const GB_FloatOffsets &foffsets,
                                    int &uspans /* = -1 */, int ubreakidx = -1,
                                    unsigned du = 0, unsigned dv = 0) const;
    virtual int         fillVCurvesWAttrib(int ustartidx, int ustopidx,
                                    int vstartidx, int vstopidx, int lod,
                                    UT_Vector4 *pos, GB_AttributeData *adata,
                                    const GB_FloatOffsets &foffsets,
                                    int &vspans /* = -1 */, int vbreakidx = -1, 
                                    unsigned du = 0, unsigned dv = 0) const;

    // Evaluate the surface over the valid parametric interval in both 
    // directions, and place the points in the pos array. 
    // Return 0 if successful, and -1 otherwise.
    virtual int         fillMesh(int nu, int nv, UT_Vector4 *pos) const;

    // Given a CV index figure out the min/max indicies of the knots between
    // which the curve needs to be re-evaluated if the CV changes. If not
    // given a valid CV index, the method returns -1. Otherwise it returns 0.
    virtual int         domainRangeOfCV(int i, int j, int &minuk,int &maxuk,
                                        int &minvk,int &maxvk) const;

    // Given a CV index figure out the min/max breakpoints which are
    // affected if the CV changes.  If not given a valid CV index, the
    // method returns -1.  Otherwise it returns 0.  Also returns -1 if
    // no breakpoints are affected.
    // NOTE: use % breakCount since maxbkp may be >= breakCount
    virtual int         breakpointRangeOfCV(int i, int j, int &minbkpu,
                                            int &maxbkpu, int &minbkpv,
                                            int &maxbkpv) const;

    // Reparameterize the surface by changing its basis. The first breakpoint
    // is not changed.
    virtual void        reparameterizeU(GB_ParmType ptype);
    virtual void        reparameterizeV(GB_ParmType ptype);

    // Insert a breakpoint at the given point in the domain and return its
    // index if successful. Return -1 in case of failure (eg. if outside the
    // valid domain or equal to an existing breakpoint).
    virtual int         refineU(float k, GEO_AttributeHandleList &hlist, int=0);
    virtual int         refineU         (float k, int=0);
    virtual int         refineUWAttrib  (float k,
                                         const GB_FloatOffsets &foffsets,
                                         int = 0);
    virtual int         refineUWAttrib  (float k,
                                         const GB_FloatOffsets *ptoffsets,
                                         const GB_FloatOffsets *vtxoffsets,
                                         int = 0);

    virtual int         refineV(float k, GEO_AttributeHandleList &hlist, int=0);
    virtual int         refineV         (float k, int=0);
    virtual int         refineVWAttrib  (float k,
                                         const GB_FloatOffsets &foffsets,
                                         int = 0);
    virtual int         refineVWAttrib  (float k,
                                         const GB_FloatOffsets *ptoffsets,
                                         const GB_FloatOffsets *vtxoffsets,
                                         int = 0);

    // Notify whomever needs to know that we have changed the weight or the
    // coordinates of cv[r,c].
    virtual int         recordChange(unsigned r, unsigned c);

    // Set the wrap or open flag, and make sure the basis knot vectors are
    // consistent with the change. These functions are virtual by inheritance.
    // TODO-CB: increase the size of the knot vector if necessary.

    // Wrap in the specified U/V direction.
    //
    // If preserveShape = 1:
    //          add extra row/col cvs at the end to define the last span.
    //          if rounded,
    //                  the new cvs just added will be arranged to give a 
    //                  rounded appearance in the specified U/V direction.
    //          else
    //                  the new cvs just added will form a plane
    //                  between the first and last row/col endpoint.
    // If preserveShape = 0:
    //          just grow the U/V basis by one span, without adding any 
    //          new cvs and ignore the rounded flag.
    virtual void        wrapU(int rounded = 1, int preserveShape = 0);
    virtual void        wrapV(int rounded = 1, int preserveShape = 0);

    // Open in the specified U/V direction.
    //
    // If preserveShape = 1:
    //          the open surface will have exactly the same geometry
    //          (ie. still look closed) with the first row/col point 
    //          duplicated.
    // If preserveShape = 0:
    //          the open surface will remove the last span in the basis,
    //          thus open up a gap in the surface.
    //          last few row/col cvs are dangling which do not form a valid
    //          surface patch, if the safe flag = 0.
    // The safe flag is to remove unneed cvs for ensuring the resulting
    // surface is a valid bezier surface.
    virtual void        openU(int preserveShape = 0, int safe = 0);
    virtual void        openV(int preserveShape = 0, int safe = 0);

    // Insert or remove rows and columns. The insertion returns the index if
    // successful. The deletion methods return 0 if ok. If failure, return -1.
    virtual int         insertRow(unsigned int beforeWhich, int appendPts=1);
    virtual int         insertCol(unsigned int beforeWhich, int appendPts=1);
    virtual int         deleteRow(unsigned int which);
    virtual int         deleteCol(unsigned int which);

    // Find the max u and v indices of the bases:
    virtual int         uMaxValidIndex(void) const;
    virtual int         vMaxValidIndex(void) const;

    // Query the primitive type. The function is virtual by inheritance.
    virtual unsigned    getPrimitiveId(void) const;

    // Raise the number of CVs to match the newcount. The shape of the curve
    // (especially if parametric) should NOT change. Return 0 upon success
    // and -1 otherwise.  start and stop define which indices to examine
    // if newcount is negative it is taken as a relative value.
    virtual int         loftU(int newcount, int start=-1, int stop=-1);
    virtual int         loftV(int newcount, int start=-1, int stop=-1);

    // Warp the mesh at u,v by the given delta. Change 1 or 4 Cvs and possibly
    // insert a knot once or more as well. If a knot is inserted or we happen
    // to land exactly on a knot, we change only one CV. The bias makes sense
    // only when changing 4 CVs, and will be ignored altogether if < 0.
    // We return the CV index in warpU/V and 0 in warp() if OK; -1 otherwise.
    virtual int          warpU(float u, const UT_Vector3 &delta,
                               GEO_AttributeHandleList &hlist,
                               float sharpness = 0.0f, float bias = -1.0f);
    virtual int          warpV(float v, const UT_Vector3 &delta,
                               GEO_AttributeHandleList &hlist,
                               float sharpness = 0.0f, float bias = -1.0f);
    virtual int          warp (float u, float v, const UT_Vector3 &delta,
                               GEO_AttributeHandleList &hlist,
                               float usharpness = 0.f, float vsharpness = 0.f,
                               float ubias = -1.0f, float vbias = -1.0f);

    virtual int          warpU(float u, const UT_Vector3 &delta,
                               GB_FloatOffsets *foffsets = 0,
                               float sharpness = 0.0f, float bias = -1.0f);
    virtual int          warpV(float v, const UT_Vector3 &delta,
                               GB_FloatOffsets *foffsets = 0,
                               float sharpness = 0.0f, float bias = -1.0f);
    virtual int          warp (float u, float v, const UT_Vector3 &delta,
                               GB_FloatOffsets *foffsets = 0,
                               float usharpness = 0.f, float vsharpness = 0.f,
                               float ubias = -1.0f, float vbias = -1.0f);

    // Get the bounding box for a specific range of u and v
    virtual void        getRangeBBox(const UT_Interval &u, 
                                        const UT_Interval &v, 
                                        UT_BoundingBox &bbox) const;

    virtual int         unrollU(int append_pts = 1);
    virtual int         unrollV(int append_pts = 1);

    // Reverse rows (V) or columns (U). Reversing in either direction will
    // flip the normal.
    virtual void        reverseU(void);
    virtual void        reverseV(void);


    // Increase the order. Return 0 if successful, -1 otherwise (eg.
    // order cannot be increased because it's >= MAXORDER).
    virtual int         raiseOrderU(int neworder, GEO_AttributeHandleList &hl);
    virtual int         raiseOrderU       (int neworder);
    virtual int         raiseOrderUWAttrib(int neworder,
                                const GB_FloatOffsets &foffsets);
    virtual int         raiseOrderV(int neworder, GEO_AttributeHandleList &hl);
    virtual int         raiseOrderV       (int neworder);
    virtual int         raiseOrderVWAttrib(int neworder,
                                const GB_FloatOffsets &foffsets);
    
    // Translate the CVs such that the given breakpoint change positions by
    // the given delta.  Return -1 if something goes wrong, 0 if translation
    // was successful.
    // NOTE: Cannot contain any duplicates.  If the surface is wrapped,
    //       the first and last breakpoint are considered the same.
    virtual int         translateBreakpoints(const UT_IntArray &uindices,
                                             const UT_IntArray &vindices,
                                             const UT_Vector3 &delta,
                                             int fixbpkts = 1,
                                             GB_PointGroup *ptgroup=NULL,
                                             GEO_Delta *geodelta = 0);

    virtual int         transformBreakpoints(const UT_IntArray &uindices,
                                             const UT_IntArray &vindices,
                                             const UT_Matrix4 &matx,
                                             int fixbpkts = 1,
                                             GB_PointGroup *ptgroup=NULL,
                                             GEO_Delta *geodelta = 0);

    // Append another hull to us in one of two ways: blend the two endpoints
    // or connect them straight or rounded. The bias ranges from 0 to 1 and is
    // relevant only to blending. The tolerance for blending: if 0, the two
    // endpoints will merge into one point with a discontinuity; if less than
    // 1, we insert knots into the hulls to minimize the affected areas; if 1,
    // no refinement is done. For the non-blend case, the tolerance will
    // generate a span whose shape goes from round to straight; 0 tolerance
    // means straight connection. If unrefine is on, we'll try to reduce the
    // complexity of the hull if we're connecting rounded. We return 0 if OK
    // and -1 if error. Both hulls must be open and have the same order.
    virtual int         attachU(const GEO_Hull &hull, int blend = 1,
                                float bias = 0.5f, float tolerance = 1.0f,
                                int = 1, GB_PointGroup *ptgroup=0);
    virtual int         attachV(const GEO_Hull &hull, int blend = 1,
                                float bias = 0.5f, float tolerance = 1.0f,
                                int = 1, GB_PointGroup *ptgroup=0);

    // If [ustart,ustop] and [vstart,vstop] are in the valid interval, return
    // the part of the surface delimited by those values in a new primitive.
    // Return 0 if a problem is encountered.
    virtual GEO_TPSurf  *extract(float ustart, float ustop,
                                 float vstart, float vstop) const;

    // Reverse the roles of rows and columns
    virtual void        transpose();


protected:
    // Get a new basis of a type that matches our type:
    virtual GB_Basis    *newBasis(void) const;

    // These methods are meant to be used with fillU/VCurves. For the "U"
    // mehtods: given a const knot index in v and two bounds in u, fill
    // a complete (or just a portion of) the isocurve through v. Return 0 if
    // successful or -1. These methods aren't VIRTUAL.
    // If you ever plan to make them public, make sure you resize the aDeriv
    // in the WAttrib methods _before_ you call them.
    int                 fillUCurve(int vidx, int ustartidx,int ustopidx,
                                   int density, UT_Vector4 *pos, int puoffset,
                                   int rbound, unsigned du, unsigned dv) const;
    int                 fillVCurve(int uidx, int vstartidx,int vstopidx,
                                   int density, UT_Vector4 *pos, int pvoffset,
                                   int rbound, unsigned du, unsigned dv) const;
    int                 fillUCurve(int vidx, int ustartidx,
                                   int ustopidx, int density,
                                   GEO_Vertex **results,
                                   GEO_AttributeHandleList &hlist,
                                   int puoffset, int rbound,
                                   unsigned du, unsigned dv) const;
    int                 fillVCurve(int uidx, int vstartidx,
                                   int vstopidx, int density,
                                   GEO_Vertex **results,
                                   GEO_AttributeHandleList &hlist,
                                   int pvoffset, int rbound,
                                   unsigned du, unsigned dv) const;
    int                 fillUCurveWAttrib(int vidx, int ustartidx,
                                   int ustopidx, int density, UT_Vector4 *pos,
                                   GB_AttributeData *adata,
                                   const GB_FloatOffsets &foffsets,
                                   int asize, int puoffset, int rbound,
                                   unsigned du, unsigned dv) const;
    int                 fillVCurveWAttrib(int uidx, int vstartidx,
                                   int vstopidx, int density, UT_Vector4 *pos,
                                   GB_AttributeData *adata,
                                   const GB_FloatOffsets &foffsets,
                                   int asize,  int pvoffset, int rbound,
                                   unsigned du, unsigned dv) const;

    // increase order by 1.
    void                incrementOrderU(void);
    void                incrementOrderU(GEO_AttributeHandleList &hlist);
    void                incrementOrderUWAttrib(const GB_FloatOffsets &foffsets);

    void                incrementOrderV(void);
    void                incrementOrderV(GEO_AttributeHandleList &hlist);
    void                incrementOrderVWAttrib(const GB_FloatOffsets &foffsets);

private:
    // Nothing.
};
#endif

---