GEO_Greville.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.
 *
 * NAME:        Geometry Library (C++)
 *
 * COMMENTS:
 *      This class implements a Greville abscissa, which is an average
 *      of "order" knots in parametric space.
 *
 */

#ifndef __GEO_Greville_h__
#define __GEO_Greville_h__

#include "GEO_API.h"
#include <UT/UT_Vector4.h>

class GEO_API GEO_Greville
{
public:
    // Trivial constructor that sets all the private data to 0. Needed when
    // instantiating arrays of Greville objects.
    GEO_Greville() : myUVal((float)0.), myVVal((float)0.)
    {
        myImage.assign(0.0F, 0.0F, 0.0F, 1.0F);
    }

    // Constructor that takes the (u,v) or (u) position of the Greville abscissa
    // in parametric space, and its image on the surface. Later, the image
    // info might represent the CV displacement. img is copied memberwise.
    GEO_Greville(const UT_Vector4 &img, float u = 0.0f, float v = 0.0f)
    { 
        myUVal  = u; myVVal = v;
        myImage = img;
    }

    // Class destructor. Does nothing.
    ~GEO_Greville() {}

    // Set either image: in domain space or in surface (CV) space 
    // respectively. img is copied memberwise.
    void setUVImage(float u)                    { myUVal = u;           }
    void setUVImage(float u, float v)           { myUVal = u; myVVal = v; }
    void setCVImage(const UT_Vector4& img)      { myImage = img; }

    // Grab the private info.
    void                getUVImage(float *u) const { *u = myUVal; }
    void                getUVImage(float *u, float *v) const
                        {
                            *u = myUVal; *v = myVVal; 
                        }
    const UT_Vector4&   getCVImage() const      { return myImage; }

    // Compare two Greville points:
    int                 operator==(const GEO_Greville &grev) const
                        {
                            return (myUVal  == grev.myUVal &&
                                    myVVal == grev.myVVal &&
                                    myImage == grev.myImage);
                        }
    
protected:
private:
    // The (u,v) position in domain space, and the image on the surface.
    float       myUVal;
    float       myVVal;
    UT_Vector4  myImage;
};

#endif