SIM_SopDependencyScope.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.
*/

#ifndef __SIM_SopDependencyScope_h__
#define __SIM_SopDependencyScope_h__

#include "SIMZ_API.h"

#include <DEP/DEP_MicroNode.h>
#include <SIM/SIM_Data.h>
#include <SIM/SIM_Engine.h>
#include <SOP/SOP_Node.h>
#include <UT/UT_Optional.h>
#include <UT/UT_NonCopyable.h>

/// Wrapper around a DEP_KeepDependenciesScope for use when cooking a SOP.
/// If the SOP has previously been accessed during the simulation
/// (SIM_Engine::hasOPInterest()), a DEP_KeepDependenciesScope is used to
/// accumulate the dependencies from earlier simulation frames
/// This is not done for the first occurrence after a resim, allowing the SOP's
/// micronode to reset and rebuild its dependencies.
class SIMZ_API SIM_SopDependencyScope : UT_NonCopyable
{
public:
    SIM_SopDependencyScope(const SIM_Data &data, const char *path)
    {
        mySop = data.getNodePathsRelativeTo().getSOPNode(path);
        if (mySop)
        {
            const SIM_Engine &engine = data.getEngine();

            if (engine.hasOPInterest(mySop))
                myDepScope.emplace();

            engine.addOPInterest(mySop);
        }
    }

    SOP_Node *getSOPNode() const { return mySop; }

private:
    UT_Optional<DEP_KeepDependenciesScope> myDepScope;
    SOP_Node *mySop = nullptr;
};

#endif