VOP_Constant.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_Constant_h__
#define __VOP_Constant_h__

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

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

    static PRM_Template         *getObsolete(const VOP_Language *language);

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

    const char                  *outputLabel(unsigned idx) const override;

    const char *                 getConstantValueParmName();
    
    void                         setPARMNAME(const UT_String &str);
    void                         setPARMLABEL(const UT_String &str);
    void                         setPARMTYPEINDEX(int idx);
    void                         setPARMSTORAGE(int type);

    int                          PARMTYPEINDEX();

    /// Constant VOP can represent a value of an attribute on a USD shader 
    /// or material primitive. So it can be translated directly to it.
    bool                         translatesDirectlyToUSD() const override
                                    { return true; }

protected:
    VOP_Constant(OP_Network *net, const char *name, OP_Operator *entry);
    ~VOP_Constant() override;

    bool                 updateParmsFlags() override;
    void                 getDescriptiveName(UT_String &name) const override;
    
    void                 getOutputNameSubclass(
                                UT_String &out, int idx) const override;
    void                 getOutputTypeInfoSubclass(
                                VOP_TypeInfo &type_info, int idx) override;

private:
    VOP_Type     getUniformType(int pidx, bool conditioned,
                                const VOP_Language *language=0);

    void        PARMNAME(UT_String &str);
    void        PARMLABEL(UT_String &str);
    int         UNIFORM();
};

#endif