VOP_GenericShader.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++)
 *
 * COMMENTS:
 */

#ifndef __VOP_GenericShader__
#define __VOP_GenericShader__

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

class VOP_API VOP_GenericShader : public VOP_Node
{
public:
    /// Operator factory.
    static OP_Operator          *createOperator();

    void                        SHADERNAME( UT_String &name ) const;
    void                        setSHADERNAME( const char *name ); 

protected:
    /// @{ Standard constructor and destructor for vop nodes.
    static OP_Node              *myConstructor(OP_Network *net,
                                               const char *name,
                                               OP_Operator *entry);
    VOP_GenericShader(OP_Network *parent, const char *nm, OP_Operator *op);
    ~VOP_GenericShader() override;
    /// @}
   

    /// @{ Virtuals related to shader nodes.
    bool                         isShader() const override;
    bool                         isShader(VOP_Type shader_type) const override;
    const PRM_Template *         getShaderParmTemplates() override;
    UT_StringHolder              getShaderName(
                                        VOP_ShaderNameStyle style, 
                                        VOP_Type shader_type) const override;
    void                         getVopFunctionName(
                                        UT_String &function_name
                                        ) const override;
    void                         opChanged(
                                        OP_EventType t, void *data=0) override;
    bool                         updateParmsFlags() override;
    /// @}

    /// @{ Standard vop virtuals for inputs.
    unsigned            getNumVisibleInputs() const override;
    unsigned            orderedInputs() 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;
    /// @}
   
    /// @{ Standard vop virtuals for outputs.
    unsigned            getNumVisibleOutputs() const override;
    void                getOutputNameSubclass(
                                UT_String &out, int idx) const override;
    void                getOutputTypeInfoSubclass(
                                VOP_TypeInfo &type_info, int idx) override;
    /// @}

    /// @{ Other vop virtuals
    void                getCode(UT_String &codestr,
                                const VOP_CodeGenContext &context) override;
    /// @}

private:
    // Info about inputs and outputs.
    class InOutData;
    const InOutData *   getInOutData() const;

private:
    // Info about inputs and outputs.
    mutable UT_UniquePtr<InOutData>     myInOutData;
};

#endif