VOP/VOP_ScriptOperator.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.
 *
 * Produced by:
 *      Mark Elendt
 *      Side Effects Software Inc
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        VOP_ScriptOperator.h ( VOP Library, C++)
 *
 * COMMENTS:    OP_Operator for VOP classes.
 */

#ifndef __VOP_ScriptOperator__
#define __VOP_ScriptOperator__

#include "VOP_API.h"
#include <UT/UT_String.h>
#include <UT/UT_RefArray.h>
#include <PI/PI_ScriptOperator.h>
#include "VOP_OperatorInfo.h"

#define DEFAULT_INPUTSET_NAME    "default"
#define DEFAULT_INPUTSET_LABEL   "Default Inputs"

class VOP_Language;

class VOP_API VOP_ScriptOperator : public PI_ScriptOperator
{
public:
    VOP_ScriptOperator(const char       *path,
                        const char      *name,
                        const char      *label,
                        int minInputs, int maxInputs,
                        const char      *vopnetMask,
                        OP_Constructor   construct,
                        PRM_Template    *multiInputSetTemplates);
    virtual ~VOP_ScriptOperator();

    static OP_ScriptOperator    *createScriptOperator(const OP_OTLDefinition &);

    virtual OP_SpecificData             *getOpSpecificData()
                                         { return &myOperatorInfo; }
    virtual const OP_SpecificData       *getOpSpecificData() const
                                         { return &myOperatorInfo; }

    virtual int                  updateParmTemplates();
    virtual unsigned             maxOutputs();
    const UT_String             &getOutputName(int idx);
    const UT_String             &getOutputLabel(int idx);
    VOP_Type                     getOutputType(int idx, int inputset);

    const UT_String             &getInputName(int idx);
    const UT_String             &getInputLabel(int idx);
    VOP_Type                     getInputType(int idx, int inputset);
    bool                         getIsInputVisible(int idx); 

    bool                         forceCodeGenerationOfInputs(
                                                VOP_ContextType type,
                                                bool essential) const;

    const UT_String             &getOuterCode() const;
    const UT_String             &getCode() const;

    virtual bool                 wantsParametersAnimatable() const;
    virtual bool                 wantsInputEditor() const;

    int                          getNumInputSets() const;
    const char                  *getInputSetName(int index) const;
    const char                  *getInputSetLabel(int index) const;

    virtual const PRM_Template  *getBaseParmTemplates();

    void getAllowedInputTypes(unsigned idx, VOP_VopTypeArray &voptypes);

protected:
    virtual const char          *getAddedDSIncludePath();
    virtual int                  handleUnknownToken(DS_Stream &ds,
                                            UT_String &token);
    bool                         addOutput(const UT_String &outtype,
                                           const UT_String &name,
                                           const UT_String &label);
    bool                         addInput(const UT_String &intype,
                                          const UT_String &name,
                                          const UT_String &label);
    virtual PRM_Template        *loadParmTemplates(UT_IStream &is,
                                            const char *filename,
                                            UT_String &scriptName,
                                            PRM_ScriptImports *&imports);

private:
    // Just a convenience function that does something we need to do a lot.
    // It checks if our .ds file is loaded yet, and loads it if required.
    void                         ensureParmsAreLoaded();

    VOP_OperatorInfo             myOperatorInfo;
    PRM_Template                *myMultiInputSetBase;
    VOP_Language                *myLanguage;
    bool                         myIsSubnet;
};

#endif

---