GB/GB_Breakpoint.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:        GB_Breakpoint (C++)
 *
 * COMMENTS:
 *      Breakpoint.
 *
 */

#ifndef __GB_Breakpoint_h__
#define __GB_Breakpoint_h__

#include "GB_API.h"
#include <iostream.h>
#include <UT/UT_LinkList.h>

#include "GB_Primitive.h"

class GB_Basis;

typedef int (*iterateFuncPtr)(void *data, GB_Element *ppt);
typedef int (*iterateVertexFuncPtr)(void *data, GB_Vertex &vtx,
                                    int linear_index);

class GB_API GB_Breakpoint : public UT_LinkNode
{
protected:
    // GB_Breakpoint is a an abstract base class, but we may as well be
    // explicit and make the constructors protected.
    GB_Breakpoint(GB_Primitive *prim = 0, int uidx = -1, int vidx = -1)
    {
        mySpline = prim;
        myUidx   = uidx;
        myVidx   = vidx;
    }
    GB_Breakpoint(const GB_Breakpoint &b)
        : UT_LinkNode(b)
    {
        mySpline = b.mySpline;
        myUidx   = b.myUidx;
        myVidx   = b.myVidx;
    }

    // We also don't want a default public assignment operator.
    GB_Breakpoint       &operator=(const GB_Breakpoint &b)
                         {
                             mySpline   = b.mySpline;
                             myUidx     = b.myUidx;
                             myVidx     = b.myVidx;

                             return *this;
                         }

public:
    virtual ~GB_Breakpoint(void);

    bool                 operator==(const GB_Breakpoint &b)
                         {
                             return (this == &b ||
                                     mySpline == b.mySpline     &&
                                     myUidx   == b.myUidx       &&
                                     myVidx   == b.myVidx        );
                         }

    int                  isPrimary() const { return (mySpline ? 
                                                     mySpline->isPrimary() : 
                                                     0); }

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

    // This method performs the iterateFunc on all the CVs affecting this
    // breakpoint and returns the sum of the results.
    virtual int          iterateOverCVs(void * /*data*/, iterateFuncPtr/*func*/)
                             = 0;
    virtual int          iterateOverCVs(void * /*data*/,
                                        iterateVertexFuncPtr/*func*/) = 0;

    // These methods return the knot indices corresponding to the breakpoint,
    // or the parameter values at these knot indices.  Pointers to the bases
    // are returned in ubasis_ret and vbasis_ret, if these arguments are not
    // nil.
    virtual void         getKnotIndices(int &/*ukidx*/, int &/*vkidx*/, 
                                        GB_Basis ** /*ubasis_ret=0*/, 
                                        GB_Basis ** /*vbasis_ret=0*/) const = 0;
    virtual void         getParameter(fpreal &/*u*/, fpreal &/*v*/) const = 0;
    

    // Data Access Methods
    int          u()      const { return myUidx; }
    int         &u()            { return myUidx; }
    int          v()      const { return myVidx; }
    int         &v()            { return myVidx; }
    const GB_Primitive  *spline() const { return mySpline; }
          GB_Primitive *&spline()       { return mySpline; } 

    
    // I/O methods, returning 0 if OK and -1 otherwise:
    int                  save(ostream &os, int binary) const;
    bool                 load(UT_IStream &is, const GB_Detail &gdp);

protected:

    // The data:
    GB_Primitive        *mySpline;
    int                  myUidx, myVidx;
};

#endif

---