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

#ifndef __SIM_OpenCLMergeVDB__
#define __SIM_OpenCLMergeVDB__

#include "SIMZ_API.h"

#include <DOP/DOP_Node.h>
#include <DOP/DOP_AutoSolver.h>
#include <GAS/GAS_SubSolver.h>
#include <GAS/GAS_Utils.h>
#include <SIM/SIM_Query.h>
#include <SIM/SIM_QueryCombine.h>

#include "SIM_OpenCLMergeVDBParms.proto.h"

class SIM_SourceRule;

/// This class implements the solving logic.
class SIMZ_API SIM_GasOpenCLMergeVDB : public GAS_SubSolver
{
public:
    SIM_OpenCLMergeVDBParms& param() { return myParms; }
    const SIM_OpenCLMergeVDBParms& param() const { return myParms; }

    OP_VERSION versionParms() const { return myVersion; }
    void setVersionParms(OP_VERSION version) { myVersion = version; }

protected:
    explicit SIM_GasOpenCLMergeVDB(const SIM_DataFactory* factory);
    ~SIM_GasOpenCLMergeVDB() override;

    void saveSubclass(std::ostream& os) const override
    {
        BaseClass::saveSubclass(os);
        myParms.save(os);
    }

    bool loadSubclass(UT_IStream& is) override
    {
        if (!BaseClass::loadSubclass(is))
            return false;
        if (!myParms.load(is))
            return false;
        return true;
    }

    SIM_Query* createQueryObjectSubclass() const override
    {
        return new SIM_QueryCombine(BaseClass::createQueryObjectSubclass(),
                                    myParms.createQueryObject(this));
    }

    void makeEqualSubclass(const SIM_Data* source) override
    {
        BaseClass::makeEqualSubclass(source);
        const SIM_GasOpenCLMergeVDB *src
            = SIM_DATA_CASTCONST(source, SIM_GasOpenCLMergeVDB);
        if (src)
        {
            myParms = src->param();
            myVersion = src->versionParms();
        }
    }

    bool solveGasSubclass(SIM_Engine& engine,
                          SIM_Object* obj,
                          SIM_Time time,
                          SIM_Time timestep) override;

    void instanceVolumes(SIM_Object* obj,
                         const GU_Detail* gdp,
                         const UT_Vector3& pos,
                         GA_CEAttribute* pos_attrib,
                         GA_CEAttribute* orient_attrib,
                         GA_CEAttribute* pivot_attrib,
                         SIM_Time timestep) const;
    void instancePackedSets(SIM_Object* obj,
                            const GU_Detail* gdp,
                            const GU_Detail* inst_geo,
                            const UT_Vector3& pos,
                            SIM_Time timestep) const;

    void doSource(SIM_ScalarField* targets, SIM_VectorField* targetv,
                  SIM_ScalarField* weight, const GEO_PrimVDB* srcfield,
                  const GEO_PrimVDB* srcweight,
                  const SIM_SourceRule& source,
                  const UT_Vector3& position, const GA_CEAttribute* pos,
                  const GA_CEAttribute* orient, const GA_CEAttribute* pivot,
                  float timestep) const;
    void doSourceSingle(SIM_ScalarField* targets,
                        SIM_VectorField* targetv,
                        SIM_ScalarField* weight,
                        const GEO_PrimVDB* srcfield,
                        const GEO_PrimVDB* srcweight,
                        const SIM_SourceRule& s,
                        const UT_Vector3& pos,
                        const UT_Vector3& inst_pos,
                        const UT_Quaternion& inst_orient,
                        const UT_Vector3& inst_pivot,
                        const UT_Vector3& inst_vel,
                        const UT_Vector3& inst_angvel,
                        float timestep) const;

private:
    SIM_OpenCLMergeVDBParms     myParms;
    OP_VERSION                  myVersion;

    static const SIM_DopDescription* getDopDescription();

    DECLARE_STANDARD_GETCASTTOTYPE();
    DECLARE_DATAFACTORY(SIM_GasOpenCLMergeVDB,
                        GAS_SubSolver,
                        "Gas OpenCL Merge VDB",
                        getDopDescription());
};

// This class applies parameters to SIM_GasOpenCLMergeVDB.
class SIMZ_API DOP_OpenCLMergeVDB : public DOP_AutoSolver
{
public:
    DOP_OpenCLMergeVDB(OP_Network* net, const char* name, OP_Operator* entry);
    ~DOP_OpenCLMergeVDB() override;

    static OP_Node* myConstructor(OP_Network* net, const char* name,
                                  OP_Operator* entry);
    static PRM_Template myTemplateList[];
    static PRM_Template myObsoleteList[];

    bool updateParmsFlags() override;

protected:
    void doApplyOutputDataSubclass(fpreal time, int outputidx,
                                   SIM_RootData& rootdata,
                                   const char* parentdataname,
                                   DOP_Engine& engine,
                                   UT_StringArray* datanames,
                                   bool active) override;
    void getInputInfoSubclass(int inputidx, DOP_InOutInfo& info) const override;
};

#endif