GU/GU_PrimConSelection.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 Software Inc.
 *      20 Maud St.
 *      Toronto, Ontario,  M5V 2M5
 *      Canada
 *      416-366-4607
 *
 * NAME:        GU_PrimConSelection (C++)
 *
 * COMMENTS:
 *      Connected primitive selection.
 *
 */

#ifndef __GU_PrimConSelection_h__
#define __GU_PrimConSelection_h__

#include "GU_API.h"
#include "GU_PrimSelection.h"
#include "GU_SelectionConMgr.h"

#define GU_primConSelectName    "selectedConnectedPrims"

class GU_API GU_PrimConSelection : public GU_PrimSelection
{
public:
    // Class constructor and destructor. The prefix is used for naming the 
    // three internal groups, thePoints, thePrims and theShared. 
    // If we find the group by the specified name and reset is TRUE, 
    // we clear it.
    GU_PrimConSelection(GU_Detail &gdp, 
                        const char *grpname = "_gu_pmcselection_",
                        int reset = 0, const char *prefix = 0);
    GU_PrimConSelection(GU_Detail &gdp, GA_PrimitiveGroup &ptgroup,
                        const char *prefix = 0);
    virtual ~GU_PrimConSelection(void);



    virtual GU_Selection        &operator=(GU_PointSelection &);
    virtual GU_Selection        &operator=(GU_PrimSelection  &);
    virtual GU_Selection        &operator=(GU_EdgeSelection  &);
    virtual GU_Selection        &operator=(GU_BreakpointSelection &);
    virtual GU_Selection        &operator=(GU_VertexSelection &);
    virtual GU_Selection        &operator=(GU_PointGroupSelection &);
    virtual GU_Selection        &operator=(GU_PrimGroupSelection  &);


    virtual int          add(const GEO_Point        &point, int ordered=0);
    virtual int          add(const GEO_Primitive  &prim,  int ordered=0);
    virtual int          add(const GA_Edge          &edge,  int ordered=0);
    virtual int          add(const GA_Edge          &edge, GEO_Primitive &,
                             int ordered=0)
                         { return add(edge, ordered); }
    virtual int          add(const GA_Breakpoint &bkp,   int ordered=0);
    virtual int          add(const GEO_Vertex  &vtx,   int ordered=0);

    // Remove some geo entity from the selection. Each selection class will 
    // interpret the removal in its own way. For example, by removing a
    // GEO_Point from a primitive selection we actually remove all the prims
    // that share that point. Conversely, by removing a GEO_Primitive from
    // a point selection we actually remove all the prim's points. The methods
    // return 1 if something has been removed and 0 otherwise.
    // These methods do NOT update the point and primitive closure, just in
    // case you are doing multiple removals.
    virtual int          remove(const GEO_Point      &point, int ordered=0);
    virtual int          remove(const GEO_Primitive  &prim,  int ordered=0);
    virtual int          remove(const GA_Edge          &edge,  int ordered=0);
    virtual int          remove(const GA_Edge          &edge, GEO_Primitive &,
                                int ordered=0)
                         { return remove(edge, ordered); }
    virtual int          remove(const GA_Breakpoint &bkp,   int ordered=0);
    virtual int          remove(const GEO_Vertex  &vtx,   int ordered=0);

    // Use the pick buffer to update your selection according to the given
    // rule. Return 1 if the selection has changed and 0 otherwise. The first
    // primitive to be added to us (if any), is returned in 'added', and so is
    // the pickid unless the pointer to is is zero.
    virtual int          select(uint *pickbuf, long npicked,
                                        GU_SelectResult &added,
                                        GU_SelectionRule rule   = GU_AddSelect,
                                        unsigned *pickid        = 0,
                                        GU_LassoInfo *linfo     = 0,
                                        const UT_IntArray *prfx = 0);


    virtual void                 clear(void);
    virtual void                 clearAndDestroy(void);

    virtual void                 topologyChanged();
    
    // Query the type of selection
    virtual int                  classType(void) const;

    // Create a new identical selection as this one in gdp
    virtual GU_Selection        *newSpecies(GU_Detail &gdp);

protected:

    GEO_PrimConnector   *getConnector();

    GU_SelectionConMgr  myConnectivityMgr;

private:

    // Used to create new species
    GU_PrimConSelection(GU_Detail &gdp, const GU_PrimConSelection &s);


};

#endif

---