VOP_Operator.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_Operator.h ( VOP Library, C++)
 *
 * COMMENTS:    Special class which has additional knowledge about the operator
 *              being described.
 */

#ifndef __VOP_Operator__
#define __VOP_Operator__

#include "VOP_API.h"
#include <OP/OP_Operator.h>
#include "VOP_OperatorInfo.h"

class VOP_API VOP_Operator : public OP_Operator {
public:
    VOP_Operator(const char        *name,
                  const char       *english,
                  OP_Constructor    construct,
                  PRM_Template     *templates,
                  const char       *child_table_name,
                  unsigned          min_sources,
                  unsigned          max_sources,
                  const char       *vopnetMask,
                  CH_LocalVariable *variables = 0,
                  unsigned          flags = 0,
                  unsigned          num_outputs = 1);

    ~VOP_Operator() override;

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

    unsigned             maxOutputs() override;

    bool                 wantsInputEditor() const override;
    bool                 wantsParmOrderEditor() const override;
    bool                 wantsOutputNameEditor() const override;
    bool                 wantsParentInputs() const override;

    /// Returns VOP operator for the given shader name.
    /// Shader name is a generic identifier or opdef path, and the returned
    /// operator that shader as a VOP (or nullptr if no such op was found).
    static OP_Operator * getShaderOperator( const UT_StringRef &shader_id );

private:
    VOP_OperatorInfo     myOperatorInfo;
    unsigned             myNumOutputs;
};

#endif