OP_DopParent.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:        OP_DopParent.h ( SIM Library, C++)
 *
 * COMMENTS:
 *      This provides a bridge up to DOP_Parent for methods interested
 *      in the simulation status but live below SIM.
 *      Note that these are NOT necessarily DOP_Parents!  This is used
 *      by any DOP_Parent-like cache node.
 *
 *      NOTE: Creating/destryoing these is NOT threadsafe as they
 *            have global registry :<
 */

#ifndef __OP_DopParent__
#define __OP_DopParent__

#include "OP_API.h"
#include "OP_DataTypes.h"
#include <SYS/SYS_Types.h>
#include <UT/UT_VectorTypes.h>
#include <DEP/DEP_MicroNode.h>

class OP_Node;
template <typename T> class UT_Array;

class OP_DopParent;
typedef UT_ValArray<OP_DopParent *>              DOP_ParentList;


class OP_API OP_DopParentMicroNode : public DEP_MicroNode
{
public:
                         OP_DopParentMicroNode(OP_Node *dopparentnode)
                             : myDopParentNode(dopparentnode)
                         { }

    const char          *className() const override
                         { return "OP_DopParentMicroNode"; }
    OP_Node             *getDopParentNode() const
                         { return myDopParentNode; }

private:
    OP_Node             *myDopParentNode;
};

class OP_API OP_DopParent
{
public:
    OP_DopParent();
    virtual ~OP_DopParent();

    /// This static function returns an array of all DOP_Parents.
    static const DOP_ParentList &getAllDopParents();

    /// This function moves a particular DOP_Parent to the front of the list
    /// of all DOP_Parents. This lets us treat this list as a "most recently
    /// used" stack.
    static void                  setMostRecentDopParent(OP_DopParent *dopparent);

    virtual bool opGetNeedsResimulation() const = 0;
    virtual bool opGetDisableSimulation() const = 0;
    static OP_Node *opGetMostRecentDopOwner();
    static OP_DopParent *opGetMostRecentDopParent();

    virtual OP_Node *opGetOwner() const = 0;

    virtual void     opResimulate() = 0;
    virtual void     opSendResimulateNotification(
                        bool callnotify, bool changingguideparm) = 0;

    /// Checks to see if the dop is in play mode
    virtual bool opIsPlayer() const = 0;
    virtual void opResetPlayer() = 0;

    /// Returns if the operator is in Continous Cook mode.
    virtual bool opIsContinuousCook() const = 0;
    /// Current continuous cook tick.
    virtual exint opContinuousCookTick() const = 0;

    /// Note this is in simulation frames, not global.
    virtual bool opIsSimFrameCached(exint simframe) const = 0;

    virtual void setNeedsToCompletelyReset() = 0;

    // Returns global frames, not simulation frames, rounded outwards.
    virtual void opGetDiskCache(UT_Array<int> &frames) const = 0;
    virtual void opGetMemoryCache(UT_Array<int> &frames) const = 0;

    // Returns a set of nodes that are "extra inputs" to the simulation,
    // through the simMicroNode.
    virtual void opGetSimExtraInputNodes(OP_NodeList &extras) const = 0;

    virtual fpreal opGetLatestCacheTime() const = 0;
};


#endif // __OP_DopParent__