GT_PrimVDB.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:        GT_PrimVDB.h ( GT Library, C++)
 *
 * COMMENTS:
 */

#ifndef GT_PrimVDB_h
#define GT_PrimVDB_h

#include "GT_API.h"
#include "GT_DataArray.h"
#include "GT_Primitive.h"
#include "GT_GEOPrimCollect.h"
#include <GEO/GEO_PrimVDB.h>
#include <UT/UT_VectorTypes.h>
#include <SYS/SYS_Inline.h>

#include <openvdb/Grid.h>


class GT_API GT_PrimVDB : public GT_Primitive
{
public:
    GT_PrimVDB(const GU_ConstDetailHandle &gdh, const GEO_Primitive *prim);
    ~GT_PrimVDB() override;

    int                 getPrimitiveType() const override
                            { return GT_PRIM_VDB_VOLUME; }
    
    const char         *className() const override { return "GT_PrimVDB"; }

    bool                isLevelSet() const { return myLevelSetFlag; }
    bool                isVolume() const   { return myVolumeFlag; }
    bool                isInvisible() const { return myIsInvisible; }

    // Compute list of voxel coords with corresponding leaf node edge masks.
    // Returns coords.entries().
    exint               getLeafCoords(
                            UT_Vector3FArray &coords,
                            UT_Int16Array &masks) const;

    /// Returns a GT_PrimPointMesh with 1 point containing the VDB's 1 point.
    /// Contains all of the VDBs attributes as point or uniform attributes.
    GT_PrimitiveHandle  getPointPrimitive() const;

    GEO_PrimVolumeXform getVolumeTransform() const;
    GEO_PrimVolumeXform getVolumeIndexTransform() const;

    UT_Vector3I         getRes() const;

    /// Viewport refinement options -- changes on LOD
    const GT_ViewportRefineOptions &viewportRefineOptions() const override;

    bool                refine(GT_Refine &refiner,
                               const GT_RefineParms *parms=NULL) const override;

    void                enlargeBounds(UT_BoundingBox boxes[],
                                      int nsegments) const override;
    int                 getMotionSegments() const override { return 1; }
    int64               getMemoryUsage() const override
                            { return sizeof(GEO_Primitive *);}
    GT_PrimitiveHandle  doSoftCopy() const override
                            { return new GT_PrimVDB(*this); }

    bool                updateGeoPrim(const GU_ConstDetailHandle &dtl,
                                      const GT_RefineParms &refine) override;
    
    GA_Offset           getPrimitiveOffset() const { return myPrimID; }
    GA_Offset           getPointOffset() const     { return myPointID; }
    UT_Vector3F         getPrimColor() const   { return myPrimColor; }

    GT_TransformHandle  getGridTransform();

    /// Set the list of uniform attributes.
    void setUniformAttributes(const GT_AttributeListHandle &uniform)
    {
        myUniformList = uniform;
    }

    const GT_AttributeListHandle        &getUniformAttributes() const override
                                            { return myUniformList; }

    SYS_FORCE_INLINE
    const openvdb::GridBase *   getGrid() { return &myVDB->getGrid(); }

    const GEO_PrimVDB           *getGeoPrimitive() const { return myVDB; }
    const GU_ConstDetailHandle  &getDetail() const { return myDetail; }

private:
    const GEO_PrimVDB *         myVDB;

    GU_ConstDetailHandle        myDetail;
    GT_AttributeListHandle      myUniformList;
    GA_Offset                   myPrimID;
    GA_Offset                   myPointID;
    UT_Vector3F                 myPrimColor;
    bool                        myVolumeFlag;
    bool                        myLevelSetFlag;
    bool                        myIsInvisible;
};

/// Trivial collector class for VDBs - 1 GT_PrimVDB per VDB primitive
class GT_API GT_GEOPrimCollectVDB : public GT_GEOPrimCollect
{
public:
                    GT_GEOPrimCollectVDB() {}
                   ~GT_GEOPrimCollectVDB() override {}

    GT_PrimitiveHandle         collect(const GT_GEODetailListHandle &g,
                                       const GEO_Primitive *const* prim_list,
                                       int,
                                       GT_GEOPrimCollectData *) const override
    {
        GT_PrimitiveHandle vdbh;
        vdbh = new GT_PrimVDB(g->getGeometry(0), prim_list[0]);
        return vdbh;
    }
};

#endif