VOP_Null.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_Null_h__
#define __VOP_Null_h__

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

class VOP_API VOP_Null : public VOP_Node
{
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;
    const char                  *outputLabel(OP_OutputIdx idx) const override;

    unsigned                     getNumVisibleInputs() const override;
    unsigned                     getNumVisibleOutputs() const override;
    unsigned                     orderedInputs() const override;

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


    void                         moveInput(int srcidx, int dstidx,
                                           bool forcesubnet = false) override;

    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 = nullptr
                                ) override;
    OP_ERROR             setNamedInputReference(
                                const OP_ConnectorId&  input_name, 
                                const char *label,
                                int,
                                const OP_ConnectorId* output_name = nullptr
                                ) override;


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

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

    void                 postOpChanged(
                                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                 getOutputNameSubclass(
                                UT_String &out, int idx) const override;
    void                 getOutputTypeInfoSubclass(
                                VOP_TypeInfo &type_info, 
                                int idx) override;
    UT_IntArray          getShaderLayerExportsInputsToCopy(
                                int out_idx,
                                VOP_Type shader_type) override;
    UT_StringHolder      getShaderLayerExportsToAdd(
                                int out_idx,
                                VOP_Type shader_type) override;

    void                 adjustOutputParmsForInputChange(int idx,
                                            bool inputnull);
    void                 adjustOutputParmsForNamedInputChange(
                                            const OP_ConnectorId& input_name,
                                            bool inputnull);
    void                 swapInputs(int srcidx, int dstidx);

    void                 getTentativeOutputName(
                                UT_String &out, int idx) const override;

    virtual int          NUMPARMS() const;
    virtual void         OUTPUTNAME(UT_String &str, int idx, bool expand) const;
    virtual CH_StringMeaning     OUTPUTNAMEmeaning(int idx) const;
    virtual void         setOutputParm(UT_String &str, CH_StringMeaning meaning,
                                       int idx);
    virtual void         OUTPUTLABEL(UT_String &str, int idx) const;

private:

    bool                 mySearchingForInputs;
};

#endif