GB/GB_PointRef.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:        Geometry Library (C++)
 *
 * COMMENTS:    This class is used to get a point reference list.  It
 *              is used to consolidate points, and also to build wing
 *              edge structures and other things.
 *
 */

#ifndef __GB_PointRef_H__
#define __GB_PointRef_H__

#include "GB_API.h"
#include "GB_Detail.h"

class UT_BitArray;
class GB_Primitive;
class GB_Vertex;
class GB_Group;

typedef struct GB_PointRef GB_PointRef;

struct GB_PointRef {
     GB_Primitive       *prim;
     GB_Vertex          *vtx;
     GB_PointRef        *next;
     GB_PointRef        *prev;
};

class GB_API GB_PointRefArray {
public:
     GB_PointRefArray(const GB_Detail *gdp, const GB_Group *group);
     GB_PointRefArray(const GB_Detail *gdp, const UT_BitArray &points);
     GB_PointRefArray(int size = 0);
     virtual ~GB_PointRefArray();

    unsigned             entries() const { return size; }
    const GB_PointRef   *operator()(unsigned idx) const
                         {
                            return (idx < size) ? array[idx] : 0;
                         }

//
//  Delete a point reference
    void                 destroyReference(GB_PointRef *ref);

//
//  Move a point reference to another refArray.
    void                 moveReference(GB_PointRef *ref, GB_PointRefArray &d);

//
//  The following methods maintain the integrity of the ref array
//   fromPt->toPt will change all references from the from Point to
//              the toPoint (optionally only in the primitive specified)
//       fromVtx->toPt will change the single vertex from one point to
//              another point
//  They return -1 on an internal error or 0 on success
//
    int                  changeVertexRef(const GB_Element &fromPt,
                                         GB_Element &toPt,
                                         const GB_Primitive *prim = 0);
    int                  changeVertexRef(GB_Vertex &vtx, GB_Element &toPt);

protected:
    GB_PointRef         **array;
    unsigned              size;

private:
    void                  removeReference(GB_PointRef *ref);
};

/// This function adds all the adjacent primitives of the pt_group to
/// prim_group within gdp. If given a restrict_group, then we use it to
/// restrict the list of primitives that we consider. The behaviour of this
/// group is determined by the restrict_if_contains flag. If this flag is true,
/// then only primitives in the restrict_group are considered. If the flag is
/// false, then only primitives _not_ in the restrict_group are used.
GB_API extern void GBgetPrimitiveClosure(const GB_Detail &gdp,
                                         const GB_PointGroup *pt_group,
                                         GB_PrimitiveGroup *prim_group,
                                         GB_PrimitiveGroup *restrict_group = 0,
                                         bool restrict_if_contains = true);
/// Same version of the above function except pt_group is a bit array with each
/// bit representing if the particular point is in the pt_group.
GB_API extern void GBgetPrimitiveClosure(const GB_Detail &gdp,
                                         const UT_BitArray &pt_array,
                                         GB_PrimitiveGroup *prim_group,
                                         GB_PrimitiveGroup *restrict_group = 0,
                                         bool restrict_if_contains = true);

#endif

---