GU/GU_PrimVolume.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:
 *      Jeff Lait
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * NAME:        GU_PrimVolume.h ( GU Library, C++)
 *
 * COMMENTS:
 */

#ifndef __GU_PrimVolume__
#define __GU_PrimVolume__

#include "GU_API.h"

#include <GEO/GEO_PrimVolume.h>

#include "GU_Detail.h"
#include "GU_Prim.h"

class GU_PrimVolumeCache;
class GU_PrimVolumeCacheParms;

class GU_API GU_PrimVolume: public GEO_PrimVolume, public GU_Primitive
{
public:
    // This constructor creates a new GU_PrimVolume but does
    // not append it to the detail
    GU_PrimVolume(GU_Detail *gdp) : GEO_PrimVolume(gdp), GU_Primitive() 
    {
        myDisplayCache = 0;
    }

    // Class destructor.
    ~GU_PrimVolume();
    
    virtual void                *castTo() const;
    virtual const GEO_Primitive *castToGeo(void) const;

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

    virtual void        normal(int noff) const;
    virtual void        normal(UT_Vector3Array &output) const;

    // NOTE:  For static member functions please call in the following
    //        manner.  <ptrvalue> = GU_PrimSphere::<functname>
    //        i.e.      sphereptr = GU_PrimSphere::sphereBuild(params...);

    // Optional Build Method 
    static GEO_Primitive        *build(GU_Detail *gdp);

    // Builds a GU_PrimVolume attached to the given gdp with values
    // initialized from the callback function.  This is intentionally similar
    // to the GU_Detail::polyIsoSurface method.
    // Note that sampling is done at centers of voxels!
    static GEO_Primitive        *buildFromFunction(GU_Detail *gdp, 
                                    float (*valAtPoint)(const UT_Vector3 &),
                                    const UT_BoundingBox &bbox,
                                    int xres, int yres, int zres);
    
    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;
    // Persistent is true if the returned cache is not to be deleted by
    // the caller.
    virtual GU_RayIntersect     *createRayCache(int &persistent);

    // Methods to handle caching.
    virtual GU_DisplayCache     *getDisplayCache(void) const;
    virtual int                  buildVolumeDisplayCache(GU_PrimVolumeCacheParms &parms);

    virtual void                 destroyCache();
    virtual void                 notifyCache(int type);
    virtual void         notifyCache(int type, const GEO_Point &ppt);
    virtual void         notifyCache(int type, const GB_PointGroup &grp);
    virtual void         notifyCache(int type, const UT_Matrix4 &xform, 
                                     int push);
    virtual void         notifyCache(int type, const UT_Vector3 &delta);
private:

    GU_PrimVolumeCache          *myDisplayCache;
};

#endif

---