VOP_Parameter.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_Parameter_h__
#define __VOP_Parameter_h__

#include "VOP_API.h"
#include "VOP_ParameterBase.h"
#include <CH/CH_ExprLanguage.h>

class PI_EditScriptedParm;

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

    void                         initializeNode() override;

    // Get the parm block information that will go in the dialog script
    // for our VOPNET.
    void                         getParameterDeclaration(
                                        UT_String &parmdecl,
                                        const VOP_Language *language,
                                        const VOP_CodeGenContext &context
                                        ) override;
    void                         getParameterComment(
                                        UT_String &parm_comment,
                                        const VOP_Language *language,
                                        const VOP_CodeGenContext &context
                                        ) override;
    void                         getParameterBlock(
                                        UT_String &parmstr,
                                        const char *shader_contexts) override;
    // Get the pragmas that define the UI for the parameter.
    void                         getPragmas(
                                        UT_String &pragmastr,
                                        const VOP_CodeGenContext &context
                                        ) override;

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

    const char                  *inputLabel(unsigned idx) 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 &type_name) override;
    void        setPARMSCOPE(const char *scope) override;
    void        setPARMSTORAGE(int type) override;
    void        setPARMSTRINGTYPE(const char *style);
    void        setPARMOPFILTER(const char *filter);

    void                         PARMSCOPE(UT_String &str) const override;
    void                         PARMACCESS(UT_String &str) const override;
    void                         PARMNAME(UT_String &str) const override;
    void                         PARMPREFIX(UT_String &str) const override;
    void                         PARMPOSTFIX(UT_String &str) const override;
    void                         PARMLABEL(UT_String &str) const override;
    void                         PARMCOMMENT(UT_String &str) const override;
    int                          PARMTYPEINDEX() const override;
    void                         PARMTYPENAME(
                                        UT_String &type_name) const override;
    void                         PARMMENUOPTION(
                                        UT_String &menu_option) const override;

    void                         TAGS(UT_JSONValueMap &map) const;
    void                         setTAGS(UT_StringMap<UT_StringHolder> &tags);

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

    /// Parameter VOP represents USD inputs and output. It can be translated 
    /// directly to an input/output attribute of a USD material primitive.
    bool                         translatesDirectlyToUSD() const override
                                    { return true; }

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

    bool                         updateParmsFlags() override;
    
    // Override cook method just so we can set our warnings properly.
    bool                         USEASPARMDEFINER() const override;
    bool                         USEOWNEXPORTCONTEXT() const override;
    bool                         SHOULDHAVECORRESPONDINGCONNECTOR(
                                        ) const override;
    int                          UNIFORM() const override;
    int                          USEBOUND() const override;
    int                          EXPORTPARM() const override;
    void                         EXPORTSHADERCONTEXTS(
                                        UT_StringArray &context_names
                                        ) const override;
    using VOP_ParameterBase::EXPORTSHADERCONTEXTS;
    void                         MENUCHOICES(UT_String &str) const override;
    void                         MENUSCRIPT(UT_String &str) const override;
    CH_ScriptLanguage            MENUSCRIPTLANGUAGE() const override;
    void                         CALLBACKSTR(UT_String &str) const;
    void                         HELPTEXTSTR(UT_String &str) const;
    int                          INVISIBLE() const;
    int                          JOINNEXT() const;
    int                          SHOWLABEL() const;
    int                          IRANGE(int index) const;
    float                        FRANGE(int index) const;

    bool                         needsInput() override;

    // True if the node defines a node parameter UI (eg, on a SHOP); 
    // otherwise, returns false (eg, if this parm node refers to a method arg).
    bool                         definesParmUI() const;

    // Build the code to be output when useBound() is true but the parameter
    // is not actually bound:
    void                         getUnboundCode(
                                        UT_String &codestr,
                                        const VOP_CodeGenContext &context
                                        ) override;

    void                         getParmDeclarationCode(
                                        UT_String &parm_decl,
                                        const VOP_CodeGenContext &codegen_ctx,
                                        const VOP_Language *language = nullptr,
                                        bool export_parms = false) 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;
    bool                         shouldCheckTimeDependence() const override;

private:
    bool                         allowMenu(int parmtype) const;

    // Store the indices of the parameters that can affect the cached parameter
    // name.
    static int                   theParmNameParmIndex;
    static int                   theParmPrefixParmIndex;
    static int                   theParmPostfixParmIndex;
    static int                   theParmTypeParmIndex;
};

#endif