VOP_SubnetConnector.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_SubnetConnector_h__
#define __VOP_SubnetConnector_h__

#include "VOP_API.h"
#include "VOP_ParameterBase.h"

class PI_EditScriptedParm;

class VOP_API VOP_SubnetConnector : public VOP_ParameterBase
{
public:
    static OP_Node              *myConstructor(OP_Network *net,
                                               const char *name,
                                               OP_Operator *entry);
    static PRM_Template         *buildTemplates(const VOP_Language *language);

    bool                         getParmConstantString(
                                        const char *parmname,
                                        const VOP_TypeInfo &type_info,
                                        UT_String &str,
                                        bool expand_string,
                                        const VOP_Language *language = nullptr
                                        ) override;

    void                         getInputNameSubclass(
                                        UT_String &in, int idx) const override;
    int                          getInputFromNameSubclass(
                                        const UT_String &in) const override;
    const char                  *inputLabel(OP_InputIdx idx) const override;
    bool                         forceCodeGenerationOfInputs(
                                        const VOP_CodeGenContext &ctx, 
                                        bool check_shader_context
                                        ) const override;

    void                         setPARMNAME(const UT_String &str) override;
    void                         setPARMLABEL(const UT_String &str);
    void                         setPARMTYPEINDEX(int type) override;
    void                         setPARMTYPENAME(const UT_StringRef &n)override;
    void                         setPARMSTORAGE(int type) override;
    void                         setPARMSTRINGTYPE(const char *style);

    void                         PARMSCOPE(UT_String &str) const override;
    void                         PARMNAME(UT_String &str) const override;
    void                         PARMLABEL(UT_String &str) const override;
    int                          PARMTYPEINDEX() const override;
    void                         PARMTYPENAME(UT_String &str) const override;

    bool                         isParmVisible() const override;
    void                         copySettingsFrom(
                                        VOP_ParmGenerator *pvop) override;

    bool                         isOutputConnector() const;

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

    void                        preOpChanged(
                                    OP_EventType reason, void *data) override;
    bool                         updateParmsFlags() override;
    
    // Override cook method just so we can set our warnings properly.
    bool                         USEASPARMDEFINER() const override;
    int                          UNIFORM() const override;
    int                          EXPORTPARM() const override;

    bool                         needsInput() override;

    // Determines based on the parm index if the PARMNAME may be changed
    // when this parm is changed.
    bool                         getParmCanAffectParmName(
                                        int pidx) const override;

    void                         getInputTypeInfoSubclass(
                                        VOP_TypeInfo &type_info,
                                        int idx) override;
    void                         getAllowedInputTypesSubclass(
                                        unsigned idx,
                                        VOP_VopTypeArray &voptypes) override;

private:
    // Store the index of the Bind Name and Parameter Type parameters.
    static int                   theParmNameParmIndex;
    static int                   theParmTypeParmIndex;
};

#endif