VOP_SubnetOutput.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:        VOP Library (C++)
 *
 */

#ifndef __VOP_SubnetOutput_h__
#define __VOP_SubnetOutput_h__

#include "VOP_API.h"
#include <UT/UT_StringArray.h>
#include "VOP_Node.h"

class VOP_API VOP_SubnetOutput : public VOP_Node, public VOP_OutputNameEditorSource
{
public:
    static OP_Node              *myConstructor(OP_Network *net,
                                               const char *name,
                                               OP_Operator *entry);
    static PRM_Template          myTemplateList[];

    void                         getCode(UT_String &codestr,
                                         const VOP_CodeGenContext &context
                                         ) override;

    const char                  *inputLabel(OP_InputIdx idx) const override;

    unsigned                     getNumVisibleInputs() const override;

    bool                         forceCodeGenerationOfInputs(
                                        const VOP_CodeGenContext &context,
                                        bool check_shader_context
                                        ) const override;

    // For suboutput VOPs, moving an input means we should also rewire the
    // outputs from our containing subnet. We also watch for setInput calls
    // to rearrange our parent's outputs when inputs are connected or
    // disconnected from us.
    void                         moveInput(int srcidx, int dstidx,
                                           bool forcesubnet = false) override;
    // Do not call this method yourself. It performs the core work
    // necessary to move inputs on this subnet output node, but does not
    // fully account for the synchonizing it with the rest of the
    // nodes.
    void                         moveInputInternal(int srcidx, int dstidx, 
                                           bool forcesubnet);
    OP_ERROR                     setInput(OP_InputIdx idx, OP_Node *op,
                                          OP_OutputIdx outputIdx = 0) override;
    OP_ERROR                     setInputReference(
                                        OP_InputIdx idx,
                                        const char *label,
                                        int keeppos,
                                        OP_OutputIdx outputIdx = 0) override;

    OP_ERROR                     setNamedInput(
                                        const OP_ConnectorId &input_name,
                                        OP_Node *op,
                                        const OP_ConnectorId *output_name = NULL
                                        ) override;
    OP_ERROR                     setNamedInputReference(
                                        const OP_ConnectorId &input_name,
                                        const char *label,
                                        int,
                                        const OP_ConnectorId *output_name = NULL
                                        ) override;

    // Returns a pointer used by OPUI_OutputNameEditor to get and set data.
    VOP_OutputNameEditorSource          *getOutputNameEditorSource() override
                                 { return this; }

    // Provide access to the output name and label parameter functions so
    // the OPUI_OutputNameEditor can deal with them appropriately.
    int                          getNumInputsFromParent() const override;
    void                         NAMEFROMPARM(
                                        UT_String &str, int idx) const override;
    void                         LABELFROMPARM(
                                        UT_String &str, int idx) const override;
    void                         setNAMEFROMPARM(
                                        UT_String &str, int idx) override;
    void                         setLABELFROMPARM(
                                        UT_String &str, int idx) override;

    void                         beginWiring();
    void                         endWiring();
    void                         clearCachedInputNames();

protected:
    VOP_SubnetOutput(OP_Network *parent, const char *name, OP_Operator *entry);
    ~VOP_SubnetOutput() override;

    void                 preOpChanged(
                                OP_EventType reason, void *data) override;

    void                 getInputNameSubclass(
                                UT_String &in, int idx) const override;
    int                  getInputFromNameSubclass(
                                const UT_String &in) const override;
    void                 getInputTypeInfoSubclass(
                                VOP_TypeInfo &type_info, int idx) override;
    void                 getAllowedInputTypeInfosSubclass(
                                unsigned idx,
                                VOP_VopTypeInfoArray &voptypes) override;

private:
    void                 adjustParentForInputChange(int idx, bool inputnull);
    void                 getInternalInputName(UT_String &in, int idx) const;
    void                 findSafeBase(UT_String &in) const;
    int                  mapToParentInputIndex(int index) const;
    void                 swapNames(int srcidx, int dstidx);
    void                 adjustOutputParmsForInputChange(int idx,
                                bool inputnull);

    UT_StringArray       myInputNames;
    int                  myWiringDepth;
};

#endif