GU_PrimGroup.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:        GU Library (C++)
 *
 * COMMENTS:
 *
 */

#ifndef __GU_PrimGroup_h__
#define __GU_PrimGroup_h__

#include "GU_API.h"
#include <GEO/GEO_Primitive.h>
#include "GU_ElementGroup.h"
#include "GU_Detail.h"

////////////////////////////////////////////////////////////////////////////
//
//  GU_PrimGroup - Creates a primitive group and selects specific 
//                 primitives to be members given a set of parameters
//
////////////////////////////////////////////////////////////////////////////


class GU_API GU_PrimGroup : public GU_ElementGroup
{
public:
    /// Create a detached group that we own.
    GU_PrimGroup(const GU_Detail *gdp, const GA_PrimitiveTypeId &id)
        : GU_ElementGroup(SYSconst_cast(gdp))
        , myId(id)
    { newGroup(NULL); }
    GU_PrimGroup(const char *n, GU_Detail *gdp, const GA_PrimitiveTypeId &id)
        : GU_ElementGroup(gdp)
        , myId(id)
    { newGroup(n); }
    GU_PrimGroup(GU_Detail *gdp, GA_PrimitiveGroup *primGroup)
        : GU_ElementGroup(gdp)
    { 
        myName = primGroup->getName();
        setGroup(primGroup);
    }
    ~GU_PrimGroup() override;

    GA_PrimitiveGroup *primGroup() const;

    GA_ElementGroup     *newGroup(const char *name) override;
    GA_ElementGroup     *find(const char *name) const override;
    void                 destroy() override;

    // Goes through the methods below with the given parameters and creates
    // a group.
    void                 generateGroup(const GU_GroupParms &parms) override;

    // methods that allow you to select objects to be in the group 
    void                 range(int num, int, int, int, int, int) const override;
    void                 pattern(const char *pattern, int nelements,
                                 int) const override;
    void                 patternGroup(const char *pattern,
                                      bool order) const override;
    int                  boundingBox(float, float, float, float, float, float,
                                     float, float, float, bool) override;
    void                 boundingSphere(float tx, float ty, float tz,
                                        float radx, float rady, float radz,
                                        bool includeNotWhollyContained)
                                        const override;
    void                 normal(UT_Vector3 &nml, float angle,
                                bool include_opposite=false) const override;
    void                 backface(const UT_Vector3 &eye) const;
    void                 degenerate(bool degenerate, bool zaf, bool doOpen,
                                    float tol) const override;

    void                 nonplanar(float tol) const;

    void                 randomChance(float seed, float frac, bool use_attrib,
                                      const char *attrib_name) const override;
private:
    /// The name of the group, or NULL if a detached group
    const char          *myName;
    GA_PrimitiveTypeId   myId;

    bool                 primInsideSphere(const GU_Detail &detail, GA_Offset primoff,
                                          float, float, float, float, float, float, bool) const;

    bool                 matchTypeId(const GA_PrimitiveTypeId &id) const;
};

#endif