GU/GU_HoleInfo.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:
 *      Mark Elendt
 *      Side Effects Software Inc.
 *      20 Maud St.
 *      Toronto, Ontario,  M5V 2M5
 *      Canada
 *      416-366-4607
 *
 * NAME:        GU_HoleInfo (C++)
 *
 * COMMENTS:    This is the info structure used for hole information.  Each
 *              primitive has a an attribute added which points to one of these
 *              structures.
 *              The flag is set to 1 if there's a hole.
 *              The array is filled with all the primitives which are enclosed
 *              within the face.
 */

#ifndef __GU_HoleInfo__
#define __GU_HoleInfo__

#include "GU_API.h"
#include <UT/UT_PtrArray.h>
#include <UT/UT_BoundingBox.h>

class GU_Detail;
class GEO_Primitive;
class GEO_Face;

class GU_API GU_HoleInfo 
{
public:
     GU_HoleInfo(const GEO_Primitive *prim);
    ~GU_HoleInfo();

    // isHole() will return whether the primitive is contained in another face.
    unsigned             isHole() const { return myHoleFlag & 1; }

    // isReversed() will return whether the normal is opposite of the
    // surrounding primitives normal (as it should be).
    unsigned             isReversed() const     { return myHoleFlag & 2; }

    // Return the number of holes in the primitive and a pointer to the hole.
    int                  entries() const        { return myHoles.entries(); }
    GEO_Face            *getHole(int i)         { return myHoles(i); }

    /// Store @b this hole info in the given attribute for the given object
    void                         setHole(GB_AttributeElem &o,
                                                const GB_AttributeRef &h);
    /// @{ Get the hole info out of the object
    static GU_HoleInfo          *getHole(GB_AttributeElem &o,
                                                const GB_AttributeRef &h);
    static const GU_HoleInfo    *getHole(const GB_AttributeElem &o,
                                                const GB_AttributeRef &h);
    /// @}

    // For promotion of primitives
    int                  setPromotedFace(GEO_Face *face)
                         {
                             myFace = face;
                             return myFace != 0;
                         }
    GEO_Face            *getPromotedFace()      { return myFace; }

    // A bounding box for the primitive.
    const UT_BoundingBox        &getBox() const { return myBox; }

// Methods which really should be private...
    UT_PtrArray<GEO_Face *>     &getHoles()     { return myHoles; }
    void                         setHole(int on)
                                 {
                                     if (on)    myHoleFlag |= 1;
                                     else       myHoleFlag &= ~1;
                                 }
    void                         setReversed()  { myHoleFlag |= 2; }

private:
    void                 fixPromotions(const GB_AttributeRef &attrib_off);

    unsigned                     myHoleFlag;
    UT_PtrArray<GEO_Face *>      myHoles;
    UT_BoundingBox               myBox;
    GEO_Face                    *myFace;                // Promoted

    friend class GU_HoleDetail;
};

class GU_API GU_HoleDetail
{
public:
            GU_HoleDetail();
            ~GU_HoleDetail();

    // Returns the primitive attribute offset for the hole info pointers.
    // It returns -1 if there are no face primitives in the gdp.
    // The info structures are all initialized to contain the correct hole
    // information.
    GB_AttributeRef     buildInfo(GU_Detail *gdp, float distance, float angle,
                       const GB_PrimitiveGroup *primGroup);

    // Build information about orientation of the holes (i.e. whether the
    // normal is the wrong way for the holes).
    void        buildReversalInfo();
    // Promote polygons to bezier when needed.  The old primitives are
    // destroyed, but the attribute information is maintained.
    void        promoteFaces();

    // Detaches us from the GU_Detail, possibly deleting our normal.
    void        destroyInfo();

protected:
    GU_Detail           *myGdp;
    GB_AttributeRef      myInfoOffset;
    bool                 myAddedNormals;
    GB_AttributeRef      myCmpInfoOffset;
};

#endif

---