GU/GU_FloatVectorWrapper.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:
 *      George ElKoura
 *      Side Effects
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        GU Library.
 *
 * COMMENTS:    A GU_FloatVectorWrapper is a useful abstraction to dealing with
 *              point positions and float attribute arrays as it provides a 
 *              common interface to the two.
 *              It currently does not support vertex attributes.
 */
#ifndef __GU_FloatVectorWrapper_h__
#define __GU_FloatVectorWrapper_h__

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

class GEO_Point;
class GEO_Vertex;

class GU_API GU_FloatVectorWrapper
{
public:
                 GU_FloatVectorWrapper()        {}
    virtual     ~GU_FloatVectorWrapper()        {}

    // Operators
    virtual GU_FloatVectorWrapper   &operator =(float s)                    = 0;
    virtual GU_FloatVectorWrapper   &operator*=(float s)                    = 0;
    virtual GU_FloatVectorWrapper   &operator/=(float s)                    = 0;

    // Add our data to the point or vertex
    virtual void                     addTo(GEO_Point  &pt)                  = 0;
    virtual void                     addTo(GEO_Vertex &vtx)                 = 0;

    // Add the scaled data of pt to our data
    virtual void                     addScaledData(GEO_Point  &pt, float s) = 0;
    virtual void                     addScaledData(GEO_Vertex &vtx, float s)= 0;
    
    // Subtract the data of pt from our data
    virtual void                     subtractData(GEO_Point  &pt) = 0;
    virtual void                     subtractData(GEO_Vertex &vtx) = 0;
};


// The point float attribute array wrapper
class GU_API GU_AttribWrapper : public GU_FloatVectorWrapper
{
public:
    // ptattrib is 1 if it is a point attribute and 0 if it is a vertex
    // attribute.
             GU_AttribWrapper(int ptattrib, int attriboffset, int attribsize);
    virtual ~GU_AttribWrapper();

    // Operators
    virtual GU_FloatVectorWrapper   &operator =(float s);
    virtual GU_FloatVectorWrapper   &operator*=(float s);
    virtual GU_FloatVectorWrapper   &operator/=(float s);

    // The versions of the following methods that take GEO_Vertex will delegate
    // to the point versions if this is a point attribute, this saves the caller
    // from having to always check before calling the correct version.

    // Add our data to the point
    virtual void                     addTo(GEO_Point  &pt);
    virtual void                     addTo(GEO_Vertex &vtx);

    // Add the scaled data of pt to our data
    virtual void                     addScaledData(GEO_Point &pt,float s);
    virtual void                     addScaledData(GEO_Vertex &vtx, float s);
    
    // Subtract the data of pt from our data
    virtual void                     subtractData(GEO_Point  &pt);
    virtual void                     subtractData(GEO_Vertex &vtx);

protected:
    void                             addTo(float *attribdata);
    void                             addScaledData(float *attribdata, float s);
    void                             subtractData(float *attribdata);

    bool                             isPointAttrib() const
                                     { return myAttribOwner == 1; }

private:
    int          myAttribOwner;     // 0 = vertex, 1 = point
    int          myAttribOffset;
    int          myAttribSize;
    float       *myData;
};


// The point position array wrapper
class GU_API GU_PointPosWrapper : public GU_FloatVectorWrapper
{
public:
     GU_PointPosWrapper() {}

    // Operators
    virtual GU_FloatVectorWrapper   &operator =(float s);
    virtual GU_FloatVectorWrapper   &operator*=(float s);
    virtual GU_FloatVectorWrapper   &operator/=(float s);

    // Add our data to the point
    virtual void                     addTo(GEO_Point  &pt);
    virtual void                     addTo(GEO_Vertex &vtx);

    // Add the scaled data of pt to our data
    virtual void                     addScaledData(GEO_Point &pt,float s);
    virtual void                     addScaledData(GEO_Vertex &vtx, float s);
    
    // Subtract the data of pt from our data
    virtual void                     subtractData(GEO_Point  &pt);
    virtual void                     subtractData(GEO_Vertex &vtx);

private:
    UT_Vector4      myData;
};

#endif

---