VOP_Collect.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_Collect_h__
#define __VOP_Collect_h__

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

class UT_StringRef;

class VOP_API VOP_Collect : public VOP_Node, VOP_OutputNameEditorSource
{
protected:
    VOP_Collect(OP_Network *parent, const char *name, OP_Operator *entry);
    ~VOP_Collect() override;

public:
    static OP_Operator          *createOperator();
    static OP_Node              *myConstructor(OP_Network *net,
                                               const char *name,
                                               OP_Operator *entry);
    static PRM_Template          myTemplateList[];

    /// Get nodes that effectively are fed into the collect node. These
    /// include regular (eg, output) nodes, but also regular nodes indirectly
    /// connected through a chain of nulls and switches.
    void        getCollectedNodes(VOP_NodeList &outputs);

    /// Get the types of shaders wired into this collect node.
    void        getCollectedShaderTypes(VOP_ShaderTypeList &types) const;

    /// Get input names specified in the multi-parm. May contain empties.
    void        getCollectedInputNames(UT_StringArray &names) const;
    
    /// Collect VOP is virtually equivalent to a vo material.
    VOP_Type             getShaderType() const override;

    unsigned             getNumVisibleInputs() const override;

protected:
    /// Inherited from VOP_Node.
    void                 initMaterialFlag() override;
    void                 loadFinished() override;

    /// @{ Virtuals for VOP node inputs.
    const char          *inputLabel(unsigned idx) const 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;
    /// @}

    /// @{ Intercepting input manipulation to notify the parent.
    void                 moveInput(int srcidx, int dstidx, 
                                bool forcesubnet = false) override;
    OP_ERROR             setInput(unsigned idx, OP_Node *op,
                                unsigned outputIdx = 0) override;
    OP_ERROR             setInputReference(unsigned idx, const char *label,
                                int keeppos, unsigned outputIdx = 0) override;
    OP_ERROR             setNamedInput(const OP_ConnectorId& input_id,
                                OP_Node *op, 
                                const OP_ConnectorId* output_name = nullptr
                                ) override;
    OP_ERROR             setNamedInputReference(const OP_ConnectorId& input_id, 
                                const char *label, int keeppos, 
                                const OP_ConnectorId* output_name = nullptr
                                ) override;
    /// @}

    /// @{ In case the collect VOP is assigned as a material.
    VOP_Node            *findShader(VOP_Type shader_type, fpreal now) override;
    void                 findAllShaders( VOP_NodeList &shader_nodes,
                                        VOP_ShaderTypeList &shader_types,
                                        UT_StringArray &output_names) override;
    bool                 isUSDNodeGraph() const override;
    VOP_Node            *getProcedural(VOP_Type type) override;
    bool                 getParameterOrProperty(
                                    const UT_StringRef &name, fpreal now,
                                    OP_Node *&op, PRM_Parm *&parm,
                                    bool create_missing_multiparms,
                                    PRM_ParmList *obsolete = 0) override;
    bool                 getParameterOrPropertyByChannel(
                                    const UT_StringRef &chname,
                                    fpreal now, OP_Node *&op, PRM_Parm *&parm,
                                    int &vector_index,
                                    PRM_ParmList *obsolete = 0) override;
    /// @}

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

    // 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;

    // Virtuals for managing the input multiparm
    void                 preOpChanged(OP_EventType reason, void *) override;
    void                 postOpChanged(OP_EventType reason,
                                       void *data) override;

    // Utility members.
    int                  NUMINPUTS() const;
    void                 INPUTNAME(UT_String &name, int idx) const;
    void                 setINPUTNAME(const char *name, int idx, 
                                bool make_unique = true);
    bool                 hasINPUTNAME(const char *name, int skip_idx);
    void                 INPUTLABEL(UT_String &label, int idx) const;
    void                 setINPUTLABEL(const char *label, int idx);

private:
    void                 notifyParentOfInputChange();
    void                 adjustForInputChange(int idx, 
                                bool is_new, bool is_deleted);
    void                 adjustForInputMove(int srcidx, int dstidx );
    void                 moveInputNameParm(int srcidx, int dstidx);
    void                 removeInputNameParm(int idx);
};

#endif