GU/GU_PrimMetaBall.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:
 *      Dale Ducharme
 *      Side Effects Software Inc.
 *      20 Maud St.
 *      Toronto, Ontario,  M5V 2M5
 *      Canada
 *      416-366-4607
 *
 * NAME:        GU_PrimMetaBall.h (C++)
 *
 * COMMENTS:
 *      Header file for GU_PrimMetaBall.h class...
 * 
 */

#ifndef __GU_PrimMetaBall_h__
#define __GU_PrimMetaBall_h__

#include "GU_API.h"
#include <GEO/GEO_PrimMetaBall.h>
#include "GU_Detail.h"
#include "GU_Prim.h"

class GEO_Hull;
class GU_PrimPoly;
class GU_PrimMesh;
class GU_PrimNURBSurf;
class GU_PrimRBezSurf;

/////////////////////////////////////////////////////////////
//                                                         //
// Class:       GU_PrimMetaBall                            //
// Descr:     This class is responsible for operations     //
//       done on sphere primitives.  As we need to access  //
//       the GU_Detail, the pointer is passed in the       //
//       constructor.  The second constructor creates a    //
//       sphere with the given parameters.                 //
//                                                         //
/////////////////////////////////////////////////////////////

class GU_API GU_PrimMetaBallParms
{
public:
    GU_PrimMetaBallParms(GU_Detail *gdp=NULL, GEO_Point *ppt=NULL,
                        fpreal weight=2);

    GU_Detail                   *gdp;
    GEO_Point                   *ppt;           // use this point instead of yours
    UT_Matrix4                   xform;
    float                        weight;
};

class GU_API GU_PrimMetaBall : public GEO_PrimMetaBall, public GU_Primitive
{
public:
    // This constructor creates a new GU_PrimMetaBall but does
    // not append it to the detail
    GU_PrimMetaBall(GU_Detail *gdp, GA_Offset offset=GA_INVALID_OFFSET)
        : GEO_PrimMetaBall(gdp, offset)
        , GU_Primitive()
    {
        gdp->incrementCacheables();
    }
    GU_PrimMetaBall(const GA_MergeMap &map,
                    GU_Detail &detail,
                    GA_Offset offset,
                    const GU_PrimMetaBall &src)
         : GEO_PrimMetaBall(map, detail, offset, src)
         , GU_Primitive()
     {
        detail.incrementCacheables();
     }

    // Class destructor.
    virtual ~GU_PrimMetaBall();

    virtual const GA_PrimitiveDefinition        &getTypeDef() const
                                                {
                                                    UT_ASSERT(theDefinition);
                                                    return *theDefinition;
                                                }

    
    // Conversion Methods 
    GEO_Primitive               *convert(GU_ConvertParms &parms, 
                                         GA_PointGroup *usedpts = 0);
    GEO_Primitive               *convertNew(GU_ConvertParms &parms);

    virtual void                normal(NormalComp &output) const;

    void                        *castTo() const;

    // Optional Build Method 
    static GU_PrimMetaBall      *build(const GU_PrimMetaBallParms &parms, 
                                       const char *type = "wyvill");

    // Other representations. The rotation vector must be specified in a 
    // RIGHT-HANDED system.

    virtual int         intersectRay(const UT_Vector3 &o, const UT_Vector3 &d,
                                float tmax = 1E17F, float tol = 1E-12F,
                                float *distance = 0, UT_Vector3 *pos = 0,
                                UT_Vector3 *nml = 0, int accurate = 0,
                                float *u = 0, float *v = 0,
                                int ignoretrim = 1) const;

    // Methods to handle display caching.
    virtual void         notifyCache(int type);
    virtual void         notifyCache(int type, const GEO_Point &ppt);
    virtual void         notifyCache(int type, const GA_PointGroup &grp);
    virtual void         notifyCache(int type, const UT_Matrix4 &xform, 
                                     int push);
    virtual void         notifyCache(int type, const UT_Vector3 &delta);
    // Persistent is true if the returned cache is not to be deleted by
    // the caller.
    virtual GU_RayIntersect     *createRayCache(int &persistent);
                                 
    virtual const GEO_Primitive *castToGeo(void) const;


private:
    void                create(const UT_Matrix4 &xform,
                                float weight, const char *kernel = "wyvill",
                                GEO_Point *ppt = 0);

    static GA_PrimitiveDefinition       *theDefinition;
    friend class                         GU_PrimitiveFactory;
};

#endif

---