GU/GU_PointGroupSelection.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:
 *      Cristin Barghiel
 *      Side Effects Software Inc.
 *      20 Maud St.
 *      Toronto, Ontario,  M5V 2M5
 *      Canada
 *      416-366-4607
 *
 * NAME:        GU_PointGroupSelection (C++)
 *
 * COMMENTS:
 *      Point group selection.
 *
 * 
 */

#ifndef __GU_PointGroupSelection_h__
#define __GU_PointGroupSelection_h__

#include "GU_API.h"
#include "GU_PointSelection.h"

#define GU_pointGroupSelectName         "selectedPointGroup"


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

    // Conversion methods. These methods update the point and primitive
    // closures, but not the stash array.
    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  &);

    // Add some geo entity to the selection. Each selection class will 
    // interpret the insertion in its own way. For example, by inserting a
    // GEO_Point into a primitive selection we actually insert all the prims
    // that share that point. Conversely, by inserting a GEO_Primitive into
    // a point selection we actually insert all the prim's points. The methods
    // return 1 if something has been added and 0 otherwise.
    // These methods do NOT update the point and primitive closure, just in
    // case you are doing multiple adds.
    virtual int                  add(GEO_Point      &point, int ordered=0);
    virtual int                  add(GEO_Primitive  &prim,  int ordered=0);
    virtual int                  add(GB_Edge        &edge,  int ordered=0);
    virtual int                  add(GEO_Breakpoint &bkp,   int ordered=0);
    virtual int                  add(GB_VertexData  &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(GEO_Point      &point, int ordered=0);
    virtual int                  remove(GEO_Primitive  &prim,  int ordered=0);
    virtual int                  remove(GB_Edge        &edge,  int ordered=0);
    virtual int                  remove(GEO_Breakpoint &bkp,   int ordered=0);
    virtual int                  remove(GB_VertexData  &vtx,   int ordered=0);

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

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

protected:
private:
    // Used to create new species.
    GU_PointGroupSelection(GU_Detail &gdp, const GU_PointGroupSelection &s);
};

#endif

---