VOP_OutputVar.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_OutputVar_h__
#define __VOP_OutputVar_h__

#include "VOP_API.h"
#include "VOP_Node.h"

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

    void                         initializeNode() override;
    void                         initMaterialFlag() override;

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

    const VOP_OutputVar         *castToOutputVar() const override
                                    { return this; }
    VOP_OutputVar               *castToOutputVar() override { return this; }

    void                         ensureParametersAreValid() override;

    const char                  *inputLabel(unsigned idx) const override;

    unsigned                     maxInputs() const override;

    bool                         forceCodeGenerationOfInputs(
                                        const VOP_CodeGenContext &context,
                                        bool check_shader_context
                                        ) const override;
    void                         getContextsForCodeGeneration(
                                        UT_StringArray & context_names
                                        ) const override;

    void                         setOUTPUTCODELAST(bool flag);
    bool                         OUTPUTCODELAST();

    /// Gets the concrete context type this node belongs to.
    VOP_ContextType              getSpecificShaderContextType() const override;

    /// Obtains the list of global variables that make up the inputs.
    const VOP_GlobalVarList     &getGlobalVarList() const
                                 { return myGlobalVarList; }

    VOP_Node *                   findSimpleInputFromOutput(
                                        int output_index) override;
    void                         findSimpleInputCandidatesFromOutput( 
                                        int output_index,
                                        UT_IntArray & input_indices) override;

    bool                 isVopMethod() const override;
    bool                 isVopMethodPublic() const override;
    void                 getVopFunctionName(
                                UT_String &function_name) const override;
    void                 getVopFunctionReturnInfo(
                                VOP_FunctionArgInfo &i) const override;
    void                 getVopFunctionArgInfos(
                                UT_Array<VOP_FunctionArgInfo> &arg_infos
                                ) override;

    /// Sets the node to use the given shader context type.
    void                 setSHADERTYPE(VOP_Type shader_type);

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

    bool                 updateParmsFlags() 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                 getAllowedInputTypesSubclass(
                                unsigned idx, 
                                VOP_VopTypeArray &voptypes) override;
    void                 refreshGlobalVariables();

    unsigned             getNumVisibleOutputs() const override;
    void                 getOutputNameSubclass(
                                UT_String &out, int idx) const override;
    void                 getOutputTypeInfoSubclass(
                                VOP_TypeInfo &type_info, int idx) override;

private:
    void                 loadFinished() override;
    int                  getLatestVopVersion() const override;
    bool                 usingShaderType() const;
    VOP_ContextType      SHADERCONTEXTTYPE() const;
    VOP_Type             SHADERTYPE() const;

    VOP_GlobalVarList            myGlobalVarList;
    VOP_ContextType              myShaderContextType;
    VOP_Type                     myShaderType;
    bool                         myIsSearchingForInputs;
};

#endif