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.
 *
 * NAME:        GOP_Guide.h     
 *
 * COMMENTS:    The guide geometry and how to draw it.
 *
 */

#ifndef __GOP_Guide_h_
#define __GOP_Guide_h_

#include "GU_API.h"
#include "GU_Detail.h"

enum GOP_GuideType
{
    OP_GUIDE_ONE,
    OP_GUIDE_TWO
};

enum GOP_GuideListType
{
    OP_GUIDELIST_GOPGUIDE,
    OP_GUIDELIST_GUDETAIL
};

class GA_PointGroup;

//  This is a class which handles the drawing of guide geometry
// GOP_Guide used binary incompatible with GU_Detail as it had extra
// local flags.  The flags had stopped being respected.

class GU_API GOP_Guide : public GU_Detail
{
public:
    GOP_Guide(GOP_GuideType intype = OP_GUIDE_ONE)
        : GU_Detail() {}

    void                displayGeometry  (bool f)  { }
    void                displayFont      (bool f)  { }
    void                displayHulls     (bool f)  { }
    void                displayText      (bool f)  { }
    void                displayPrimNums  (bool f)  { }
    void                displayAsPoints  (bool f)  { }
    
    /// Display this guide as shaded when in viewport shaded modes.
    void                displayShaded    (bool  b)  { }
    /// Always display this guide as shaded, regardless of viewport shading mode
    void                forceShaded      (bool  b)  { }
    /// Draw the guide so that it can be seen through solid objects as wireframe
    void                drawXRay         (bool  b)  { }

    bool                displayGeometry  () const { return true;  }
    bool                displayFont      () const { return false; }
    bool                displayHulls     () const { return false; }
    bool                displayText      () const { return false; }
    bool                displayPrimNums  () const { return false; }
    bool                displayAsPoints  () const { return false; }
    bool                displayShaded    () const { return false; }
    bool                forceShaded      () const { return false; }
    bool                drawXRay         () const { return false; }

    GOP_GuideType       getType          () const { return OP_GUIDE_ONE; }

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

    void                buildCurve(const GEO_Primitive *prim,
                                   GA_PointGroup *guidepts,
                                   int doU, float depth,
                                   float width1, float width2,
                                   bool arclen=false);

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

    int64 getMemoryUsage(bool inclusive) const override
    {
        int64 mem = inclusive ? sizeof(*this) : 0;
        mem += GU_Detail::getMemoryUsage(false);
        return mem;
    }
};

#endif