OP_GraphProxyDirect.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_GraphProxyDirect.h (OP Library, C++)
 *
 * COMMENTS:
 *      An implementation of a graph proxy, to be subclassed and
 *  further implemented depending on the node class. This is
 *  a direct graph proxy meaning that it deals with nodes.
 */

#include "OP_GraphProxy.h"
#include <DEP/DEP_TimedMicroNode.h>

//
// Graph Proxy Direct, this ties directly to the normal OP_Director
// node network
//

// Implements everything except for getLockedGeometry, isPaired, getSpareInput
// and all the is<NodeType>
// because there are no real default cases that make sense for them,
// as each separate OP would likely have its own version of these functions

class OP_API OP_GraphProxyDirect : public OP_GraphProxy
{
public:
    using OP_GraphProxy::NodeIdx;

    OP_GraphProxyDirect() {}
    ~OP_GraphProxyDirect() override {}

    bool                 isDirect() const override { return true; }
    OP_Node             *idxToNode(NodeIdx idx) const override;

    NodeIdx              nodeToIdx(const OP_Node *node) const override;
    UT_StringHolder      getFullPath(NodeIdx idx) const override; 
    UT_StringHolder      getType(NodeIdx idx) const override;
    
    // Micronode accessors
    DEP_MicroNode       *getEventMicroNode(NodeIdx idx, OP_EventType e) const override;
    DEP_MicroNode       *getFlagMicroNode(NodeIdx idx) const override;

    bool                 validate(NodeIdx idx) const override;
    const SOP_NodeVerb  *cookVerb(NodeIdx idx) const override;

    // COP specific accessors
    // Gets the type of the ports for the cop node
    // defaults to returning COP_Type::COP_TYPE_UNDEF and nullptr
    int                  getCOPSignatureCount(NodeIdx idx) const override;
    int                  getCOPInputCableSize(NodeIdx idx, OP_InputIdx input) const override;
    int                  getCOPOutputCableSize(NodeIdx idx, OP_OutputIdx output) const override;
    int                  getCOPNodeInputType(NodeIdx idx, OP_InputIdx input_port_idx, int sig_idx) const override;
    int                  getCOPNodeOutputType(NodeIdx idx, OP_OutputIdx output_port_idx, int sig_idx) const override;
    bool                 isCOPOutputNull(NodeIdx idx, OP_OutputIdx output_port_idx, int sig_idx) const override;
    DEP_MicroNode       *getCOPSignatureMicroNode(NodeIdx idx) const override;
    const COP_Verb      *getCOPVerb(NodeIdx idx) const override;
    int                  getCOPNumInputs(NodeIdx idx) const override;
    int                  getCOPNumOutputs(NodeIdx idx) const override;
    bool                 getCOPAlwaysBypass(NodeIdx idx) const override;
    void                 getCOPInputName(NodeIdx idx, UT_String& name, OP_InputIdx input_idx) const override;
    NodeIdx              getCOPSubNetOutputNode(NodeIdx idx) const override;
    bool                 addCOPSignatureError(NodeIdx idx, UT_ErrorManager& error) const override;
    COP_NodeOutputPort   getCOPBypassPort(NodeIdx idx, UT_ErrorManager& error, DEP_MicroNode* dep, OP_OutputIdx port_index, int sig_index) const override;
    COP_NodeOutputPort   getCOPOutputPortFromInput(NodeIdx idx, OP_InputIdx input, int sig_index, bool markused) const override;

    // Flags
    bool                 getBypass(NodeIdx idx) const override;
    bool                 getHardLock(NodeIdx idx) const override;
    bool                 getUnload(NodeIdx idx) const override;
    
    // Topology
    int                  nInputs(NodeIdx idx) const override;
    int                  minInputs(NodeIdx idx) const override;
    NodeIdx              getInput(NodeIdx idx, OP_InputIdx input, bool markused) const override;
    NodeIdx              getInputFollowingOutputs(NodeIdx idx, OP_InputIdx input, DEP_MicroNode *depnode=0) const override;
    NodeIdx              getOutputSop(NodeIdx idx, OP_OutputIdx output) const override;
    NodeIdx              findNode(const UT_StringRef &path) const override;
    NodeIdx              findRelativeNode(NodeIdx cwd, const UT_StringRef &path) const override;
    NodeIdx              getSOPNode(NodeIdx idx, const UT_StringRef &path, bool addref=true) const override;

    OP_OutputIdx         whichOutputIsFollowingIndirect(NodeIdx idx, NodeIdx targetidx, OP_InputIdx input_on_target) const override;
    int                  numSpareInputs(NodeIdx idx) const override;

    NodeIdx              getParentNode(NodeIdx idx) const override;
    void                 getPathWithSubnet(NodeIdx idx, UT_String &str) const override;

    bool                 hasSpareInput(NodeIdx idx, int input, fpreal t, DEP_MicroNode *depnode) const override;
    int                  getParmOverrideInput(NodeIdx idx, fpreal time, DEP_MicroNode *depnode) const override;

    NodeIdx              getTemplateSOP(NodeIdx idx, fpreal t) const override;
    NodeIdx              getFeedbackSOP(NodeIdx idx, fpreal t) const override;

    bool                 hasParm(NodeIdx noderef, const char *parmname) const override;

#define CREATE_EVALOP(TYPE) \
    void                 evalOpParm( \
        TYPE &v, NodeIdx noderef, const char *parmname, fpreal time, \
        DEP_MicroNode *depnode) const override; \
    void                 evalOpParmInst( \
        TYPE &v, NodeIdx noderef, const char *parmname,  \
        const int *inst, const int * /*offsets*/, fpreal time, \
        DEP_MicroNode *depnode, int nestlevel) const override; \
/**/
    CREATE_EVALOP(int64);
    CREATE_EVALOP(bool);
    CREATE_EVALOP(fpreal64);
    CREATE_EVALOP(UT_Vector2D);
    CREATE_EVALOP(UT_Vector3D);
    CREATE_EVALOP(UT_Vector4D);
    CREATE_EVALOP(UT_Vector2I);
    CREATE_EVALOP(UT_Vector3I);
    CREATE_EVALOP(UT_Vector4I);
    CREATE_EVALOP(UT_Matrix2D);
    CREATE_EVALOP(UT_Matrix3D);
    CREATE_EVALOP(UT_Matrix4D);
    CREATE_EVALOP(UT_StringHolder);
    CREATE_EVALOP(UT_SharedPtr<UT_Ramp>);
    CREATE_EVALOP(PRM_DataItemHandle);
#undef CREATE_EVALOP

    void                 evalOpParmRaw(
        UT_StringHolder &v, NodeIdx noderef, const char *parmname, fpreal time, 
        DEP_MicroNode *depnode) const override;
};