GOP/GOP_Guide.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:
 *      Dale Ducharme   
 *      Side Effects Software Inc.
 *      477 Richmond St. West
 *      Toronto, Ontario,  M5V 2M5 
 *      Canada
 *      416-504-9876
 *
 * NAME:        GOP_Guide.h     
 *
 * COMMENTS:    The guide geometry and how to draw it.
 *
 */

#ifndef __GOP_Guide_h_
#define __GOP_Guide_h_

#include "GOP_API.h"
#include <UT/UT_PtrArray.h>
#include <GU/GU_Detail.h>

enum GOP_GuideType {
    OP_GUIDE_ONE,
    OP_GUIDE_TWO
};

enum GOP_GuideListType {
    OP_GUIDELIST_GOPGUIDE,
    OP_GUIDELIST_GUDETAIL
};

class GOP_API GOP_GuideText 
{
public:
    GOP_GuideText()
    {
        text = 0;
        posx = posy = posz = 0;
    }
    ~GOP_GuideText()
    {
        if (text)
            free(text);
    }
    
    char        *text;
    float        posx, posy, posz;
};

class   GB_PointGroup;

//  This is a class which handles the drawing of guide geometry

class GOP_API GOP_Guide : public GU_Detail
{
public:
    GOP_Guide(GOP_GuideType intype = OP_GUIDE_ONE);
    GOP_Guide(const GOP_Guide &source);
    virtual ~GOP_Guide();

    void                displayGeometry  (short f)  { drawGeometry = f;   }
    void                displayFont      (short f)  { drawAsFont   = f;   }
    void                displayHulls     (short f)  { drawHulls    = f;   }
    void                displayText      (short f)  { drawText     = f;   }
    void                displayPrimNums  (short f)  { drawPrimNums = f;   }
    void                displayAsPoints  (short f)  { drawAsPoints = f;   }

    void                displayPoints    (GB_PointGroup *g)  
                                                { myPointGroup   = g;     }

    void                displayTangentU  (GB_PointGroup *g)  
                                                { myTangentUGroup   = g;  }
    void                displayTangentV  (GB_PointGroup *g)  
                                                { myTangentVGroup   = g;  }

    void                displayWidth     (short f)  { drawWidth    = f;   }

    int                 displayGeometry  () const { return drawGeometry;  }
    int                 displayFont      () const { return drawAsFont;    }
    int                 displayHulls     () const { return drawHulls;     }
    int                 displayText      () const { return drawText;      }
    int                 displayPrimNums  () const { return drawPrimNums;  }
    int                 displayAsPoints  () const { return drawAsPoints;  }

    GB_PointGroup      *displayPoints    () const { return myPointGroup;  }
    GB_PointGroup      *displayTangentU  () const { return myTangentUGroup; }
    GB_PointGroup      *displayTangentV  () const { return myTangentVGroup; }

    short               displayWidth     () const { return drawWidth;     }

    GOP_GuideType       getType          () const { return myType;        }

    /// The given word is copied and stored in the GOP_GuideText, allowing
    /// you to do what you wish with it afterwards.  This differs from
    /// earlier versions of Houdini where only the pointer was copied.
    void                addText(const char *word, float x, float y, float z); 
    GOP_GuideText       *getText(int i) const  
                                    { return (myText) ? (GOP_GuideText*)(*myText)(i) : 0; }
    int                 numTextEntries() const 
                                    { return (myText) ? myText->entries() : 0; }
    void                clearTextEntries();

    const UT_PtrArray<GOP_GuideText *> *getTextArray() const { return myText; }


    void                buildVector(const UT_Vector3 &origin,
                                    const UT_Vector3 &direction,
                                    const GU_Detail *boxgdp);

    void                buildCurve(const GEO_Primitive *prim,  
                                   GB_PointGroup *guidepts, 
                                   int doU, float depth,
                                   float width1, float width2);

    void                buildDomain(const GU_Detail *srcgdp,
                                    GB_PrimitiveGroup *srcgroup, 
                                    const GEO_Primitive *auxprim, 
                                    int first_group,
                                    GB_PointGroup *guidepts, 
                                    int doU, int loop, float ldepth, 
                                    float lwidth1, float lwidth2,
                                    float rdepth, float rwidth1, 
                                    float rwidth2);

private:

    UT_PtrArray<GOP_GuideText *>        *myText;
    GOP_GuideType                myType;

    GB_PointGroup               *myPointGroup;
    GB_PointGroup               *myTangentUGroup;
    GB_PointGroup               *myTangentVGroup;

    unsigned int                 drawGeometry   : 1,
                                 drawAsFont     : 1,
                                 drawHulls      : 1,
                                 drawText       : 1,
                                 drawPrimNums   : 1,
                                 drawAsPoints   :1;

    short                        drawWidth;
};

#endif

---